9.3.8. help

9.3.8.1. Introduction

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

  • la préfixer par `help` (exemple `help show status`)

  • suffixer la commande par `?` (exemple `show status ?`)

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

9.3.8.2. Commande `?`

A - Prérequis pour `?`

  • Utilisateur : setup, gviewadm, gview

  • Dépendances : N/A

B - Commande `?`

  • `?` pour afficher la liste des commandes accessibles

  • `show status ?` pour afficher l’aide de la commande `status` de l’ensemble `show`

C - 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

D - Utilisation de `?` en suffixation

Pour lister les fichiers de configurations accessibles via la CLI :

L’invite de commande est affichée.

(gcap-cli)

  1. utiliser la commande `show network` suivi de `?`

    show network ?
  2. Valider
    Le système affiche les informations suivantes
    Show current network configuration
==================================

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

9.3.8.3. Commande `help`

A - Prérequis pour `help`

  • Utilisateur : setup, gviewadm, gview

  • Dépendances : N/A

B - Commande `help`

  • `help` pour afficher la liste des commandes accessibles

  • `show status --help` pour afficher l’aide de la commande `status` de l’ensemble `show`

  • `help show status` pour afficher l’aide de la commande `status` de l’ensemble `show`

C - Utilisation de la commande `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`

D - Utilisation de `help` seul

L’invite de commande est affichée.

(gcap-cli)

  1. Saisir la commande

    help
  2. 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

E - Procédure de préfixation : afficher les commandes disponibles dans le contexte monitoring-engine depuis la racine de gcap-cli

L’invite de commande est affichée.

(gcap-cli)

  1. Saisir la commande

    help monitoring-engine
  2. 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.

E - Procédure de suffixation : afficher les informations d’une commande

  1. Saisir la commande

    (gcap-cli system) shutdown --help
  2. Valider
    Le système affiche les informations suivantes
    Shutdown GCap