A propos du client d'administration

Le client d'administration est un utilitaire de ligne de commande. Il utilise l'API REST publiée par les microservices pour effectuer des tâches de contrôle et de configuration dans un déploiement Oracle GoldenGate.

Le client d'administration est un utilitaire de ligne de commande qui peut servir à Créer, modifier et enlever des processus Oracle GoldenGate, et qu'il peut être employé à l'emplacement de l'interface utilisateur Web de l'architecture de microservices. Le programme Admin Client se trouve dans le répertoire $OGG_HOME/bin, où $OGG_HOME est le répertoire de base Oracle GoldenGate. Le nom du programme Admin Client est adminclient.

Si vous devez automatiser la connexion au déploiement du client d'administration, vous pouvez stocker les informations d'identification utilisateur dans un portefeuille Oracle. Les informations d'identification stockées doivent présenter les caractéristiques suivantes :

nom (compte) et mot de passe utilisateur uniques,
être locales pour l'environnement où est exécuté le client d'administration,
être disponibles uniquement pour l'utilisateur actuellement connecté,
être gérées par le client d'administration,
être référencées à l'aide d'un nom d'informations d'identification,
être disponibles pour les connexions proxy et les déploiements Oracle GoldenGate.

Afin d'utiliser le client d'administration pour des tâches d'administration, vous avez besoin d'informations d'identification utilisateur qui fonctionnent avec le gestionnaire de service et le service d'administration. Voici les configurations requises pour utiliser le client d'administration :

Assurez-vous que le répertoire bin du logiciel Oracle fait partie de la variable d'environnement PATH :
```
 export PATH=ogg_install_location/bin:$PATH
```
Si vous configurez un déploiement sécurisé à l'aide de fichiers du certificat SSL (.pem ou .der), vous devez ajouter la variable d'environnement OGG_CLIENT_TLS_CAPATH. Cette opération est requise pour pouvoir se connecter au déploiement à partir du client d'administration. Cette variable est utilisée pour indiquer l'emplacement des fichiers de certificat sur l'hôte. Pour le client qui a uniquement besoin de valider les certificats du serveur, la variable d'environnement OGG_CLIENT_TLS_CAPATH doit faire référence à un fichier contenant un certificat d'autorité de certifications sécurisée partagé avec le serveur auquel le client est censé se connecter.
```
 export OGG_CLIENT_TLS_CAPATH = <em>deployment_rootCA_certificate_location</em>
```
Remarque : pour Microsoft Windows, le format de fichier de certificat par défaut est .der, tandis que toutes les autres plates-formes utilisent .pem comme format par défaut.
Exécutez la commande :
```
 [oracle]$ adminclient
```
La sortie affiche l'invite du client d'administration Oracle GoldenGate, qui vous permet de vous connecter au déploiement à partir du client d'administration . Vous pouvez créer un alias pour le nom utilisateur et le mot de passe, et utiliser le nom d'alias dans le script pour la connexion au serveur.
```
 OGG (not connected) 1> ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
Ici, l'alias admin est créé pour l'utilisateur ggadmin et pour le mot de passe ** réels sur le serveur.

Connectez-vous maintenant au service à partir du client d'administration à l'aide de la commande ci-après. Le client d'administration récupère le nom utilisateur et le mot de passe réels dans le portefeuille qui se trouve dans le répertoire $HOME de l'utilisateur exécutant le script et utilise ces informations d'identification pour la connexion au service.
```
CONNECT http(s)://my.gg.server.com AS admin
```
Connectez-vous à un déploiement ou à un serveur proxy à partir du client d'administration en tant qu'utilisateur de sécurité. Il s'agit de l'utilisateur créé lors de l'ajout du déploiement pour l'instance Oracle GoldenGate via OGGCA.

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

Remarque : si le mot de passe permettant de se connecter à un déploiement sécurisé ou non sécurisé à partir du client d'administration se termine par un point d'exclamation ( !) à la fin, vous devez saisir le mot de passe entre guillemets lorsque la commande CONNECT est utilisée sur une seule ligne. Sinon, le mot de passe est rejeté et la connexion échoue. Cette règle s'applique à tous les déploiements disposant d'une stratégie de mot de passe renforcé.

Syntaxe :
```
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 ] ] ] [ ! ]
```
Pour en savoir plus, reportez-vous à la commande CONNECT dans Référence de l'interface de ligne de commande pour Oracle GoldenGate.

Remarque : les informations d'identification de déploiement ne peuvent pas être stockées dans la banque d'informations d'identification en tant qu'alias USERIDALIAS. En effet, le portefeuille Oracle utilisé pour stocker les informations d'identification de base de données est géré par le service d'administration. Au lieu de cela, un portefeuille Oracle distinct est créé pour le client d'administration. Le portefeuille Oracle est stocké dans le répertoire de base des utilisateurs.

L'exemple suivant illustre l'ajout d'un utilisateur de déploiement Oracle GoldenGate pour la connexion au déploiement à partir du client d'administration :
```
ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
Le mot de passe de l'utilisateur est stocké dans le répertoire masqué GoldenGate $HOME.

Sortie :
```
2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.
```
L'exemple suivant illustre l'ajout d'un nom d'alias pour le nom utilisateur et le mot de passe ainsi que son utilisation pour la connexion au déploiement à partir du client d'administration :
```
 ADD CREDENTIALS admin USER ggadmin PASSWORD *********
```
Le client d'administration obtient le nom utilisateur et le mot de passe réels à partir du portefeuille dans le répertoire $HOME de l'utilisateur qui exécute le script et utilise ces informations d'identification pour se connecter au service.

Sortie :
```
2019-02-14T00:35:38Z  INFO OGG-15114  Credential store altered.
```
L'exemple suivant illustre l'ajout d'un utilisateur proxy de déploiement Oracle GoldenGate pour la connexion au déploiement à partir du client d'administration :
```
ADD CREDENTIALS proxy USER proxyadmin PASSWORD ********
```
Voici un exemple d'utilisation de la commande CONNECT pour l'accès à un déploiement en utilisant le client d'administration :
```
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>
```
Vous pouvez afficher la liste complète de commandes du client d'administration à l'aide de la commande HELP. Utilisez la commande HELP SHOWSYNTAX pour visualiser la syntaxe de commandes spécifiques.