eos_banner - Manage multiline banners on Arista EOS devices
Synopsis
- This will configure both login and motd banners on remote devices running Arista EOS. It allows playbooks to add or remote banner text from the active running configuration.
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 | | | 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 ANSIBLE_NET_AUTHORIZE will be used instead. |
banner
| yes | | | Specifies which banner that should be configured on the remote device. |
provider
| no | | | A dict object containing connection details. |
Dictionary object provider | parameter | required | default | choices | comments | username
| no | | | 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 ANSIBLE_NET_USERNAME will be used instead. | authorize
| no | | | 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 ANSIBLE_NET_AUTHORIZE will be used instead. | 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. | 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. | 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. | timeout
| no | 10 | | 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. | use_ssl
| no | True | | Configures the transport to use SSL if set to true only when the transport=eapi. If the transport argument is not eapi, this value is ignored. | 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. | validate_certs
| no | | | If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not eapi, this value is ignored. | port
| no | 0 (use common port) | | 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). | transport
| yes | cli | | Configures the transport connection to use when connecting to the remote device. | |
state
| no | present | | Specifies whether or not the configuration is present in the current devices active running configuration. |
text
| no | | | The banner text that should be present in the remote device running configuration. This argument accepts a multiline string. Requires state=present. |
Examples
- name: configure the login banner
eos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: remove the motd banner
eos_banner:
banner: motd
state: absent
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample |
| commands | The list of configuration mode commands to send to the device | always | list | ['banner login', 'this is my login banner', 'that contains a multiline', 'string', 'EOF'] |
| session_name | The EOS config session name used to load the configuration | if changes | str | ansible_1479315771 |
Notes
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.