Try SpotterRun arbitrary command on Cisco NXOS devices
| "added in version" 1.0.0 of cisco.nxos"
Authors: Peter Sprygada (@privateip)
Install with ansible-galaxy collection install cisco.nxos:==7.0.0
collections:
- name: cisco.nxos
version: 7.0.0Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.
- name: run show version on remote devices
cisco.nxos.nxos_command:
commands: show version
- name: run show version and check to see if output contains Cisco
cisco.nxos.nxos_command:
commands: show version
wait_for: result[0] contains Cisco
- name: run multiple commands on remote nodes
cisco.nxos.nxos_command:
commands:
- show version
- show interfaces
- name: run multiple commands and evaluate the output
cisco.nxos.nxos_command:
commands:
- show version
- show interfaces
wait_for:
- result[0] contains Cisco
- result[1] contains loopback0
- name: run commands and specify the output format
cisco.nxos.nxos_command:
commands:
- command: show version
output: json
- name: run commands that require answering a prompt
cisco.nxos.nxos_command:
commands:
- configure terminal
- command: no feature npv
prompt: Do you want to continue
answer: y
match:
choices:
- any
- all
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 I(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: 9
description:
- Specifies the number of retries a command should by tried before it is considered
failed. The command is run on the target device every retry and evaluated against
the I(wait_for) conditionals.
- The commands are run once when I(retries) is set to C(0).
type: int
commands:
description:
- The commands to send to the remote NXOS device. 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 retires as expired.
- The I(commands) argument also accepts an alternative form that allows for complex
values that specify the command to run and the output format to return. This can
be done on a command by command basis. The complex argument supports the keywords
C(command) and C(output) where C(command) is the command to run and C(output) is
one of 'text' or 'json'.
- If a command sent to the device requires answering a prompt, it is possible to pass
a dict containing command, answer and prompt. Common answers are 'y' or "\r" (carriage
return, must be double quotes). See examples.
elements: raw
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 conditional, the interval indicates how to long
to wait before trying the command again.
type: int
wait_for:
aliases:
- waitfor
description:
- Specifies what to evaluate from the output of the command and what conditionals
to apply. This argument will cause the task to wait for a particular conditional
to be true before moving forward. If the conditional is not true by the configured
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