eos_banner¶

Collection Note

This module is part of the arista.eos collection. To install the collection, use:

ansible-galaxy collection install arista.eos

Added in version 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	Defaults / Choices	Comments
banner str required	Choices: login, motd	Specifies which banner that should be configured on the remote device.
state str	Default: present Choices: present, absent	Specifies whether or not the configuration is present in the current devices active running configuration.
text str		The banner text that should be present in the remote device running configuration. This argument accepts a multiline string. Requires I(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¶

Key	Data Type	Description	Returned
commands	list	The list of configuration mode commands to send to the device	always
session_name	str	The EOS config session name used to load the configuration	if changes

Authors¶

Peter Sprygada (@privateip)