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 MA Servers to accomplish control and configuration tasks in an Oracle GoldenGatedeployment.

Admin Client is used to create, modify, and remove processes, rather than using MA. It’s not used by MA services such as the Administration, Distribution and other servers. For example, you can either use Admin Client to execute all the commands necessary to create an Extract or customize a new Extract application, 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_18.
    Copyright (C) 1995, 2018, 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 the Admin Client will not connect. In the given example, a non-SSL connection is used.

    If you use DBLOGIN, you have to use the USERIDALIAS because you cannot use the USERID.

    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 the 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 http://myserver.example.org as oggadmin !

If you enter an incorrect deployment name, a list of deployments is displayed. Depending on the option you choose to connect to a deployment with the Admin Client, different outputs are generated, as explained in the following scenarios:

  • When you connect without using the deployment name, the default deployment is connected and displayed in the output. .

    For example:

    OGG (not connected) 1>  connect https://localhost:9000 as admin password adminpw  
    Using default deployment 'D1'  

    In this example, D1 is the name of the deployment.

  • When the connection occurs with the deployment, the Admin Client connects to the deployment but doesn’t provide the deployment name in the output.

    For example:

    OGG (not connected) 1> connect https://localhost:9000 deployment D1 as admin password adminpw   

    The command is successful but without any output. 

  • When you connect to the deployment with the deployment name and user name but without the password, then Admin Client doesn’t display the output but waits for the password.

    For example:

    OGG (not connected) 1>  connect https://localhost:9000 deployment D1 as admin ! 
    Password for 'admin' at 'https://localhost:9000': 
    OGG (https://localhost:9000D1) 2>