eos_command - Run arbitrary command on EOS device

New in version 2.1.

Synopsis
Options
Examples
Return Values
This is a Core Module

Synopsis

Sends an aribtrary set of commands to and EOS node and returns the results read from the device. The eos_command modulule 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.

Options

parameter	required	default	choices	comments
auth_pass	no	none		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 ANSIBLE_NET_AUTH_PASS will be used instead.
authorize	no		yes no	Instructs the module to enter priviledged mode on the remote device before sending any commands. If not specified, the device will attempt to excecute all commands in non-priviledged mode. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTHORIZE will be used instead.
commands	yes			The commands to send to the remote EOS device over the configured provider. The resulting output from the command is returned. If the waitfor argument is provided, the module is not returned until the condition is satisfied or the number of retires as expired.
host	yes			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.
interval	no	1		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.
password	no			Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or eapi transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port	no	0 (use common port)		Specifies the port to use when buiding the connection to the remote device. This value applies to either cli or eapi. The port value will default to the approriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
provider	no			Convience method that allows all eos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
retries	no	10		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 waitfor conditionals
ssh_keyfile	no			Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
transport	yes	cli		Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or eapi.
use_ssl	no	True	yes no	Configures the transport to use SSL if set to true only when the transport argument is configured as eapi. If the transport argument is not eapi, this value is ignored
username	no			Configures the usename to use to authenticate the connection to the remote device. The value of username is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
waitfor	no			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.

Examples

- eos_command:
    commands: "{{ lookup('file', 'commands.txt') }}"

- eos_command:
    commands:
        - show interface {{ item }}
  with_items: interfaces

- eos_command:
    commands:
      - show version
    waitfor:
      - "result[0] contains 4.15.0F"

- eos_command:
  commands:
    - show version | json
    - show interfaces | json
    - show version
  waitfor:
    - "result[2] contains '4.15.0F'"
    - "result[1].interfaces.Management1.interfaceAddress[0].primaryIp.maskLen eq 24"
    - "result[0].modelName == 'vEOS'"

Return Values

Common return values are documented here Common Return Values, the following are the fields unique to this module:

name	description	returned	type	sample
stdout_lines	The value of stdout split into a list	always	list	[['...', '...'], ['...'], ['...']]
stdout	the set of responses from the commands	always	list	['...', '...']
failed_conditions	the conditionals that failed		list	['...', '...']

This is a Core Module

For more information on what this means please read Core Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.