A How to Use Admin Client

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.

Admin Client is used to create processes, rather than using MA. It’s not used by MA Servers. For example, you can use 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 Admin Client:

  1. Set the environment variables: OGG_HOME, OGG_ETC_HOME, OGG_VAR_HOME.

  2. Move to $OGG_HOME/bin and run the command:
    [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 Admin Client.

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


    You must use http or https in the connection string or 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.

    By default, Admin Client does not allow connecting to a server through HTTPS when the server certificate is invalid. To override this behavior, use the ! modifier with the CONNECT command. For example, when using Admin Client to connect to the Oracle GoldenGate Microservices Architecture services that are secured with a self-signed SSL certificate, you must use a command with the ! modifier:

    CONNECT https://myserver.example.org as oggadmin !