Try SpotterRuns commands on devices running Enterprise SONiC
| "added in version" 1.0.0 of dellemc.enterprise_sonic"
Authors: Dhivya P (@dhivayp)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install dellemc.enterprise_sonic:==2.4.0
collections:
- name: dellemc.enterprise_sonic
version: 2.4.0Runs commands on remote devices running Enterprise SONiC Distribution by Dell Technologies. Sends arbitrary commands to an Enterprise SONiC node and returns the results that are read from the device. This module includes an argument that causes the module to wait for a specific condition before returning or time out if the condition is not met.
This module does not support running commands in configuration mode. To configure SONiC devices, use M(dellemc.enterprise_sonic.sonic_config).
- name: Runs show version on remote devices
dellemc.enterprise_sonic.sonic_command:
commands: show version
- name: Runs show version and checks to see if output contains 'Dell'
dellemc.enterprise_sonic.sonic_command:
commands: show version
wait_for: result[0] contains Dell
- name: Runs multiple commands on remote nodes
dellemc.enterprise_sonic.sonic_command:
commands:
- show version
- show interface
- name: Runs multiple commands and evaluate the output
dellemc.enterprise_sonic.sonic_command:
commands:
- 'show version'
- 'show system'
wait_for:
- result[0] contains Dell
- result[1] contains Hostname
- name: Runs commands that require answering a prompt
dellemc.enterprise_sonic.sonic_command:
commands:
- command: 'reload'
prompt: '[confirm yes/no]: ?$'
answer: 'no'
match:
choices:
- all
- any
default: all
description:
- The I(match) argument is used in conjunction with the I(wait_for) argument to specify
the match policy. Valid values are C(all) or C(any). If the value is set to C(all)
then all conditionals in the wait_for must be satisfied. If the value is set to
C(any) then only one of the values must be satisfied.
type: str
retries:
default: 10
description:
- Specifies the number of retries a command should be run before it is considered
failed. The command is run on the target device every retry and evaluated against
the I(wait_for) conditions.
type: int
commands:
description:
- List of commands to send to the remote Enterprise SONiC devices over the configured
provider. The resulting output from the command is returned. If the I(wait_for)
argument is provided, the module is not returned until the condition is satisfied
or the number of retries has expired. If a command sent to the device requires answering
a prompt, it is possible to pass a dict containing I(command), I(answer) and I(prompt).
Common answers are 'yes' or "\r" (carriage return, must be double quotes). See examples.
elements: str
required: true
type: list
interval:
default: 1
description:
- 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.
type: int
wait_for:
description:
- List of conditions to evaluate against the output of the command. The task waits
for each condition to be true before moving forward. If the conditional is not true
within the configured number of retries, the task fails. See examples.
elements: str
type: list
failed_conditions:
description: The list of conditionals that have failed.
returned: failed
sample:
- '...'
- '...'
type: list
stdout:
description: The set of responses from the commands.
returned: always apart from low level errors (such as action plugin)
sample:
- '...'
- '...'
type: list
stdout_lines:
description: The value of stdout split into a list.
returned: always apart from low level errors (such as action plugin)
sample:
- - '...'
- '...'
- - '...'
- - '...'
type: list
warnings:
description: The list of warnings (if any) generated by module based on arguments.
returned: always
sample:
- '...'
- '...'
type: list