6.1. Présentation de la CLI

6.1.1. Introduction à la CLI

La CLI (Command Line Interface) est le moyen utilisé pour administrer et configurer le GCap.

Il est donc nécessaire de saisir des commandes en mode texte à la suite de l'invite de commande.

6.1.2. Présentation de l'invite de commande

[Monitoring DOWN] gcap-name (gcap-cli)

Elle comprend :

  • l'état du moteur de détection Sigflow (ici Monitoring down)

  • le nom du GCap (ici gcap-name)

  • l'information du niveau dans l'arborescence :

    • ici (gcap-cli) : signifie l'invite de commande est à la racine des commandes

    • par exemple (gcap-cli show) : signifie l'invite de commande est dans l'ensemble show

6.1.3. Commandes accessibles groupées par ensemble

Les commandes sont regroupées par ensemble (show, set...).

La liste détaillée des commandes est donnée dans la partie CLI.

L'ensemble...

sert à...

show

afficher la configuration du système

set

modifier la configuration du système

services

gérer les services du GCap

system

gérer les opérations du système

Ces ensembles sont accessibles depuis la racine.

Note

L'ensemble des commandes de la CLI du GCap est calculé dynamiquement.

La liste des commandes dépend :

  • du type d'utilisateur courant

  • de l'état du GCap

Ces informations sont indiquées dans la documentation.

Note

  • si une commande est saisie dans un ensemble qui n'est pas le bon ou

  • si le niveau d'accès n'est pas le bon

... alors la commande n'est pas reconnue et le message `Command `X` is not recognized ` est affiché.

Note

Le type d'utilisateur ou les éléments de contexte sont précisés lorsque cela est nécessaire.

6.1.4. Commandes accessibles directement

Les commandes ci-dessous sont accessibles directement :

Utiliser la commande...

pour...

monitoring engine

gérer le moteur de détection

pairing

appairer le GCap et le GCenter

help

obtenir de l'aide concernant les commandes disponibles

colour

activer ou désactiver les couleurs pour la session CLI courante

exit

revenir à la racine de la CLI ou de sortir de la CLI

6.1.5. Complétion

Pour compléter le nom d'une commande ou d'un argument, il est possible d'utiliser la complétion c'est à dire :

  • commencer par saisir une commande puis

  • utiliser la touche tabulation du clavier

Le système propose les valeurs possibles.

Exemple : en demandant une complétion sur la commande ci-dessous, le système affiche les valeurs de set keymap supportées:

(gcap-cli) set keymap

fr us

6.1.7. Lancement d'une commande

Une commande peut être lancée de deux façons différentes :

  • soit avec seulement le nom de la commande mais l'invite de commande doit être au niveau de l'ensemble

  • soit depuis la racine mais il faut saisir le nom de l'ensemble suivi du nom de la commande

6.1.7.1. Exemple de lancement depuis la racine pour la commande show alerts

(gcap-cli)

  • Entrer la commande show alerts puis valider.

6.1.7.2. Exemple de lancement de la commande show alerts depuis l'ensemble show

(gcap-cli show)

  • Entrer la commande alerts puis valider.

6.1.8. Avoir des informations sur les commandes via l'Aide

Pour obtenir de l'aide concernant les commandes disponibles, il est possible d'utiliser la commande par ? ou help.

Pour obtenir de l'aide concernant une commande spécifique, il est possible :

  • la préfixer par help (exemple help show config-files)

  • de suffixer la commande par ? (exemple show config-files ?)

Pour plus d'information sur l'aide, se référer au paragraphe help.

6.1.9. Exit

Lorsque la CLI interactive du GCap est utilisée, il faut utiliser la commande exit pour revenir à la racine de l'arborescence des commandes.

Pour plus d'information sur la commande exit, se référer au paragraphe exit.