Commands

Commands are executed on the devices and then respective command output is saved. This output can later be serialized and used in compliance tests. One Command can belong to one or more Pollers (binding is performed through Poller form).

Fields

Name

The Name of the Command. Must be unique.

Label

Slug-like label of the Command. Value must follow the rules: * contain only ASCII letters, numbers and underscores * start with a letter

Label value is used to access serialized command output in Compliance Test. E.g. test expression device.state.sh_version implies there is a Command with label sh_version.

Type

Type of the command. It defines other parameters that must be filled for this command. Command of one specific type can be bound only to the Poller with the matching Connection Type.

Command Type	Matching Poller Type
CLI	netmiko
NETCONF	scrapli_netconf
JSON_API	requests

Retrieves configuration

Defines either this command is supposed to retrieve device configuration or no. For each poller there can be at most one command which retrieves configuration.

Note

Serialized state for command which retrieves configuration is always available through "config" key. Let's suppose we have a command with label show_run which has retrieves_config=True, then inside Compliance Test the serialized output of this command will be available through both device.state.show_run and device.config.

Serializer

This field defines Serializer for Command output.

Parameters

This block contains type-specific parameters.

Type:CLI

CLI Command

This field must contain text string which is going to be sent to device when polling occurs.

Type:NETCONF

RPC

This field must contain an XML RPC which is going to be sent to device via Netconf.

Example:

<get-config>
  <source>
    <running/>
  </source>
</get-config>

TYPE: JSON API

This option supports both REST API and various JSON-based APIs which do not follow REST

Method

HTTP method used for polling. Get by default.

URL Path

Path part of the URL. Will be appended (via Jinja2 expression) to hostname part defined in Poller credentials Example: /rest/ip/address/

Body

Request body is optional. It may be useful for various JSON-based APIs which do not follow REST and may use POST or other queries for information retrieving. You can use Jinja2 expressions as values in body dictionary. Available context variables are device and command. Example:

{
  "data": {
    "commamnd": "get-config",
    "device": "{{ device.name }}"
  }
}