Using the Admin Client

Access AdminClient

Use Admin Client to connect to OCI GoldenGate to configure tasks and view process information and log messages. You can launch Admin Client one of two ways:

Click Launch Admin Client on the deployment details page.
Launch CloudShell, and then run Admin Client.

Note

If you have an Oracle GoldenGate Marketplace version running on a Compute instance, you can access its Admin Client to connect to your OCI GoldenGate deployment.

For deployments with IAM authentication enabled, you must first generate an access token to use AdminClient. To generate an access token and log in to Admin Client:

In the Oracle Cloud global navigation bar, click Profile, and then My profile.
On your profile page, under Resources, click My access tokens.
For Generate personal access token, select Invokes other APIs.
Select the deployment to connect to using Admin Client.
Set the token expiration to 30 minutes.
Click Download token.
Open the downloaded token file and copy the contents.
In Admin Client, run the following command to connect to your deployment. Ensure that you replace the <deployment_url> with the Console URL from the deployment's details page, and <token> with the downloaded token contents.
```
connect <deployment_url> <token> !
```

For more information, see How to connect to GoldenGate with IDCS Federation using AdminClient.

Connect to Admin Client through Cloud Shell

To connect to a OCI GoldenGate deployment with a public endpoint in Cloud Shell, run the following commands:

adminclient
connect <deployment-public-url-or-ip> as <goldengate-user> password <goldengate-password> !

Note

You can find the deployment's url and public IP address on its deployment details page.
If you encounter the error, bash: adminclient: command not found, then use the following steps to change Cloud Shell's architecture:
1. From the Cloud Shell's Actions menu, select Architecture.
2. In the Architecture dialog, select X86_64 for preferred architecture, and then click Confirm.

If the deployment has a private endpoint, then you must create a bastion, bastion session, and SSH tunnel.

Note

By default, Cloud Shell limits network access to OCI internal resources in your tenancy home region unless you have enabled the Cloud Shell managed Public Network. Your administrator must configure an Identity policy to enable Cloud Shell Public Network. For more information, see Cloud Shell Networking.

To connect to a private OCI GoldenGate deployment in Admin Client:

In the Oracle Cloud console global navigation bar, click Cloud Shell. If this is your first time connecting to Cloud Shell, it will take a few moments to connect.
You can run the following command to generate SSH keys, or skip this step and generate the keys when you create the bastion:
```
ssh-keygen -t rsa
```
Keep the default filename and don't enter a passphrase when prompted. The private key is located at ~/ssh/id_rsa and the public key is located at ~/ssh/id_rsa.pub.
On the deployment details page, take note of the deployment's Private IP and Subnet information.
Create a Bastion.
1. From the Oracle Cloud console menu, select Identity & Security, and then select Bastion.
2. Click Create Bastion.
3. In the Create Bastion panel, enter a name, and then select the same subnet where the deployment resides.
4. For CIDR block allowlist, enter 0.0.0.0/0.
5. Click Create bastion.
Create a session.
1. After the bastion is in an Active state, on the bastion details page, click Create Session.
2. For Session type, select SSH Port forwarding session.
3. Enter a name for the session.
4. For Connect to target using, select IP Address, and then enter the deployment's private IP.
5. For Port, enter 443.
6. For Add SSH Key, copy and paste the contents of the public key (~/ssh/id_rsa.pub) from Cloud Shell.
7. Click Create Session.
After the bastion session state is active, select View SSH command from its Action menu (ellipsis icon).
In the View SSH command dialog, enter the path to the private key (~/ssh/id_rsa) in place of <private-key> and replace <localport> with the port in Cloud Shell that will forward the connection to the bastion.
Note

Cloud Shell doesn't allow port forwarding on a privileged port with sudo access, so you must use a non-privileged port like 7443. After the command runs once in the foreground to add the Bastion host to known_hosts, you can append an amperstand (&) to the end of the command so that it can run in the background next time.
Copy the command and then run it in Cloud Shell. You can ignore bind: Cannot assign requested address messages.
Start Admin Client.
```
adminclient
```
Connect to the OCI GoldenGate deployment.
```
connect 127.0.0.1:7443 as <goldengate-user> password <goldengate-password> !
```
Note

The exclamation point (!) at the end of the command is very important. Without it, the command fails and returns an error.

Use Admin Client

After connecting successfully, you can run any of the following commands:

Display the status of OCI GoldenGate processes:
```
info all
```
View statistics for your Extract:
```
view stats
```
View the content of the ggserror log file:
```
view messages
```
Purge trail files that are no longer used by Extracts:
```
purge exttrail <trail-file-name>
```

See AdminClient Command Line Interface Commands for the full list of commands.

Oracle Cloud Infrastructure Documentation