community.network.edgeos_command module – Run one or more commands on EdgeOS devices
Note
This module is part of the community.network collection (version 5.1.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.edgeos_command
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
This command module allows running one or more commands on a remote device running EdgeOS, such as the Ubiquiti EdgeRouter.
This module does not support running commands in configuration mode.
Certain
show
commands in EdgeOS produce many lines of output and use a custom pager that can cause this module to hang. If the value of the environment variableANSIBLE_EDGEOS_TERMINAL_LENGTH
is not set, the default number of 10000 is used.This is a network module and requires
connection: network_cli
in order to work properly.For more information please see the Network Guide.
Aliases: network.edgeos.edgeos_command
Parameters
Parameter |
Comments |
---|---|
The commands or ordered set of commands that should be run against the remote device. The output of the command is returned to the playbook. If the |
|
The number of seconds to wait between Default: |
|
Used in conjunction with Choices:
|
|
Number of times a command should be tried before it is considered failed. The command is run on the target device and evaluated against the Default: |
|
Causes the task to wait for a specific condition to be met before moving forward. If the condition is not met before the specified number of retries is exceeded, the task will fail. |
Notes
Note
Tested against EdgeOS 1.9.7
Running
show system boot-messages all
will cause the module to hang since EdgeOS is using a custom pager setting to display the output of that command.
Examples
tasks:
- name: Reboot the device
community.network.edgeos_command:
commands: reboot now
- name: Show the configuration for eth0 and eth1
community.network.edgeos_command:
commands: show interfaces ethernet {{ item }}
loop:
- eth0
- eth1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
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 Sample: |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.