Utilisation de la CLI

Appel des commandes de la CLI

La CLI est constituée de la commande pgtool, qui utilise le mode de commande à une ligne et exécute une commande à la fois. pgtool contient un certain nombre de sous-commandes, d'options et d'opérandes qui sont décrits dans la Synthèse des commandes. Vous pouvez spécifier les options à l'aide d'un mot clé entier ou court. Dans les descriptions de commandes suivantes, les mots clés entiers sont utilisés, mais les raccourcis correspondants sont présentés dans le Tableau 3–2.

Informations d'initialisation requises par la CLI

Des informations d'initialisation sont nécessaires pour localiser et interroger le magasin de données qui renferme les éléments et profils. Il s'agit, en l'occurrence du serveur, du numéro de port, du DN de base et du nom d'utilisateur de l'administrateur. Vous pouvez spécifier ces informations sur la ligne de commande ou dans un fichier d'initialisation.

Fichier d'initialisation

Les informations d'initialisation peuvent être lues à partir d'un fichier de propriétés. Il est possible de spécifier l'emplacement de ce fichier sur la ligne de commande au moyen de l'option --file.

--file=<fichier d'initialisation> : chemin d'accès complet au fichier d'initialisation. Le fichier par défaut est $HOME/pgtool.properties.

Exemple : --file=/var/opt/apoc/cli.properties.

Le format de ce fichier est décrit à l'Annexe A, Paramètres de configuration du Guide d’installation de Sun Desktop Manager 1.0.

Options d'initialisation

Vous pouvez définir le mode d'initialisation sur la ligne de commande à l'aide des options --url et --username.

--url=<url> : URL identifiant le magasin de données. L'URL respecte le format suivant : ldap://<nom d'hôte>:<port>/<nom de base>, <nom d'hôte> étant le nom du serveur (par défaut, il s'agit de l'hôte local), <port> correspond au numéro du port sur le serveur (389 par défaut) et <nom de base> fait référence au DN de l'entrée de base.

Exemple : --url=ldap://serveur1.sun.com:399/o=apoc.

--username=<nom d'utilisateur> : nom d'utilisateur de l'administrateur dans le format utilisé par le moteur de traitement de stockage. L'administrateur est ensuite invité à saisir un mot de passe. Si cette option n'est pas utilisée et que l'utilisateur n'a pas exécuté la sous-commande pgtool login, l'administrateur est invité à saisir un nom d'utilisateur et un mot de passe.

Exemple : --username=“jdupont”.

Authentification via le nom d'utilisateur et le mot de passe

Un nom d'utilisateur et un mot de passe sont requis pour chaque exécution d'une commande.

Authentification au moyen de la commande de connexion

La CLI dispose d'une commande de connexion qui permet de stocker des paires nom d'utilisateur/mot de passe dans un fichier d'identification dans le répertoire personnel de l'administrateur. Ce fichier appelé .apocpass offre un droit d'accès limité.

Si l'authentification réussit, une entrée correspondant à la paire nom d'utilisateur/mot de passe est ajoutée au fichier .apocpass. La clé de cette paire se compose du serveur/port/DN de base et du nom d'utilisateur, ce qui permet de stocker des paires nom d'utilisateur/mot de passe pour d'autres moteurs de traitement au sein du même fichier.

Une fois que la commande de connexion a réussi, d'autres commandes CLI peuvent être exécutées sans qu'il soit nécessaire de spécifier un nom d'utilisateur ou un mot de passe.

Pour en savoir plus sur l'utilisation de la commande de connexion (login), reportez-vous à la section Se connecter (login).

Authentification pour les autres commandes

Pour les autres commandes, la CLI vérifie d'abord s'il existe un fichier .apocpass pour l'utilisateur actuel.

Dans le cas contraire, l'utilisateur est invité à saisir un nom d'utilisateur et un mot de passe. Si ce nom d'utilisateur et ce mot de passe sont correctement authentifiés, la commande est exécutée.

Si le fichier d'identification existe et qu'un nom d'utilisateur a été spécifié dans la ligne de commande, la CLI recherche une entrée pour cet hôte, ce port, ce DN de base et ce nom d'utilisateur. Si l'entrée existe, le DN et le mot de passe utilisateur stockés sont utilisés pour exécuter la commande. Sinon, l'utilisateur est invité à saisir un mot de passe.

Si aucun nom d'utilisateur n'est spécifié dans la ligne de commande, les clés utilisant l'association hôte/port et DN de base sont recherchées dans le fichier .apocpass. S'il existe une seule entrée pour cette association, le DN et le mot de passe utilisateur stockés sont utilisés pour exécuter la commande. Dans le cas contraire, l'utilisateur est invité à saisir un nom d'utilisateur. Si celui-ci correspond à une entrée, le DN et le mot de passe utilisateur stockés sont utilisés pour exécuter la commande. Dans le cas contraire, l'utilisateur est invité à saisir un mot de passe.

Lorsque l'utilisateur est invité à saisir un mot de passe, une entrée du fichier .apocpass correspondant à cette association hôte/port/DN de base est utilisée pour authentifier le nom d'utilisateur et le mot de passe. Si cette entrée n'existe pas, un accès anonyme est utilisé pour l'authentification.

Exécution d'une commande

Chaque utilisation d'une commande crée et initialise une connexion au magasin de données, puis l'interrompt une fois la commande exécutée. Si la commande se termine avec un code error, aucune modification n'est apportée aux profils de configuration.

Représentation des éléments

Un élément est représenté par son nom distinctif (DN) LDAP complet.

Exemple : uid=jdupont,ou=People,o=apoc.