Back to the list of classes

Studio Command Line

PATROL Class: X_COMMANDLINE - Monitor Type: MONITOR - Monitor Category: Application
No CDM Class defined.

This Monitor executes a command or script on the monitored host and monitors its result.

The output of the specified command can be parsed with String Searches, Numeric Value Extractions, Value Maps, Text Pre-Processing or Dynamic Object Builders.

Attributes (Parameters)

Name PATROL Name Units Default Thresholds Description
Execution Time ExecutionTime seconds

 WARN
if ≥ 30 seconds

Time taken by the command to run.

Note: Deactivated for never-ending commands.

Value set by commandLineColl.

Type:  KPI - Response Time - Spikes expected - Default graph

Exit Code ExitCode None None

Exit code returned by the executed command.

Note: Deactivated for never-ending commands and commands for which no exit code is specified or when the exit code is ignored.

Value set by commandLineColl.

Type: Statistics

Result Result None None

Return output of the command.

Value set by commandLineColl.

Type: Text

Status Status 0 = OK
1 = Suspicious
2 = Failed

 WARN
if = 1 (Suspicious)

 ALARM
if = 2 (Failed)

Status of the execution.

Value set by commandLineColl.

Type: Availability - Default graph

Infoboxes (PATROL Console Only)

Name Description
ID PATROL internal identifier of the Command Line instance.
Parent ID PATROL internal identifier of the parent object.
Command Line Command line provided to the OS for execution.
Command Type Indicates whether the command line is performed locally or remotely.
Timeout Maximum time allowed for the Command Line execution.
Username Username configured for the Command Line execution.
Menu Command Description
Refresh Parameters Re-executes the command line and refreshes all parameters. All related Monitor instances and parameters will be refreshed as well.