Skip to main content

Oracle JDBC Connection Profile – New params for SSH tunnel

You are viewing Admin Console - Profiles documentation for Data Trust v7.6 (latest).
Looking for the previous version? View v2024.06 documentation →
Data Trust › Admin Console › Connection Explorer

Oracle JDBC Connection — SSH Tunnel Parameters

Create an Oracle JDBC connection profile that routes through an SSH tunnel using the new SSH Host, SSH Username, and SSH PEM File parameters.

Overview

Data Trust supports connecting to Oracle databases over an SSH tunnel. This is useful when the Oracle server is on a private network that is not directly accessible from the Data Trust server, but can be reached via an SSH jump host. Three new parameters have been added to the Oracle JDBC connection form: SSH Host, SSH Username, and SSH PEM File.

Prerequisites

  • You are logged in to Data Trust with an Admin Pro-User role.
  • You have an Oracle JDBC connection string, Oracle user credentials, and the SSH jump host details (hostname, username, and PEM key file path).
  • The SSH PEM key file is accessible to the Data Trust server process.

Creating an Oracle JDBC Connection with SSH Tunnel

Path: Data Trust › Admin Console › Connection Explorer › + New Connection

Connection Explorer listing page

Figure 1: Connection Explorer — click “+ New Connection” to begin creating an Oracle SSH tunnel profile.

Navigate to Admin Console › Connection Explorer. The listing shows all existing profiles. Click + New Connection to open the Create Connection form.

  1. Click + New Connection.

+ New Connection button on the Connection Explorer toolbar

Figure 2: Click “+ New Connection” to open the Create Connection form.

The + New Connection button is in the top-right of the Connection Explorer page.

  1. Enter a unique Connection Name.
  2. Select Oracle from the Source Name dropdown.

Create Connection page with Oracle selected as Source Name — Non JDBC type

Figure 3: Create Connection page with Oracle source selected and Non JDBC type — showing DATA SOURCE, USER ID, and PASSWORD fields.

When Oracle is selected as the Source Name, the initial Type of Connection defaults to Non JDBC, which shows fields: DATA SOURCE (TNS name or host:port/service), USER ID, and PASSWORD. For SSH tunnel support you need to switch to JDBC type.

  1. Change the Type Of Connection to JDBC.

Oracle Create Connection — JDBC type selected showing standard Oracle JDBC fields

Figure 4: Oracle JDBC connection fields — Connection String, User Name, Password, Driver Class, Default Enclosure Character, and the new SSH parameters.

Switching to JDBC reveals the standard JDBC fields (Connection String, User Name, Password, Driver Class, Default Enclosure Character) plus the new SSH tunnel parameters. The Oracle JDBC connection string format is: jdbc:oracle:thin:@//hostname:1521/service_name.

Connection Type dropdown showing JDBC selected for Oracle

Figure 5: Type Of Connection set to JDBC — this is required to access the SSH tunnel parameters for Oracle.

The Type Of Connection dropdown on the left panel must be set to JDBC to reveal the SSH tunnel fields. Non JDBC Oracle connections do not support SSH tunnelling.

  1. Fill in the standard JDBC fields: Connection String, User Name, Password, and Driver Class.
  2. To enable SSH tunnelling, locate the SSH checkbox and tick it.

SSH checkbox and greyed-out SSH fields before enabling

Figure 6: The SSH checkbox (unchecked) with SSH Host, SSH Username, and SSH PEM File fields visible but disabled.

Below the standard JDBC parameters, three SSH fields are shown in greyed-out state: SSH Host, SSH Username, and SSH PEM File. These fields are disabled until the SSH checkbox is ticked.

  1. Tick the SSH checkbox to enable the SSH tunnel fields.
  2. Fill in SSH Host (hostname or IP of the SSH jump server), SSH Username, and SSH PEM File (full path to the private key file on the Data Trust server).

SSH checkbox ticked — SSH Host, SSH Username, and SSH PEM File fields now enabled and editable

Figure 7: SSH tunnel enabled — SSH Host, SSH Username, and SSH PEM File fields are now active and ready for input.

Once the SSH checkbox is ticked, the three SSH fields become editable. Enter the SSH Host (e.g., bastion.company.com), the SSH Username (the Linux/Unix user on the jump host), and the SSH PEM File path (e.g., /opt/datatrust/keys/oracle-jump.pem). Data Trust will establish an SSH tunnel through this jump host before connecting to Oracle.

Note: The SSH PEM File path must be accessible to the Data Trust server process at runtime. Ensure the file has appropriate permissions (typically chmod 400).
  1. Click Test Connection to verify the end-to-end SSH + Oracle connection.
  2. Click Save to create the profile.
Tip: If the test fails, verify that the SSH jump host is reachable from the Data Trust server, the PEM key is valid, and the Oracle host is reachable from the jump host.

Related Articles

Was this article helpful?