community.network.eric_eccli_command module – Run commands on remote devices running ERICSSON ECCLI
Note
This module is part of the community.network collection (version 5.0.3).
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.eric_eccli_command
.
Synopsis
Sends arbitrary commands to an ERICSSON eccli 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.
This module also support running commands in configuration mode in raw command style.
Aliases: network.eric_eccli.eric_eccli_command
Parameters
Parameter |
Comments |
---|---|
List of commands to send to the remote ECCLI 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, 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. |
|
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: |
|
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 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: |
|
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. |
Notes
Note
Tested against IPOS 19.3
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Ericsson devices see the Ericsson documents.
Starting with Ansible 2.5 we recommend using
connection: network_cli
.For more information please see the ERIC_ECCLI Platform Options guide.
Examples
tasks:
- name: Run show version on remote devices
community.network.eric_eccli_command:
commands: show version
- name: Run show version and check to see if output contains IPOS
community.network.eric_eccli_command:
commands: show version
wait_for: result[0] contains IPOS
- name: Run multiple commands on remote nodes
community.network.eric_eccli_command:
commands:
- show version
- show running-config interfaces
- name: Run multiple commands and evaluate the output
community.network.eric_eccli_command:
commands:
- show version
- show running-config interfaces
wait_for:
- result[0] contains IPOS
- result[1] contains management
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 (such as action plugin) Sample: |
|
The value of stdout split into a list Returned: always apart from low level errors (such as action plugin) Sample: |