9.3.8. help

9.3.8.1. Introduction

To obtain help with the available commands, it is possible to:

  • Prefix it with `help` (example `help show status`)

  • Suffix the command with `?` (example `show status ?`)

Help enables displaying the available commands and a description of the command in the current context.

9.3.8.2. Command `?

A - Prerequisites for `?`

  • User: setup, gviewadm, gview

  • Dependencies: N/A

B - Command `?`

  • `?` to display the list of available commands

  • `show status ?` to display the help for the `status` command of the `show` sub-group

C - Using of `?`

The `?` command can be used :

  • Alone : in this case, it has the same function as the `help` command

  • After the command for which help is to be displayed : suffixing

D - Using the `?` of suffixing

To list the configuration files accessible via the CLI:

The command prompt is displayed.

(gcap-cli)

  1. Use the `show network` command followed by `?`

    show network ?
  2. Validate
    The system displays the following information
    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. Command `help`

A - Prerequisites for `help`

  • User: setup, gviewadm, gview

  • Dependencies: N/A

B - Command `help`

  • `help` to display the list of available commands

  • `show status --help` to display the help for the `status` command of the `show` sub-group

  • `help show status` to display the help for the `status` command of the `show` sub-group

C - Using the `help` command

The `help` command can be used:

  • Alone: in this case, the system displays the commands available in the current level

  • Before the command for which the help is to be displayed: prefixing

  • After the command for which the help is to be displayed, but `--help` or `-h` must be entered

D - Using `help` alone

The command prompt is displayed.

(gcap-cli)

  1. Enter the command

    help
  2. Validate
    The system displays the following information
    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 - Procedure of prefixing: display the commands available in the monitoring-engine context from the root of gcap-cli

The command prompt is displayed.

(gcap-cli)

  1. Enter the command

    help monitoring-engine
  2. Validate
    The system displays the following information

    • case 1

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

    In this case, the engine can be started.

or

  • case 2

    Available commands:
 - status: View current Monitoring Engine status

    In this case, the prerequisites to start the engine are not met.

E - Procedure of suffixing : displaying the information of a command

  1. Enter the command

    (gcap-cli system) shutdown --help
  2. Validate
    The system displays the following information
    Shutdown GCap