Analytic templates

Analytic templates evaluate pairs of command responses — labeled Pre and Post — against a set of rules. Unlike command templates, they do not run commands on devices at execution time. Instead, they consume responses already collected at earlier stages of the automation and compare the Pre and Post outputs against each other.

See Command templates for information on how Pre and Post responses are collected.

Prerequisites

A working NSO instance with at least one device using a live-status capable NED. Netsim devices may not work.
The itential_tools NSO package pre-loaded.

Create an analytic template

Open Studio

Click Studio in the left nav.

Open the Create dialog

Click the + icon in the top toolbar.

Select analytic template

Select Analytic Template from the dropdown.

Name and create

Enter a name and click Create.

Define an analytic template

Analytic Template form with labeled UI elements

Label	Action
1	Select a device from the Device Name dropdown, or use the magnifying glass to search.
2	Set the global command pass logic using the dropdown. See Global command pass.
3	Select a command template in the Pre Template and Post Template dropdowns.
4	Set the command pair (Pre and Post Command) to test against the device.
5	Select a rule type and severity level.
6	Click + Rule to add a rule to the command.
7	Set the global rules pass logic using the dropdown. See Global rules pass.
8	Click Test Run to test the command. Passed rules are marked with a green check; failed rules with a red minus. The device response appears at the bottom of the screen.
9	Click + Command Pair to add a command to the template.

Global command pass

Controls pass logic at the template level.

Global command pass dropdown

Option	Behavior
All commands must pass (default)	Every rule in every command must pass.
All commands must pass (warn/info as pass)	No errors may be present in the template.
One command must pass (default)	All rules in at least one command must pass.
One command must pass (warn/info as pass)	At least one command with no errors must be present.

Rules

Rule	Description
`regex`	Extracts values using capture groups and compares them using a regex operator.
`table`	Extracts keys and values from a table dataset and checks that all keys and values match. Useful when row order may change.
`matches`	Compares the Pre and Post responses in full. Passes when the responses are equivalent. An optional ignore pattern can exclude parts of the response from comparison.
`!matches`	Compares the Pre and Post responses in full. Passes when the responses differ. An optional ignore pattern can exclude parts of the response from comparison.

Regex operators

Operator	Description
`=`	`true` if the Pre and Post values are equal.
`!=`	`true` if the Pre and Post values are not equal.
`<=`	`true` if the Pre value is less than or equal to the Post value.
`<`	`true` if the Pre value is less than the Post value.
`>=`	`true` if the Pre value is greater than or equal to the Post value.
`>`	`true` if the Pre value is greater than the Post value.
`%`	Calculates `100 × (Post / Pre)` and returns `true` if the result is greater than or equal to the threshold entered in the Post/Pre % field.

Severity

Severity applies only when a rule has failed. The default is error.

Severity options

Level	Meaning
`error`	Something is wrong; a specific action may need to be taken.
`warning`	Something to be aware of that could potentially cause a problem.
`info`	Informational; no action required.

Flags

Flags apply to matches and !matches rules. Each command may have one or more rules bound by a boolean pass flag:

Pass flag true (on) — AND logic: all rules must pass.
Pass flag false (off) — OR logic: at least one rule must pass.

Flag	Description
`i`	Case-insensitive matching.
`g`	Global search; retains the index of the last match for iterative searches.
`m`	Multi-line; `^` and `$` match the start and end of each line.

Global rules pass

Controls pass logic at the command level.

Option	Behavior
All Rules must pass	Every rule in the command must pass.
One Rule must pass	At least one rule in the command must pass.

Flag options and global rules pass dropdown

See Command templates for information on how Pre and Post responses are collected.

Prerequisites

A working NSO instance with at least one device using a live-status capable NED. Netsim devices may not work.
The itential_tools NSO package pre-loaded.

Create an analytic template

Open Studio

Click Studio in the left nav.

Open the Create dialog

Click the + icon in the top toolbar.

Select analytic template

Select Analytic Template from the dropdown.

Name and create

Enter a name and click Create.

Define an analytic template

Label	Action
1	Select a device from the Device Name dropdown, or use the magnifying glass to search.
2	Set the global command pass logic using the dropdown. See Global command pass.
3	Select a command template in the Pre Template and Post Template dropdowns.
4	Set the command pair (Pre and Post Command) to test against the device.
5	Select a rule type and severity level.
6	Click + Rule to add a rule to the command.
7	Set the global rules pass logic using the dropdown. See Global rules pass.
8	Click Test Run to test the command. Passed rules are marked with a green check; failed rules with a red minus. The device response appears at the bottom of the screen.
9	Click + Command Pair to add a command to the template.

Global command pass

Controls pass logic at the template level.

Global command pass dropdown

Option	Behavior
All commands must pass (default)	Every rule in every command must pass.
All commands must pass (warn/info as pass)	No errors may be present in the template.
One command must pass (default)	All rules in at least one command must pass.
One command must pass (warn/info as pass)	At least one command with no errors must be present.

Rules

Rule	Description
`regex`	Extracts values using capture groups and compares them using a regex operator.
`table`	Extracts keys and values from a table dataset and checks that all keys and values match. Useful when row order may change.
`matches`	Compares the Pre and Post responses in full. Passes when the responses are equivalent. An optional ignore pattern can exclude parts of the response from comparison.
`!matches`	Compares the Pre and Post responses in full. Passes when the responses differ. An optional ignore pattern can exclude parts of the response from comparison.

Regex operators

Operator	Description
`=`	`true` if the Pre and Post values are equal.
`!=`	`true` if the Pre and Post values are not equal.
`<=`	`true` if the Pre value is less than or equal to the Post value.
`<`	`true` if the Pre value is less than the Post value.
`>=`	`true` if the Pre value is greater than or equal to the Post value.
`>`	`true` if the Pre value is greater than the Post value.
`%`	Calculates `100 × (Post / Pre)` and returns `true` if the result is greater than or equal to the threshold entered in the Post/Pre % field.

Severity

Severity applies only when a rule has failed. The default is error.

Severity options

Level	Meaning
`error`	Something is wrong; a specific action may need to be taken.
`warning`	Something to be aware of that could potentially cause a problem.
`info`	Informational; no action required.

Flags

Flags apply to matches and !matches rules. Each command may have one or more rules bound by a boolean pass flag:

Pass flag true (on) — AND logic: all rules must pass.
Pass flag false (off) — OR logic: at least one rule must pass.

Flag	Description
`i`	Case-insensitive matching.
`g`	Global search; retains the index of the last match for iterative searches.
`m`	Multi-line; `^` and `$` match the start and end of each line.

Global rules pass

Controls pass logic at the command level.

Option	Behavior
All Rules must pass	Every rule in the command must pass.
One Rule must pass	At least one rule in the command must pass.