arista.eos.eos_banner_module.rst

arista.eos.eos_banner

Manage multiline banners on Arista EOS devices

Version added: 1.0.0

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.

Parameters

Parameter	Choices/Defaults	Comments
banner string / required	Choices: login motd	Specifies which banner that should be configured on the remote device.
state string	Choices: present ← absent	Specifies whether or not the configuration is present in the current devices active running configuration.
text string		The banner text that should be present in the remote device running configuration. This argument accepts a multiline string. Requires state=present.

Notes

Note

- Tested against Arista EOS 4.24.6F

Examples

- 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

Return Values

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

Key	Returned	Description
commands list	always	The list of configuration mode commands to send to the device Sample: ['banner login', 'this is my login banner', 'that contains a multiline', 'string', 'EOF']
session_name string	if changes	The EOS config session name used to load the configuration Sample: ansible_1479315771

Status

Authors

• Peter Sprygada (@privateip)