community.network.cnos_banner – Manage multiline banners on Lenovo CNOS devices
community.network.cnos_banner – Manage multiline banners on Lenovo CNOS devices
Note
This plugin is part of the community.network collection (version 2.0.1).
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.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
banner string / required |
|
Specifies which banner should be configured on the remote device. In Ansible 2.8 and earlier only login and motd were supported. | |
provider string |
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the CNOS Platform Options guide. A dict object containing connection details. | ||
auth_pass string |
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 | ||
authorize boolean |
|
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 | |
host string / required |
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. | ||
password string |
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
port string |
Default: 22 |
Specifies the port to use when building the connection to the remote device. | |
ssh_keyfile string |
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
timeout string |
Default: 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. | |
username string |
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable | ||
state string |
|
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, 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 | Returned | Description |
---|---|---|
commands list / elements=string |
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'] |
Authors
- Anil Kumar Muraleedharan (@amuraleedhar)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/cnos_banner_module.html