system-commands

Retrieves the list of query commands registered in the system along with detailed information for each command.

Command properties

Property	Description
Command type	Driver query
Required permission	None
License usage	Not counted
Parallel execution	Not supported
Distributed execution	Not supported

Syntax

system-commands

Options

None

Output fields

Field	Type	Description
name	string	Query command name
description	string	Query command description
options	map	Options available when running the query command. Includes each option's required flag, display name, and description.
outputs	map	Fields output when the query command is executed, along with their descriptions
usage	string	Usage examples for the query command
display_group	string	Group to which the query command belongs (Maestro, Sonar, Forensic, etc.)
display_name	string	Display name for the query command

Error codes

Parsing errors

N/A

Runtime errors

N/A

Description

The system-commands command retrieves the list of all query commands registered in the system along with detailed information for each command. Descriptions, options, and output field information are returned in the language of the session locale.

The options field returns, for each option, a map containing its required flag (required), display name (display_name), and description (description). The outputs field follows the same structure and returns information about each output field.

Examples

Retrieve all query commands
```
system-commands
```
Retrieves the names and detailed information of all query commands registered in the system.
Retrieve information about a specific command
```
system-commands | search name == "stats"
```
Retrieves the description, options, and output field information for the stats command.
Retrieve only Sonar commands
```
system-commands | search display_group == "Sonar"
```
Retrieves only the query commands that belong to the Sonar group.