Acerca del cliente de administración

El cliente de administración es una utilidad de línea de comandos. Utiliza la API de REST publicada por los microservicios para realizar las tareas de control y configuración en un despliegue de Oracle GoldenGate.

El cliente de administración es una utilidad que se puede utilizar para Crear, Modificar y Eliminar Procesos de Oracle GoldenGate, y se puede utilizar en lugar de la Interfaz de Usuario Web de MA. El programa de cliente de administración se encuentra en el directorio $OGG_HOME/bin, donde $OGG_HOME es el directorio raíz de Oracle GoldenGate. El nombre del programa Admin Client es adminclient.

Si necesita automatizar la conexión del cliente de administración con el despliegue, puede utilizar una instancia de Oracle Wallet para almacenar las credenciales de usuario. Las credenciales almacenadas deben tener las siguientes características:

Nombre de usuario (cuenta) y contraseña de conexión única
Locales del entorno en el que se ejecuta el cliente de administración
Disponibles solo para el usuario actualmente conectado
Gestionadas por el cliente de administración
Se hace referencia a ellas mediante un nombre de credencial
Disponibles para despliegues y conexiones de proxy de Oracle GoldenGate.

Para utilizar el cliente de administración para las tareas de administración, necesita las credenciales de usuario que funcionan tanto con el gestor de servicios como con el servicio de administración. A continuación, se indican las configuraciones necesarias para trabajar con el cliente de administración:

Asegúrese de que el directorio bin del software Oracle forma parte de la variable del entorno PATH:
```
 export PATH=ogg_install_location/bin:$PATH
```
Si configura un despliegue seguro utilizando archivos del certificado SSL (.pem o .der), debe agregar la variable del entorno OGG_CLIENT_TLS_CAPATH. Esto es necesario para poder conectarse al despliegue desde el cliente de administración. Esta variable se utiliza para especificar la ubicación en la que están ubicados los archivos de certificado en el host. Para aquellos clientes que solo necesiten validar el certificado de servidor, la variable del entorno OGG_CLIENT_TLS_CAPATH debe hacer referencia a un archivo de certificado de CA que contenga un certificado de CA que se comparta con el servidor al que espera conectarse el cliente.
```
 export OGG_CLIENT_TLS_CAPATH = <em>deployment_rootCA_certificate_location</em>
```
Nota: Para Microsoft Windows, el formato de archivo del certificado por defecto es .der, y todas las demás plataformas utilizan .pem como el formato por defecto.
Ejecute el comando:
```
 [oracle]$ adminclient
```
La salida muestra la petición de datos del cliente de administración de Oracle GoldenGate, donde puede conectarse al despliegue desde el cliente de administración. Puede crear un alias para el nombre de usuario y contraseña, y usar el nombre de alias en el script para conectarse al servidor.
```
 OGG (not connected) 1> ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
Aquí se crea un alias denominado admin para el usuario real ggadmin y su contraseña ** en el servidor.

A continuación, conéctese al servicio desde el cliente de administración utilizando el comando siguiente. El cliente de administración obtiene el nombre de usuario real y la contraseña de la cartera del directorio $HOME del usuario que ejecuta el script, y utiliza estas credenciales para conectarse al servicio.
```
CONNECT http(s)://my.gg.server.com AS admin
```
Conéctese a un despliegue o a un servidor proxy desde el cliente de administración como un usuario de seguridad. Este es el usuario que ha creado al agregar el despliegue para su instancia de Oracle GoldenGate mediante OGGCA.

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

Nota: Si el signo de exclamación (!) al final de la contraseña para conectarse a un despliegue seguro o no seguro desde el cliente de administración, debe introducir la contraseña entre comillas dobles al utilizar el comando CONNECT en una sola línea. En caso contrario, no se aceptará la contraseña y fallará la conexión. Esto es necesario para todos los despliegues con una política de contraseña segura.

Sintaxis:
```
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 el comando CONNECT en la Referencia de la interfaz de línea de comandos para Oracle GoldenGate para obtener más información.

Nota: Las credenciales del despliegue no se pueden almacenar como un USERIDALIAS en el almacén del mismo porque la cartera de Oracle utilizada para almacenar las credenciales del base de datos se gestiona por el servicio de administración. En su lugar, se crea una cartera de Oracle independiente para el cliente de administración. La cartera de Oracle se almacena en el directorio de inicio de los usuarios.

En el siguiente ejemplo se muestra la adición de un usuario del despliegue de Oracle GoldenGate para conectarse al despliegue desde el cliente de administración:
```
ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
La contraseña del usuario se almacena en el directorio oculto GoldenGate $HOME.

Salida:
```
2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.
```
El siguiente ejemplo muestra la adición de un nombre de alias para el nombre de usuario y la contraseña, y su uso para conectarse al despliegue desde el cliente de administración:
```
 ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
Admin Client obtiene el nombre de usuario y la contraseña reales de la cartera en el directorio $HOME del usuario que ejecuta el script y utiliza esas credenciales para conectarse al servicio.

Salida:
```
2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.
```
En el siguiente ejemplo se muestra la adición de un usuario de proxy del despliegue de Oracle GoldenGate para conectarse al despliegue desde el cliente de administración:
```
ADD CREDENTIALS proxy USER proxyadmin PASSWORD ********
```
A continuación se incluye un ejemplo de uso del comando CONNECT para acceder al despliegue mediante el cliente de administración:
```
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>
```
Puede ver la lista completa para comandos del cliente de administración mediante el comando HELP. Utilice el comando HELP SHOWSYNTAX para ver la sintaxis de comandos específicos.