Oracle Cloud Infrastructure Documentation

Manage connections

Learn connection management tasks including how to edit, unassign, move, and delete connections.

View connection details

Select a connection from the Connections list to view its details. On the Connection details page, you can perform actions on the connection such as, edit, refresh, move, add tags, and delete from the Actions menu, view the connection's status, which can be one of the following:

  • Creating
  • Updating
  • Active
  • Deleting
  • Deleted
  • Failed

You can also select a tab to view connection information, assigned deployments, network security groups, work requests and tags. Read on to learn what you can find under each of these tabs.

Connection information

Connection information displays:

  • The connection's OCID
  • The compartment in which the connection was created
  • When the connection was created and updated
  • Encryption key management
  • Network information
    • View and edit the connection's subnet
      Note

      If you change the subnet, the connection's Ingress IPs and Private IP also changes.
    • Traffic routing method, either Shared or Dedicated
    • The Ingress IP show one or more IP addresses. The connection endpoint for OCI GoldenGate originates from one of these IP addresses. You must ensure that the appropriate subnet security rules are in place to allow connectivity from these IP addresses to the database's private IP.
    • Private IPs get rewritten in the format, ip-xx-xx-xx-xx.ociggsvc.oracle.vcn.com.
  • Connection type and connectivity information specific to that type, including the password secret for Autonomous Database users

Assigned deployments

Connections must be assigned to deployments to use them as a source or target. Here, you can:

Network security groups

View, add, edit, or remove network security groups (NSGs) for connections with Dedicated endpoints
Note

Connections with Shared endpoints inherit NSG settings from the assigned deployment. Adding network security groups (NSGs) gives you fine grained control over traffic between a deployment and the source or target systems within your subnet. Learn more.

Work requests

In the Work requests, tab, you can view the connection's work requests, which can be one of the following:

  • Create
  • Update
  • Delete
  • Move
  • Refresh
  • Assign
  • Delete assignment

Tags

Tags help you locate resources within your tenancy. Here, you can view, edit, or delete tags for this connection.

Edit a connection

Note

For Autonomous Database connections, editing and saving the connection automatically retrieves the latest wallet version.

WARNING:

  • You must only create and edit connections in the Oracle Cloud console. Refrain from creating or editing connections in the Credentials screen of the deployment console. Updates are automatically synced to the deployment from the Oracle Cloud console.
  • Changes made to the connection string result in the use of new Ingress IPs for that connection and may require you to update firewall settings to prevent disruptions to your Extracts and Replicats.
To edit a connection:
  1. From the Connections page, select a connection to edit.
    You can also select Edit from the connection's Action menu, and then skip to step 3.
  2. On the Connection details page, from the Actions menu, select Edit.
  3. In the Edit connection panel, edit the values you want to update.
    Note

    You can update the Traffic routing method and subnet selection, if needed. If you change the subnet, the connection's Ingress IPs and Private IP also change.
  4. Click Save changes.
The changes are automatically synchronized to the OCI GoldenGate deployment that it's assigned to.

Refresh a connection

This action applies only to Autonomous Database connections.

You can refresh an Autonomous Database connection to ensure its wallet is up to date with your Autonomous Database instance.

To refresh an Autonomous Database connection, click Refresh on the connection's detail page.

Tip:

Ensure that you first change the database's password before you update the password secret and refresh the connection to prevent existing Extracts and Replicts from stopping.

Assign a deployment to a connection

When you're on the Connections details page, you can assign deployments to the connection.
Note

If using connections with password secrets, the deployment you're assigning to the connection must be able to access the connection's password secrets. Ensure that you add the policy: allow dynamic-group <group-name> to read secret-bundles in <location> to your compartment or tenancy.
To assign a deployment to a connection:
  1. On the Connections details page, click Assigned deployments.
  2. Click Assign deployment.
  3. In the Assign deployments dialog, select a connection from the dropdown. Click Change Compartment, to select a connection from a different compartment.
  4. Click Assign deployment.
The selected connection appears in the Assigned deployments list. You can also view and manage this relationship from the Deployment details page, under Assigned connections.

Unassign a deployment

You can remove, or unassign, a connection from a deployment. First ensure that there are no active processes running in your deployment that involve the connection you want to remove.
To unassign a deployment:
  1. On the Connection details page, click Assigned deployments.
  2. From the Actions menu for the deployment you want to unassign, select Unassign.
  3. In the Unassign deployment dialog, confirm that you want to unassign the connection from this deployment, and then click Unassign deployment.
The deployment no longer appears in the Assigned deployments list. Unassigning a connection from a deployment doesn't delete the connection. If you want to delete the connection see, Delete a connection.
Note

If a connection with a dedicated endpoint remains unassigned for more than seven days, then the service converts it to a shared endpoint.

Test connections

After you assign connections to a deployment, test the connectivity to ensure the deployment can connect to them.

Test connection performs two types of tests: network-level and application-level. Network-level connectivity tests check that the host and port are reachable from the deployment, while application-level tests check that the credentials are valid by logging into the endpoint.

Some connections perform both tests, while others, such as Big Data connection types, don't currently support application-level tests. As long as your connection passes network-level connectivity tests, you can use your connection and start creating extract and replicat processes.

Before you test a connection, ensure that you first create and assign a connection to the deployment.

To test an assigned connection:
  1. On the deployment details page, click Assigned connection.

    You can also test the connection from Assigned deployments on a connection's details page.

  2. In the list of Assigned connections, from the Actions menu for the connection you want to test, select Test connection.

    The Test connection dialog opens and displays a confirmation message, if successful, and an error message, if unsuccessful. If an error message appears, then return to the connection and your settings.

  3. Click Close.

Move a connection

To move a connection:
  1. On the Connection details page, from the Actions menu, click Move resource.
  2. In the Move to another compartment dialog, select the compartment in which to move the connection.
  3. Click Move resource.

Manage tags for a connection

You can add and view a connection's tags from the Connections page and from the connection details page.

On the Connections page, from a connection's Action menu, select Add tags or View tags.

On the connections details page, you can select Add tags from the Actions menu, or click the Tags tab to view and edit tags.

Delete a connection

Before you delete the connection, ensure that there are no processes running in the deployment that involve the connection. Consider unassigning the connection from deployments before you delete it.
To delete a connection:
  1. On the Connections page, select the connection you want to delete. You can also select Delete from the connection's Actions menu in the Connections list, and then skip to Step 3.
  2. On the Connections details page, from the Actions menu, select Delete.
  3. In the Delete connection dialog, confirm that you want to delete the connection, and then click Delete.

Known issues

Action required for Autonomous Databases that use mTLS Authentication

When an Autonomous Database wallet is rotated, the OCI GoldenGate connection to this database must be refreshed to retrieve the latest wallet information.

For more information see, My Oracle Support (MOS) Document 2911553.1.

To refresh an Autonomous Database connection: Edit and save the connection to the Autonomous Database (Autonomous Transaction Processing or Autonomous Data Warehouse). Saving the connection automatically downloads and refreshes the wallet. No other changes to the connection is needed.

To verify:

  1. Launch the deployment console for a deployment that uses the Autonomous Database connection.
  2. In the deployment console, open the navigation menu, and then click Configuration.
  3. On the Credentials screen, observe the Autonomous Database connection string.

    Before the wallet is refreshed, the connection string looks like the following:

    ggadmin@(DESCRIPTION=(TRANSPORT_CONNECT_TIMEOUT=3)(CONNECT_TIMEOUT=60)(RECV_TIMEOUT=120)(retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.us-phoenix-1.oraclecloud.com))(CONNECT_DATA=(COLOCATION_TAG=ogginstance)(FAILOVER_MODE=(TYPE=SESSION)(METHOD=BASIC)(OVERRIDE=TRUE))(service_name=<adb-servicename>_low.adb.oraclecloud.com))(security=(MY_WALLET_DIRECTORY=“/u02/connections/ocid1.goldengateconnection.oc1.phx.<ocid>/wallet”)(SSL_SERVER_DN_MATCH=TRUE)(ssl_server_cert_dn=“CN=adwc.uscom-east-1.oraclecloud.com,
        OU=Oracle BMCS US, O=Oracle Corporation, L=Redwood City, ST=California,
        C=US”)))

    After the wallet is refreshed, the connection string is updated to look like the following:

    ggadmin@(DESCRIPTION=(TRANSPORT_CONNECT_TIMEOUT=3)(CONNECT_TIMEOUT=60)(RECV_TIMEOUT=120)(retry_count=20)(retry_delay=3)(address=(protocol=tcps)(port=1522)(host=adb.us-phoenix-1.oraclecloud.com))(CONNECT_DATA=(COLOCATION_TAG=ogginstance)(FAILOVER_MODE=(TYPE=SESSION)(METHOD=BASIC)(OVERRIDE=TRUE))(service_name=<adb-servicename>_low.adb.oraclecloud.com))(security=(MY_WALLET_DIRECTORY=“/u02/connections/ocid1.goldengateconnection.oc1.phx.<ocid>/wallet”)(SSL_SERVER_DN_MATCH=TRUE)(ssl_server_dn_match=yes)))