October 28, 2021

OGG Admin client utility

Oracle GoldenGate command-line utility - adminclient commands


Admin Client is a new command line utility, similar to GGSCI, which is used with Oracle GoldenGate Microservices Architecture(MA).

AdminClient was released in Oracle GoldenGate 12c Release 3 (12.3.0.0.1).

It uses the REST API published by the MA Servers to accomplish control and configuration tasks in Oracle GoldenGate (OGG) deployments.

Differences between GGSCI tool and admin client CLI:

      Task      GGSCI Admin Client
Management Local deployments only All MA deployments
Transfer data using(Data) Pump Distribution Server
Access to server SSH or local consoleBrowser (HTTP or HTTPS)
Security System security MA security
Connected By defaultRequires separate CONNECT command
Connection to DBMS Required NOT required
Login to database using USERID+PASSWORD (or) USERIDALIAS USERIDALIAS
Sequence of extract commands REGISTER EXTRACT before ADD EXTRACT REGISTER EXTRACT after ADD EXTRACT
CommunicationsUnsecuredSecured (with SSL)

$OGG_HOME/bin/adminclient

adminclient> ADD AUTHORIZATIONPROFILE
adminclient> ADD CREDENTIALS
adminclient> ADD DISTPATH
adminclient> ADD ENCRYPTIONPROFILE
adminclient> ADD PROFILE
adminclient> ADD RECVPATH

adminclient> ALTER AUTHORIZATIONPROFILE
adminclient> ALTER DISTPATH
adminclient> ALTER ENCRYPTIONPROFILE
adminclient> ALTER RECVPATH

adminclient> CD

adminclient> CLEAR INSTANTIATION CSN

adminclient> CONNECT
adminclient> connect http://<host>:<port> deployment <deployment-name> as <deployment username>, password <password>
adminclient> connect https://localhost:9000 as admin password adminpw
adminclient> connect https://ogg19c.localdomain:7820 deployment D1 as admin password adminpw
adminclient> connect https://localhost:9000 deployment ogg_dep as admin !
adminclient> connect https://ogg21c.localdomain:7820 deployment Target
 
adminclient> DBLOGIN USERIDALIAS
adminclient> dblogin useridalias <alias> domain <domain>
adminclient> dblogin useridalias SOURCEPDB

adminclient> DELETE AUTHORIZATIONPROFILE
adminclient> DELETE CREDENTIALS
adminclient> DELETE DISTPATH
adminclient> DELETE ENCRYPTIONPROFILE
adminclient> DELETE PROFILE
adminclient> DELETE RECVPATH

adminclient> DISABLE SERVICE
adminclient> DISCONNECT

adminclient> EDIT ENCKEYS
adminclient> EDIT GLOBALS
adminclient> ENABLE SERVICE

adminclient> INFO AUTHORIZATIONPROFILE
adminclient> INFO CREDENTIALS
adminclient> INFO DISTPATH
adminclient> INFO ENCRYPTIONPROFILE
adminclient> INFO PROFILE
adminclient> INFO RECVPATH

adminclient> HEALTH DEPLOYMENT
adminclient> NOALLOWNESTED
adminclient> PURGE EXTTRAIL

adminclient> RESTART DEPLOYMENT
adminclient> RESTART ER
adminclient> RESTART EXTRACT
adminclient> RESTART REPLICAT
adminclient> RESTART SERVICE

adminclient> SET COLOR
adminclient> SET COLOR on/off

adminclient> SET DEBUG
adminclient> SET DEBUG on/off

adminclient> SET INSTANTIATION CSN

adminclient> SET PAGER
adminclient> SET PAGER more

adminclient> SET VERBOSE
adminclient> SET VERBOSE on/off

adminclient> show

adminclient> START DEPLOYMENT
adminclient> START DISTPATH
adminclient> START RECVPATH
adminclient> START SERVICE

adminclient> STATUS DEPLOYMENT
adminclient> STATS DISTPATH
adminclient> STATS RECVPATH
adminclient> STATUS SERVICE

adminclient> STOP DEPLOYMENT
adminclient> STOP DISTPATH
adminclient> STOP RECVPATH
adminclient> STOP SERVICE

adminclient> VALIDATE AUTHORIZATIONPROFILE

adminclient> VIEW DISCARD
adminclient> VIEW GLOBALS
adminclient> VIEW MESSAGES

1 comment: