A How to Use the Admin Client

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

The Admin Client is a standalone application used to create processes, rather than using MA. It’s not used by MA Servers. For example, you can use the Admin Client to execute all the commands necessary to create a new Extract, create a custom Extract application using the REST API, or use the Administration Server available with MA to configure an Extract.


Ensure that the OGG_HOME, OGG_VAR_HOME, and OGG_ETC_HOME are set up correctly in the environment.

For more information on environment variables, see Setting Up the Environment Variables.

To run the Admin Client and use it:

  1. (On a Linux machine) Move to the /bin directory in the Oracle GoldenGate home directory ($OGG_HOME):

    $ cd $OGG_HOME/bin

  2. From the /bin directory, run ./adminclient, as follows:
    [oracle@bigdatalite bin]$ ./adminclient
    Oracle GoldenGate Administration Client for Oracle
    Version OGGCORE_MAIN_PLATFORMS_161231.2020
    Copyright (C) 1995, 2017, 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> 

    You can view the full list of Admin Client commands using the HELP command.

  3. Connect only to the Service Manager from the Admin Client.

    Connect to the http://localhost:<service_manager_port> source deployment using the administrator credentials.


    You must use http or https in the connection string or the Admin Client will not start. In the given example, a non-SSL connection is used.

    You must connect to the database using DBLOGIN because DBLOGIN uses the Credential Store. Also use USERIDALIAS.