Defining Command Templates

Command Templates contain sets of commands with associated rules, including flags to define rules logic.

Global Command Pass

At the top of the template is a dropdown menu (All Commands must pass/ One Command must pass) that works the same as setting the individual pass flags on each command, except on a global level.

• All commands must pass (default behavior): Pass for every rule in every command.
• All commands must pass (warn/info as pass checked): Zero errors errors present in the template.
• One command must pass (default behavior): Pass for all rules in ONE (or more) commands.
• One command must pass (warn/info as pass checked): One command with zero errors must be present in the template.

There is also a pass checkbox (optional) to ignore failures due to warning or info severity levels. The default for the global pass checkbox is "off'.

Rules

The following options are available in the Rules dropdown for all Command Templates. For more information, see the sections on Command Template Variables and Defining Command Template Rules below.

Flags

Every command may have one or more rules which are bound by a boolean Flag called a "pass flag".

• When a pass flag is set to true (on), the logic between the rules is "AND". This means all rules must pass in order for the command to pass.
• When a pass flag is set to false (off), the logic is "OR". This means that only one rule has to pass for the command to pass.

The following flags are supported.

Of note, the contains option only has one flag option: i.

The RegEx and comparison options have all three flag options: i, g, and m.

Severity

A Severity field is available for each rule. The severity only applies to a rule after it has failed. The default severity is error.

Global Rules Pass

For each command there is a dropdown (All Rules must pass/ One Rule must pass) that works the same as setting rules on each command, except on a global level.

• All Rules must pass: Pass for every rule in a command.
• One Rule must pass: Pass for one rule (or more) in a command.

Command Template Variables

When defining Command Templates, variables may be used in the commands with the following syntax:

<!VARIABLE!>

The following variable types can be used when defining commands:

• string
• number
• boolean
• array of strings
• array of numbers
• array of booleans

When arrays of simple types are passed into the execution engine, the command will be executed one time for each element in the array. Complex variable structures such as arrays of complex objects are not currently supported.

Defining Command Template Rules

The contains and RegEx operators search for command output matching (or not matching) a given string or regular expression. The #comparison operator evaluates the values in returned data.

Top Comparison Operands

• Uses a regular expression with a capture group to select data in the output of a command. The regular expression must be surrounded with slash (/) characters.
• The expression serves two functions: it identifies the command output location (where we will find the top comparison operand value) and returns the comparison operand value.
• Capture groups are created by surrounding the relevant part of the regular expression with round brackets or parentheses. A single capture group is supported.

Bottom Comparison Operands

• Will specify a static value, a passed MOP command template variable, or a second regular expression and capture group matching part of the command's output.

Comparison Operators

Comparison operators compare values and return true or false.