6.2.9. help

Pour obtenir de l'aide concernant les commandes disponibles, il est possible de :

la préfixer par help (exemple help show config-files)
suffixer la commande par ? (exemple show config-files ?)

L'aide permet d'afficher les commandes disponibles et un descriptif de celle-ci dans le contexte courant.

6.2.9.1. Utilisation de `?`

La commande ? peut être utilisée :

seule : dans ce cas, il a la même fonction que la commande help
après la commande pour laquelle l'aide doit être affichée : suffixation

6.2.9.1.1. Prérequis pour `?`

Utilisateurs : setup, gviewadm, gview
Dépendances : N/A

6.2.9.1.2. Commande `?`

(gcap-cli) ? pour afficher la liste des commandes accessibles
(gcap-cli) show status ? pour afficher l'aide de la commande status de l'ensemble show

6.2.9.1.3. Utilisation de `?` de suffixation

Pour lister les fichiers de configurations accessibles via la CLI :

utiliser la commande show network suivi de ?

(gcap-cli) show network ?

Valider.
Le système affiche les informations suivantes:

(gcap-clInspect configurations
==================================

Available commands:
   - configuration: Show current network configuration in JSON format
   - tunnel: Show current configuration for tunnel interface
   - management: Show current configuration for management interface
   - hostname: Show current configuration for hostname
   - domain: Show current configuration for domain

6.2.9.2. Utilisation de `help`

La commande help peut être utilisée :

seule : dans ce cas, le système affiche les commandes accessibles dans le niveau actuel
avant la commande pour laquelle l'aide doit être affichée : préfixation
après la commande pour laquelle l'aide doit être affichée mais il faut saisir --help ou -h

6.2.9.2.1. Prérequis pour `help`

Utilisateurs : setup, gviewadm, gview
Dépendances : N/A

6.2.9.2.2. Commande `help`

(gcap-cli) help pour afficher la liste des commandes accessibles
(gcap-cli) show status --help pour afficher l'aide de la commande status de l'ensemble show
(gcap-cli) help show status pour afficher l'aide de la commande status de l'ensemble show

6.2.9.2.3. Utilisation de `help` seul

Entrer la commande suivante.
```
(gcap-cli) help
```

Valider.
Le système affiche les informations suivantes:

CLI entrypoint
==============

Available commands:
 - show: Show system configuration
 - set: Modify system configuration
 - services: Manage service
 - system: Handle system operations
 - monitoring-engine: Handle Monitoring Engine
 - help: Display command help message
 - colour: Handle colour support for current CLI session
 - exit: Exit configuration tool

6.2.9.2.4. Exemple de préfixation : afficher les commandes disponibles dans le contexte monitoring-engine depuis la racine de gcap-cli

Entrer la commande suivante.
```
(gcap-cli) help monitoring-engine
```

Valider.
Le système affiche les informations suivantes :

cas 1

   Available commands:
       - start: Start the Monitoring Engine
       - status: View current Monitoring Engine status

Dans ce cas, le moteur peut être démarré

ou

cas 2

Available commands:
   - status: View current Monitoring Engine status
 

Dans ce cas, les prérequis pour démarrer le moteur ne sont pas réunis.

6.2.9.2.5. Exemple de suffixation : afficher les informations d'une commande

Entrer la commande suivante.
```
(gcap-cli system) shutdown --help
```
Valider.
Le système affiche les informations suivantes:
```
Shutdown GCap
```

6.2.9. help

6.2.9.1. Utilisation de ?

6.2.9.1.1. Prérequis pour ?

6.2.9.1.2. Commande ?

6.2.9.1.3. Utilisation de ? de suffixation

6.2.9.2. Utilisation de help

6.2.9.2.1. Prérequis pour help

6.2.9.2.2. Commande help

6.2.9.2.3. Utilisation de help seul