community.network.icx_command – Run arbitrary commands on remote Ruckus ICX 7000 series switches
Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.icx_command
.
Synopsis
Sends arbitrary commands to an ICX 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.
Parameters
Parameter |
Comments |
---|---|
List of commands to send to the remote ICX 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 has expired. If a command sent to the device requires answering a prompt, checkall and newline if multiple prompts, it is possible to pass a dict containing command, answer, prompt, check_all and newline.Common answers are ‘y’ or “r” (carriage return, must be double quotes). See examples. |
|
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. Default: 1 |
|
The match argument is used in conjunction with the wait_for argument to specify the match policy. Valid values are Choices:
|
|
Specifies the number of times a command should by tried before it is considered failed. The command is run on the target device every retry and evaluated against the wait_for conditions. Default: 10 |
|
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. See examples. |
Examples
tasks:
- name: Run show version on remote devices
community.network.icx_command:
commands: show version
- name: Run show version and check to see if output contains ICX
community.network.icx_command:
commands: show version
wait_for: result[0] contains ICX
- name: Run multiple commands on remote nodes
community.network.icx_command:
commands:
- show version
- show interfaces
- name: Run multiple commands and evaluate the output
community.network.icx_command:
commands:
- show version
- show interfaces
wait_for:
- result[0] contains ICX
- result[1] contains GigabitEthernet1/1/1
- name: Run commands that require answering a prompt
community.network.icx_command:
commands:
- command: 'service password-encryption sha1'
prompt: 'Warning: Moving to higher password-encryption type,.*'
answer: 'y'
- name: Run commands that require answering multiple prompt
community.network.icx_command:
commands:
- command: 'username qqq password qqq'
prompt:
- 'User already exists. Do you want to modify:.*'
- 'To modify or remove user, enter current password:'
answer:
- 'y'
- 'qqq\
'
check_all: True
newline: False
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of conditionals that have failed Returned: failed Sample: [“…”, “…”] |
|
The set of responses from the commands Returned: always apart from low level errors Sample: [“…”, “…”] |
|
The value of stdout split into a list Returned: always apart from low level errors Sample: [[“…”, “…”], [“…”], [“…”]] |
Authors
Ruckus Wireless (@Commscope)