9.1. Overview of the CLI

9.1.1. Introduction to the CLI

The Command Line Interface (CLI) is the means used to administer and configure the GCap.
It is therefore necessary to enter commands in text mode following the command prompt.
For the initial GCap configuration and to do advanced configurations or checks, it is necessary to use the CLI.
For most functions, the use of this interface is adequate.
The tables listed in the ../8-procedures/0-list_procedures_menu section enable a general overview of the most common actions.

9.1.2. Overview of the command prompt

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

It includes:

  • The status of the Sigflow detection engine (here `Monitoring down`)

  • The name of the GCap (here `gcap-name`)

  • The level information in the tree :

    • Here (`gcap-cli`): means the command prompt is at the root of the commands

    • For example (`gcap-cli show`): means the command prompt is in the `show` sub-group

9.1.3. Accessible commands grouped by sub-group

The commands are grouped by sub-group (show, set, etc.).
The detailed list of commands is provided in the CLI section.

The set...

is used to...

show

display the system configuration

set

modify the system configuration

system

manage system operations

These sets are accessible from the root.

Note

The set of commands in the GCap CLI is calculated dynamically.
The list of orders depends on:

  • du type d'utilisateur courant

  • The status of the GCap

This information can be found in the documentation.

Note

  • If a command is entered in the wrong set, or If the access level is not the correct one

  • If the access level is not the correct one

... then the command is not recognized and the message Command `X is not recognized` is displayed.

Note

User type or context elements are specified where necessary.

9.1.4. Directly accessible commands

The commands below are directly accessible:

Use the command...

For...

monitoring-engine

manage the detection engine

pairing

Pair the GCap and GCenter

unpair

Pair the GCap and GCenter

help

obtain help with the available commands

color

enable or disable colors for the current CLI session

exit

return to the root of the CLI or exit the CLI

9.1.5. Completion

To complete the name of a command or an argument, it is possible to use the completion, i.e. :

  • Start by entering a command, then

  • Use the tab key on the keyboard

The system proposes the possible values.
Example: by asking for a completion on the command below, the system displays the supported values of `set keymap`:
set keymap

fr us

9.1.7. Launching a command

A command can be launched in two different ways:

  • Either with only the command name but the command prompt must be at the set level

  • Or from the root but the name of the set must be entered followed by the name of the command

9.1.7.1. Example of launching from the root for the `show interfaces` command

(gcap-cli)

  1. Enter the `show interfaces` command then validate

9.1.7.2. Example of launching the `show interfaces` command from the `show` sub-group

(gcap-cli show)

  1. Enter the `interfaces` command then validate

9.1.8. Obtaining information on commands via Help

To receive help on the available commands, it is possible to use the `?` or `help` command.
To obtain help with a specific command, it is possible to:

  • Prefix it with `help` (example `help pairing`)

  • Suffix the command with `?` (example `pairing?`)

For more information on assistance, see the paragraph on help.

9.1.9. Exit

If the GCap interactive CLI is used, the `exit` command must be used to return to the root of the command tree.
For more information on the `exit` command, see the paragraph exit.