arista.eos.eos_banner module – Manage multiline banners on Arista EOS devices
Note
This module is part of the arista.eos collection (version 9.0.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: arista.eos.eos_banner
.
New in arista.eos 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.
Aliases: banner
Parameters
Parameter |
Comments |
---|---|
Specifies which banner that should be configured on the remote device. Choices:
|
|
Specifies whether or not the configuration is present in the current devices active running configuration. Choices:
|
|
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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |
|
The EOS config session name used to load the configuration Returned: if changes Sample: |
Authors
Peter Sprygada (@privateip)