How to Use the Admin Client

A How to Use the Admin Client

Admin Client is a command line utility (similar to the classic GGSCI utility). It uses the REST API published by the Microservices Servers to accomplish control and configuration tasks in an Oracle GoldenGate deployment.

Admin Client is used to create, modify, and remove processes, instead of using the Microservices web user interface.

If you need to automate the Admin Client connection with the deployment, you can use an Oracle Wallet to store the user credentials. The credentials stored must have the following characteristics:

Single user name (account) and password
Local to the environment where the Admin Client runs
Available only to the currently logged user
Managed by the Admin Client
Referenced using a credential name
Available for Oracle GoldenGate deployments and proxy connections.

Note:

To use the Admin Client for administration tasks, you need the user credentials that work with both the Service Manager and Administration Server.

To use the Admin Client, perform the following steps:

Set the environment variables: OGG_HOME, OGG_VAR_HOME.

Move to $OGG_HOME/bin and run the command:

[oracle@bigdatalite bin]$ ./adminclient
Oracle GoldenGate Administration Client for Oracle
Version 19.1.0.0.0 OGGCORE_19.1.0.0.0_PLATFORMS_yymmdd.HHMM_FBO

Copyright (C) 1995, 2019, Oracle and/or its affiliates. All rights reserved.

Linux, x64, 64bit (optimized) on Dec 31 2016 23:58:36
Operating system character set identified as UTF-8.

OGG (not connected) 1>

Log into the deployment using the security user credentials. This is the user you created while adding the deployment for your Oracle GoldenGate instance.
```
connect http(s)://localhost:port deployment deployment name as security role user
```
To add users, other than the security role user, for the deployment, use the ADD CREDENTIALS command. To know how this command works, see ADD CREDENTIALS in Command Line Interface Reference for Oracle GoldenGate. Other commands for user credentials are INFO CREDENTIALS and DELETE CREDENTIALS.
You can connect to a deployment or to a proxy server from the Admin Client.

Note:
If your password to connect to a secure or non-secure deployment from the Admin Client has an exclamation mark (!) at the end, then you must enter the password in double quotes when using the CONNECT command in a single line. Otherwise, the password is not accepted and the connection fails. This is required for all deployments with a strong password policy.
Syntax:
```
CONNECT - Connect to an Oracle GoldenGate Service Manager
        |CONNECT server-url [ DEPLOYMENT deployment-name]
        |[ ( AS deployment-credentials-name|
        | USER  deployment-user-name )
        |[PASSWORD deployment-password] ]
        |[PROXY proxy-uri|
        |[(AS proxy-credentials-name
        |USER proxy-user-name)
        |[ PASSWORD proxy-password] ] ] [ ! ]
```
Note:
The deployment credentials cannot be stored as a USERIDALIAS in the credential store because the Oracle wallet used for storing database credentials is managed by the Administration Server. Instead, a separate Oracle wallet is created for the Admin Client. The Oracle wallet is stored in the users home directory.
The following example shows the connection to a deployment and to a proxy server:
```
OGG (not connected) 1> ADD CREDENTIALS admin USER oggadmin PASSWORD oggadmin-A1
2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered. 
OGG (not connected) 2> ADD CREDENTIALS proxy USER oggadmin PASSWORD oggadmin-A2
2019-02-14T00:35:48Z  INFO OGG-15114  Credential store altered. 
OGG (not connected) 3> CONNECT http://abc.oracle.com:12000 AS admin PROXY http:111.1.1.1:3128 as proxy 
Using default deployment 'Local' 
OGG (http://abc.oracle.com:12000 Local) 4>
```
If the credentials are invalid for a proxy connection, then an error similar to the following error occurs:
```
OGG (not connected) 2> ADD CREDENTIALS proxy USER proxyadmin PASSWORD invalid
2019-02-14T00:48:12Z  INFO OGG-15114  Credential store altered. 
OGG (not connected) 3> CONNECT http://abc.oracle.com:12000 AS admin PROXY http://111.1.1.1:3128 as proxy 
ERROR: Proxy server user name 'proxyadmin' or password is incorrect.
```
You can view the full list of Admin Client commands using the HELP command. Use the HELP SHOWSYNTAX command to view the syntax for specific commands.