cisco.iosxr.iosxr_banner module – Module to configure multiline banners.
Note
This module is part of the cisco.iosxr collection (version 3.3.1).
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 cisco.iosxr
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.iosxr.iosxr_banner
.
New in cisco.iosxr 1.0.0
Synopsis
This module will configure both exec and motd banners on remote device running Cisco IOS XR. It allows playbooks to add or remove banner text from the running configuration.
Requirements
The below requirements are needed on the host that executes this module.
ncclient >= 0.5.3 when using netconf
lxml >= 4.1.1 when using netconf
Parameters
Parameter |
Comments |
---|---|
Specifies the type of banner to configure on remote device. Choices:
|
|
Deprecated Starting with Ansible 2.5 we recommend using For more information please see the Network Guide. A dict object containing connection details. |
|
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. |
|
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 |
|
Specifies the port to use when building the connection to the remote device. |
|
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 |
|
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. |
|
Specifies the type of connection based transport. Choices:
|
|
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 |
|
Existential state of the configuration on the device. Choices:
|
|
Banner text to be configured. Accepts multi line string, without empty lines. When using a multi line string, the first and last characters must be the start and end delimiters for the banner Requires state=present. |
Notes
Note
This module works with connection
network_cli
andnetconf
. See the IOS-XR Platform Options.For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- name: configure the login banner
cisco.iosxr.iosxr_banner:
banner: login
text: |
@this is my login banner
that contains a multiline
string@
state: present
- name: remove the motd banner
cisco.iosxr.iosxr_banner:
banner: motd
state: absent
- name: Configure banner from file
cisco.iosxr.iosxr_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 sent to device with transport Returned: always (empty list when no commands to send) Sample: |
|
NetConf rpc xml sent to device with transport Returned: always (empty list when no xml rpc to send) Sample: |
Authors
Trishna Guha (@trishnaguha)
Kedar Kekan (@kedarX)