community.network.enos_command – Run arbitrary commands on Lenovo ENOS devices
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.enos_command
.
Synopsis
Sends arbitrary commands to an ENOS node and returns the results read from the device. The
enos_command
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 |
---|---|
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 |
|
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 Choices:
|
|
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 retires as expired. |
|
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:
|
|
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 |
|
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 Choices:
|
|
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 |
|
Specifies the port to use when building the connection to the remote device. Default: 22 |
|
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 |
|
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. Default: 10 |
|
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 |
|
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 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
# Note: examples below use the following provider dict to handle
# transport and authentication to the node.
---
vars:
cli:
host: "{{ inventory_hostname }}"
port: 22
username: admin
password: admin
timeout: 30
---
- name: Test contains operator
community.network.enos_command:
commands:
- show version
- show system memory
wait_for:
- "result[0] contains 'Lenovo'"
- "result[1] contains 'MemFree'"
provider: "{{ cli }}"
register: result
- ansible.builtin.assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- name: Get output for single command
community.network.enos_command:
commands: ['show version']
provider: "{{ cli }}"
register: result
- ansible.builtin.assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- name: Get output for multiple commands
community.network.enos_command:
commands:
- show version
- show interface information
provider: "{{ cli }}"
register: result
- ansible.builtin.assert:
that:
- "result.changed == false"
- "result.stdout is defined"
- "result.stdout | length == 2"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
the conditionals that failed Returned: failed Sample: [“…”, “…”] |
|
the set of responses from the commands Returned: always Sample: [“…”, “…”] |
|
The value of stdout split into a list Returned: always Sample: [[“…”, “…”], [“…”], [“…”]] |
Authors
Anil Kumar Muraleedharan (@amuraleedhar)