Sobre o Admin Client

Admin Client é um utilitário de linha de comando. Ele usa a API REST publicada pelos microsserviços para realizar tarefas de controle e configuração em uma implantação do Oracle GoldenGate.

Admin Client é um utilitário da linha de comando que pode ser usado para criação, modificação e remoção de processos Oracle GoldenGate e pode ser usado no lugar da interface do usuário Web MA. O programa Admin Client está localizado no diretório $OGG_HOME/bin, em que $OGG_HOME é o diretório home do Oracle GoldenGate. O nome do programa Admin Client é adminclient.

Caso precise automatizar a conexão do Admin Client com a implantação, você poderá usar um Oracle Wallet para armazenar as credenciais do usuário. As credenciais armazenadas devem ter as seguintes características:

Para usar o Admin Client para tarefas administrativas, você precisa das credenciais do usuário que funcionam tanto com o Service Manager quanto com o Administration Service. Aqui estão as configurações necessárias para trabalhar com o Admin Client:

  1. Verifique se o diretório bin do Software Oracle faz parte da variável do ambiente PATH:

     export PATH=ogg_install_location/bin:$PATH

    Se você configurar uma implantação segura usando arquivos do certificado SSL (.pem ou .der), deverá adicionar a variável do ambiente OGG_CLIENT_TLS_CAPATH. Essa ação é necessária para que seja possível conectar-se com a implantação do Admin Client. Esta variável é usada para especificar o local em que os arquivos de certificado estão localizados no host. Para clientes apenas que precisam validar certificados de servidor, a variável do ambiente OGG_CLIENT_TLS_CAPATH deve se referir a um arquivo que contém um Certificado CA confiável que é compartilhado com o servidor para o qual o cliente deverá se conectar.

     export OGG_CLIENT_TLS_CAPATH = <em>deployment_rootCA_certificate_location</em>

    Observação: para o Microsoft Windows, o formato do arquivo do certificado padrão é .der, enquanto todas as outras plataformas usam .pem como o formato padrão.

  2. Execute o comando:

     [oracle]$ adminclient

    A saída exibe o prompt do Oracle GoldenGate Admin Client, em que você pode se conectar com a implantação com base no Admin Client. Você pode criar um alias para o nome de usuário e a senha e usar o nome do alias em seu script para estabelecer conexão com o servidor.

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

    Aqui é criado um alias chamado admin para o usuário real ggadmin e senha ** no servidor.

    Agora estabeleça conexão com o serviço pelo Admin Client usando o comando a seguir. O Adminclient obtém o nome de usuário e senha reais na wallet no diretório $HOME do usuário que executa o script e usa essas credenciais para estabelecer conexão com o serviço.

    CONNECT http(s)://my.gg.server.com AS admin
  3. Conecte-se com uma implantação ou um servidor proxy do Admin Client como usuário de segurança. Esse é o usuário que você criou ao adicionar a implantação para sua instância do Oracle GoldenGate usando o OGGCA.

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

    Observação: Se a senha para se conectar a uma implantação segura ou não segura do Cliente Admin tiver um sinal de exclamação (!) no final, você deverá informar a senha entre aspas duplas ao usar o comando CONNECT em uma única linha. Caso contrário, a senha não é aceita e haverá falha na conexão. Isso é necessário para todas as implantações com uma política de senha forte.

    Sintaxe:

    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 ] ] ] [ ! ]

    Consulte o comando CONNECT na Referência de Interface de Linha de Comando do Oracle GoldenGate para saber mais.

    Observação: As credenciais de implantação não podem ser armazenadas como USERIDALIAS no armazenamento de credenciais porque a wallet Oracle usada para armazenar credenciais do banco de dados é gerenciada pelo Serviço de Administração. Em vez disso, um Oracle Wallet separado é criado para o Admin Client. O Oracle Wallet é armazenado no diretório home de usuários.

    O seguinte exemplo mostra a adição de um usuário de implantação do Oracle GoldenGate para conectar-se com a implantação com base no Admin Client:

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

    A senha do usuário é armazenada no diretório GoldenGate $HOME oculto.

    Saída:

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

    O exemplo a seguir mostra a adição de um nome de alias para o nome de usuário e a senha e seu uso para estabelecer conexão com a implantação pelo Admin Client:

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

    O Admin Client obtém o nome de usuário e a senha reais da wallet no diretório $HOME do usuário que está executando o script e usa essas credenciais para estabelecer conexão com o serviço.

    Saída:

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

    O seguinte exemplo mostra a adição do usuário proxy de implantação do Oracle GoldenGate para conectar-se com a implantação com base no Admin Client:

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

    Veja um exemplo de como usar o comando CONNECT para acessar uma implantação usando o Admin Client:

    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. Você pode exibir a lista completa de comandos do Admin Client usando o comando HELP. Use o comando HELP SHOWSYNTAX para exibir a sintaxe de comandos específicos.