About the Command Line Interfaces

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 MA whereas GGSCI is used with CA.

What is the Admin Client?

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

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.

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.

What is the Oracle GoldenGate Software Command Interface (GGSCI)?

Use the ggsci command to run the GGSCI command interface from the command line of the operating system. Optionally, you can provide input from an OBEY file. For more information about using an input file into GGSCI, see Storing and Calling Frequently Used Command Sequences Administering Oracle GoldenGate.

How to Use this Reference

The Common Command Line Interface Commands chapter provides detailed information and examples about the commands that are common to both the Admin Client and GGSCI. Use this chapter as a starting point when searching for a command. Any command where the syntax differs between the two CLIs, it is clearly denoted.

The two remaining chapters are specific to each CLI.

Note:

In GGSCI, commas are required when separating options within a command, but Admin Client doesn't need any commas, but if they are there, it will simply ignore them.