Informazioni sul client di amministrazione

Il client di amministrazione è una utility della riga di comando. Utilizza l'interfaccia API REST pubblicata dai microservizi per eseguire i task di controllo e configurazione in una distribuzione di Oracle GoldenGate.

Il client di amministrazione è un'utility della riga di comando che può essere utilizzata per crearne, modificarne e rimuoverne i processi in sostituzione all'interfaccia utente Web dell'architettura di microsistemi MA. Il programma Client di amministrazione si trova nella directory $OGG_HOME/bin, dove $OGG_HOME è la directory home di Oracle GoldenGate. Il nome del programma Admin Client è adminclient.

Se è necessario rendere automatica la connessione del client di amministrazione alla distribuzione, è possibile utilizzare un wallet Oracle per memorizzare le credenziali utente. Le credenziali memorizzate devono avere le caratteristiche riportate di seguito.

Per utilizzare il client di amministrazione per i task di amministrazione, sono necessarie credenziali utente valide sia per Service Manager che per il servizio di amministrazione. Di seguito sono elencate le configurazioni necessarie per utilizzare il client di amministrazione:

  1. Accertarsi che la directory bin del software Oracle sia inclusa nella variabile di ambiente PATH:

     export PATH=ogg_install_location/bin:$PATH

    Se si configura una distribuzione sicura utilizzando i file del certificato SSL (.pem o .der), è necessario aggiungere la variabile di ambiente OGG_CLIENT_TLS_CAPATH. per poter eseguire la connessione alla distribuzione dal client di amministrazione. Questa variabile viene utilizzata per specificare la posizione nell'host in cui si trovano i file di certificato. Per i client, che devono solo convalidare i certificati server, la variabile di ambiente OGG_CLIENT_TLS_CAPATH deve fare riferimento a un file contenente un certificato CA protetto condiviso con il server a cui si prevede che il client si connetterà.

     export OGG_CLIENT_TLS_CAPATH = <em>deployment_rootCA_certificate_location</em>

    Nota: per Microsoft Windows, il formato del file certificato predefinito è .der, mentre tutte le altre piattaforme utilizzano il formato .pem come predefinito.

  2. Eseguire il comando:

     [oracle]$ adminclient

    L'output mostra il prompt del client di amministrazione di Oracle GoldenGate, che consente di connettersi alla distribuzione dal client di amministrazione. È possibile creare un alias per il nome utente e la password e utilizzare il nome alias nello script per connettersi al server.

     OGG (not connected) 1> ADD CREDENTIALS admin USER ggadmin PASSWORD *********

    In questo caso viene creato un alias denominato admin per l'utente effettivo ggadmin e una password ** sul server.

    È ora possibile connettersi al servizio dal Client di amministrazione utilizzando il comando riportato di seguito. Adminclient recupera il nome utente e la password reali dal wallet nella directory $HOME dell'utente che esegue lo script e utilizza queste credenziali per eseguire la connessione al servizio.

    CONNECT http(s)://my.gg.server.com AS admin
  3. Connettersi a una distribuzione o a un server proxy dal client di amministrazione come utente di sicurezza. Si tratta dell'utente creato durante l'aggiunta della distribuzione per l'istanza di Oracle GoldenGate in uso mediante OGGCA.

    CONNECT http(s)://localhost:port DEPLOYMENT deployment name AS security role user PASSWORD password

    Nota: se alla fine la password di connessione a una distribuzione sicura o non sicura dal client di amministrazione dispone di un simbolo esclamativo (!) alla fine, sarà necessario immettere la password tra virgolette utilizzando il comando CONNECT in una sola riga. In caso contrario, la password non viene accettata e la connessione non riesce. Questa operazione è obbligatoria per tutte le distribuzioni con criteri password restrittivi.

    Sintassi:

    CONNECT server-url [ DEPLOYMENT deployment-name]
                         [ ( (   AS       deployment-credentials-name
                               | USER     deployment-user-name )
                               [ PASSWORD deployment-password  ] )
                         | TOKEN [ access-token ] ]
                         [ PROXY      proxy-uri
                         [ ( AS       proxy-credentials-name
                         |   USER     proxy-user-name      )
                           [ PASSWORD proxy-password ] ] ] [ ! ]

    Per ulteriori informazioni, vedere il comando CONNECT nel manuale Command Line Interface Reference for Oracle GoldenGate.

    Nota: le credenziali di distribuzione non possono essere memorizzate come USERIDALIAS nell'area di memorizzazione di credenziali perché il wallet Oracle utilizzato per l'archiviazione delle credenziali del database è gestito dal servizio di amministrazione. Viene quindi creato un wallet Oracle distinto per il client di amministrazione. Il wallet Oracle viene memorizzato nella directory home degli utenti.

    Nell'esempio seguente viene illustrata l'aggiunta di un utente della distribuzione di Oracle GoldenGate per la connessione alla distribuzione dal client di amministrazione.

    ADD CREDENTIALS admin USER ggadmin PASSWORD *********

    La password per l'utente viene memorizzata nella directory nascosta GoldenGate $HOME.

    Output:

    2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.

    Nell'esempio seguente viene illustrato come aggiungere un nome alias per il nome utente e la password e come utilizzarli per connettersi alla distribuzione dal Client di amministrazione:

     ADD CREDENTIALS admin USER ggadmin PASSWORD *********

    Il client di amministrazione ottiene il nome utente e la password reali dal wallet nella directory $HOME dell'utente che esegue lo script e utilizza tali credenziali per connettersi al servizio.

    Output:

    2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.

    Nell'esempio seguente viene illustrata l'aggiunta di un utente delegato della distribuzione di Oracle GoldenGate per la connessione alla distribuzione dal client di amministrazione.

    ADD CREDENTIALS proxy USER proxyadmin PASSWORD ********

    Di seguito è riportato un esempio di utilizzo del comando CONNECT per l'accesso a una distribuzione mediante il client di amministrazione.

    OGG (Not Connected)4> CONNECT http://www.example.com:12000 deployment EAST PROXY http:111.1.1.1:3128 as proxyadmin password oggadmin-A2
    Using default deployment 'Local'
    OGG (http://www.example.com:12000 Local) 4>
  4. Per visualizzare la lista completa di comandi del client di amministrazione, utilizzare il comando HELP. Per visualizzare la sintassi di comandi specifici, utilizzare il comando HELP SHOWSYNTAX.