when interfaces are configured

All IPv4 addresses configured on the device

when interfaces are configured

All IPv6 addresses configured on the device

when config is configured

The current active config from the device

always

The list of fact subsets collected from the device

always

The configured hostname of the device

always

The image file the device is running

when interfaces are configured

A hash of all interfaces running on the system

when hardware is configured

The available free memory on the remote device in Mb

when hardware is configured

The total memory on the remote device in Mb

always

The model name returned from the device

when interfaces is configured

The list of LLDP neighbors from the remote device

always

The serial number of the remote device

always

The operating system version running on the remote device

 

The answer to reply with if prompt is matched. The value can be a single answer or a list of answer for multiple prompts. In case the command execution results in multiple prompts the sequence of the prompt and excepted answer should be in same order.

Choices:

By default if any one of the prompts mentioned in prompt option is matched it won't check for other prompts. This boolean flag, that when set to True will check for all the prompts mentioned in prompt option in the given order. If the option is set to True all the prompts should be received from remote host if not it will result in timeout.

 

The command to send to the remote network device. The resulting output from the command is returned, unless send only is set.

Choices:

The boolean value, that when set to false will send answer to the device without a trailing newline.

 

A single regex pattern or a sequence of patterns to evaluate the expected prompt from command.

Choices:

The boolean value, that when set to true will send command to the device but not wait for a result.

stdout

string

when sendonly is false

The response from the command.

 

Sample:

Software version: DELL_S6000-ON-OcNOS-1.3.8.44a-DC_IPBASE-S0-P0 [...]

 

List of commands to send to the remote device over the configured provider. The resulting output from the command is returned. If the wait_for argument is provided, the module is not returned until the condition is satisfied or the number of retries as expired.

Default:

1

Configures the interval in seconds to wait between retries of the command. If the command does not pass the specified conditions, the interval indicates how long to wait before trying the command again.

Choices:

The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are all or any. If the value is set to all then all conditionals in the wait_for must be satisfied. If the value is set to any then only one of the values must be satisfied.

 

A dict object containing connection details.

Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.

Choices:

Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.

Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.

 

Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.

Default:

22

Specifies the port to use when building the connection to the remote device.

 

Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.

Default:

10

Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.

 

Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.

Default:

10

Specifies the number of retries a command should be tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditions.

 

List of conditions to evaluate against the output of the command. The task will wait for each condition to be true before moving forward. If the conditional is not true within the configured number of retries, the task fails.

always

the set of responses from the commands.

always

The value of stdout split into a list

Choices:

This argument will cause the module to create a full backup of the current running config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.

 

This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to yes, if backup is set to no this option will be silently ignored.

 

This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.

 

The filename to be used to store the backup configuration. If the the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>

 

The config to be pushed to the network device. This argument is mutually exclusive with rollback and either one of the option should be given as input. The config should have indentation that the device uses.

when backup is yes

The full path to the backup file

 

Sample:

always

The set of commands that will be pushed to the remote device

 

Sample:

 

The ordered set of commands to append to the end of the command stack if a change needs to be made. Just like with before this allows the playbook designer to append a set of commands to be executed after the command set.

Choices:

This argument will cause the module to create a full backup of the current running-config from the remote device before any changes are made. If the backup_options value is not given, the backup file is written to the backup folder in the playbook root directory or role root directory, if playbook is part of an ansible role. If the directory does not exist, it is created.

 

This is a dict object containing configurable options related to backup file path. The value of this option is read only when backup is set to yes, if backup is set to no this option will be silently ignored.

This option provides the path ending with directory name in which the backup configuration file will be stored. If the directory does not exist it will be first created and the filename is either the value of filename or default filename as described in filename options description. If the path value is not given in that case a backup directory will be created in the current working directory and backup configuration will be copied in filename within backup directory.

 

The filename to be used to store the backup configuration. If the the filename is not given it will be generated based on the hostname, current time and date in format defined by <hostname>_config.<current-date>@<current-time>

 

The ordered set of commands to push on to the command stack if a change needs to be made. This allows the playbook designer the opportunity to perform configuration commands prior to pushing any changes without affecting how the set of commands are matched against the system.

 

Use this argument to specify one or more lines that should be ignored during the diff. This is used for lines in the configuration that are automatically updated by the system. This argument takes a list of regular expressions or exact line matches.

 

The ordered set of commands that should be configured in the section. The commands must be the exact same commands as found in the device running-config. Be sure to note the configuration command syntax as some commands are automatically modified by the device config parser.

 

aliases: commands

Choices:

Instructs the module on the way to perform the matching of the set of commands against the current device config. If match is set to line, commands are matched line by line. If match is set to strict, command lines are matched with respect to position. If match is set to exact, command lines must be an equal match. Finally, if match is set to none, the module will not attempt to compare the source configuration with the running configuration on the remote device.

 

The ordered set of parents that uniquely identify the section or hierarchy the commands should be checked against. If the parents argument is omitted, the commands are checked against the set of top level or global commands.

Choices:

Instructs the module on the way to perform the configuration on the device. If the replace argument is set to line then the modified lines are pushed to the device in configuration mode. If the replace argument is set to block then the entire command block is pushed to the device in configuration mode if any line is not correct.

 

The module, by default, will connect to the remote device and retrieve the current running-config to use as a base for comparing against the contents of source. There are times when it is not desirable to have the task get the current running-config for every task in a playbook. The running_config argument allows the implementer to pass in the configuration to use as the base config for this module.

 

aliases: config

Choices:

When changes are made to the device running-configuration, the changes are not copied to non-volatile storage by default. Using this argument will change that before. If the argument is set to always, then the running-config will always be copied to the startup-config and the modified flag will always be set to True. If the argument is set to modified, then the running-config will only be copied to the startup-config if it has changed since the last save to startup-config. If the argument is set to never, the running-config will never be copied to the startup-config. If the argument is set to changed, then the running-config will only be copied to the startup-config if the task has made a change.

 

The src argument provides a path to the configuration file to load into the remote system. The path can either be a full system path to the configuration file if the value starts with / or relative to the root of the implemented role or playbook. This argument is mutually exclusive with the lines and parents arguments. It can be a Jinja2 template as well. The src file must have same indentation as a live switch config.

backup_path

string

When backup is yes

The full path to the backup file

 

Sample:

/home/somewhere/ansible/backup/OcNOS-SW1_config.2020-03-17@05:33:06

commands

list

Always

The set of commands that will be pushed to the remote device.

 

Sample:

['hostname OcNOS-SW1-20']

date

string

When backup is yes

The date extracted from the backup file name

 

Sample:

2020-03-17

filename

string

When backup is yes and filename is not specified in backup options

The name of the backup file

 

Sample:

OcNOS-SW1_config.2020-03-17@05:33:06

shortname

string

When backup is yes and filename is not specified in backup options

The full path to the backup file excluding the timestamp

 

Sample:

/home/somewhere/ansible/backup/OcNOS-SW1_config

time

string

when backup is yes

The time extracted from the backup file name

 

Sample:

05:33:06

count

-

Default: 5

Number of packets to send.

dest

/ required

 

The IP Address or hostname (resolvable by switch) of the remote node.

state

-

Choices:
absent
present (default)

Determines if the expected result is success or fail.

vrf

-

Default: "management"

The VRF to use for forwarding.

commands

list

always

Show the command sent.

Sample:

['ping\nip\n \n192.168.122.1\n3\n64\n1\n100\n2\n0\nn\nn\n']

packet_loss

string

always

Percentage of packets lost.

Sample:

0%

packets_rx

integer

always

Packets successfully received.

Sample:

3

packets_tx

integer

always

Packets successfully transmitted.

Sample:

3

rtt

dictionary

always

Show RTT stats.

Sample:

{"avg": 0.115, "max": 0.135, "min": 0.079}