community.network.cnos_banner module – Manage multiline banners on Lenovo CNOS devices
Note
This module is part of the community.network collection (version 5.0.3).
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 community.network
.
To use it in a playbook, specify: community.network.cnos_banner
.
Synopsis
This will configure both login and motd banners on remote devices running Lenovo CNOS. It allows playbooks to add or remote banner text from the active running configuration.
Aliases: network.cnos.cnos_banner
Parameters
Parameter |
Comments |
---|---|
Specifies which banner should be configured on the remote device. In Ansible 2.8 and earlier only login and motd were supported. 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, with no empty lines. Requires state=present. |
Notes
Note
Tested against CNOS 10.8.1
Examples
- name: Configure the login banner
community.network.cnos_banner:
banner: login
text: |
this is my login banner
that contains a multiline
string
state: present
- name: Remove the motd banner
community.network.cnos_banner:
banner: motd
state: absent
- name: Configure banner from file
community.network.cnos_banner:
banner: motd
text: "{{ lookup('file', './config_partial/raw_banner.cfg') }}"
state: present
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: |
Authors
Anil Kumar Muraleedharan (@amuraleedhar)