6.2.8. help
To obtain help with the available commands, it is possible to:
prefix it with
help
(examplehelp show config-files
)suffix the command with
?
(exampleshow config-files ?
)
Help enables displaying the available commands and a description of the command in the current context.
6.2.8.1. Use of ?
The ?
command can be used:
Alone: in this case, it has the same function as the
help
commandAfter the command for which help is to be displayed: suffixing
6.2.8.1.1. Prerequisites for ?
Users: setup, gviewadm, gview
Dependencies: N/A
6.2.8.1.2. Command ?
(gcap-cli) ?
to display the list of available commands(gcap-cli) show status ?
to display the help for thestatus
command of theshow
set
6.2.8.1.3. Using the ?
of suffixing
To list the configuration files accessible via the CLI:
use the
show config-files
command followed by?
(gcap-cli) show config-files ?
Validate
The system displays the following information:
(gcap-clInspect configurations
======================
Available commands:
- Sigflow-config: View detection engine configuration
- rules-scirius: View user-defined detection ruleset
- rules-files: View file-related detection ruleset
- threshold: View threshold configuration files
6.2.8.2. Use of help
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
6.2.8.2.1. Prerequisites for help
Users: setup, gviewadm, gview
Dependencies: N/A
6.2.8.2.2. Command help
(gcap-cli) help
to display the list of available commands(gcap-cli) show status --help
to display the help for the commandstatus
of the setshow
(gcap-cli) help show status
to display the help for the commandstatus
of the setshow
6.2.8.2.3. Using help
alone
Enter the following command.
(gcap-cli) help
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 - gui: Start a graphical session (deprecated) - exit: Exit configuration tool
6.2.8.2.4. Example of prefixing: display the commands available in the monitoring-engine context from the root of gcap-cli
Enter the following command.
(gcap-cli) help monitoring-engine
Validate.
The system displays the following information:
Available commands: - start: Start the Monitoring Engine - status: View current Monitoring Engine status
6.2.8.2.5. Example of suffixing: displaying the information of a command
Enter the following command.
(gcap-cli system) shutdown --help
Validate.
The system displays the following information:
Shutdown GCap