1 About the Command Line Interfaces
Oracle GoldenGate provides a command line interface (CLI) for both the Microservices Architecture (MA) and the Classic Architecture (CA).
Admin Client is used with Microservices Architecture whereas GGSCI is used with Classic Architecture.
What is the Admin Client?
$OGG_HOME/bin
directory, where $OGG_HOME
is the
Oracle GoldenGate home directory.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.
-
In Linux, set the
OGG_HOME
, andPATH
environment variable to the following:export PATH=$OGG_HOME/bin:$PATH
export OGG_HOME=ogg_install_location
-
Move to
$OGG_HOME/bin
and run the command:[oracle@bigdatalite bin]$ ./adminclient Oracle GoldenGate Administration Client for Oracle Version 21.4.0.0.0 OGGCORE_21.4.0.0.0_PLATFORMS_yymmdd.HHMM_FBO Copyright (C) 1995, 2022, 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>
-
Connect to a deployment or to a proxy server from the Admin Client as a security user. This is the user you created while adding the deployment for your Oracle GoldenGate instance using OGGCA.
CONNECT http(s)://localhost:port DEPLOYMENT deployment name AS security role user PASSWORD password
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 theCONNECT
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] ] ] [ ! ]
See the
CONNECT
command in the Command Line Interface Reference for Oracle GoldenGate to know more.Note:
The deployment credentials cannot be stored as aUSERIDALIAS
in the credential store because the Oracle wallet used for storing database credentials is managed by the Administration Service. 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:ADD CREDENTIALSTORE admin USER oggadmin PASSWORD oggadmin-A1 2019-02-14T00:35:38Z INFO OGG-15114 Credential store altered. ADD CREDENTIALSTORE proxy USER oggadmin PASSWORD oggadmin-A2 2019-02-14T00:35:48Z INFO OGG-15114 Credential store altered. CONNECT http://www.example.com:12000 AS admin PROXY http:111.1.1.1:3128 as proxy Using default deployment 'Local' OGG (http://www.example.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 theHELP SHOWSYNTAX
command to view the syntax for specific commands.
What is the Oracle GoldenGate Software Command Interface (GGSCI)?
Use the ggsci
program located in the home directory of the Oracle
GoldenGate installation to create, delete, and manage Oracle GoldenGate processes.
Commands can be entered manually into ggsci
or can be loaded as
input from an OBEY
file.
For more information on using OBEY
files, see Storing and Calling Frequently Used Command
Sequences in Administering Oracle GoldenGate.
Note:
WhenLANG
is set at the operating system level to
en_US.UTF-16
, it causes GGSCI to hang. The setting of
en_US.UTF-8
is allowed. Setting in Linux, which would cause GGSCI
or Admin Client to hang is:
[celclnx29]/bugmnt3/am/celclnx29/SRx.xxxxxxxxxxx/user/gg122> echo $LANG
en_US.UTF-16
How to Use this Reference
- Admin Client Command Line Interface Commands: This part includes all the commands that can be executed from the Admin Client command line.
- GGSCI Command Line Interface Commands: This part includes all the commands that can be executed from the GGSCI command line.