This plugin is part of the arista.eos collection (version 2.2.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 arista.eos.
To use it in a playbook, specify:
New in version 1.0.0: of arista.eos
This module has a corresponding action plugin.
| banner |
string / required
| || |
Specifies which banner that should be configured on the remote device.
| provider |
Starting with Ansible 2.5 we recommend using
Starting with Ansible 2.6 we recommend using
This option will be removed in a release after 2022-06-01.
For more information please see the EOS Platform Options guide.
A dict object containing connection details.
| auth_pass |
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
| authorize |
| || |
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
| host |
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.
| password |
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
| port |
| Default: |
Specifies the port to use when building the connection to the remote device. This value applies to either cli or eapi.
The port value will default to the appropriate transport common port if none is provided in the task (cli=22, http=80, https=443).
| ssh_keyfile |
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
| timeout |
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.
| transport |
| || |
Configures the transport connection to use when connecting to the remote device.
| use_proxy |
| || |
| use_ssl |
| || |
Configures the transport to use SSL if set to
| username |
Configures the username to use to authenticate the connection to the remote device. This value 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
| validate_certs |
| || |
| state |
| || |
Specifies whether or not the configuration is present in the current devices active running configuration.
| text |
The banner text that should be present in the remote device running configuration. This argument accepts a multiline string. Requires state=present.
- name: configure the login banner arista.eos.eos_banner: banner: login text: | this is my login banner that contains a multiline string state: present - name: remove the motd banner arista.eos.eos_banner: banner: motd state: absent
Common return values are documented here, the following are the fields unique to this module:
| commands |
list / elements=string
The list of configuration mode commands to send to the device
['banner login', 'this is my login banner', 'that contains a multiline', 'string', 'EOF']
| session_name |
|if changes|| |
The EOS config session name used to load the configuration
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.