cisco.iosxr.iosxr_banner – Manage multiline banners on Cisco IOS XR devices¶
Note
This plugin is part of the cisco.iosxr collection (version 1.2.1).
To install it use: ansible-galaxy collection install cisco.iosxr
.
To use it in a playbook, specify: cisco.iosxr.iosxr_banner
.
New in version 1.0.0: of cisco.iosxr
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.
Note
This module has a corresponding action plugin.
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 | Choices/Defaults | Comments | |
---|---|---|---|
banner
string
/ required
|
|
Specifies the type of banner to configure on remote device.
|
|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli .For more information please see the Network Guide.
A dict object containing connection details.
|
||
host
string
|
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
ANSIBLE_NET_PASSWORD will be used instead. |
||
port
integer
|
Specifies the port to use when building the connection to the remote device.
|
||
ssh_keyfile
path
|
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
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
timeout
integer
|
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.
|
||
transport
string
|
|
Specifies the type of connection based transport.
|
|
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
ANSIBLE_NET_USERNAME will be used instead. |
||
state
string
|
|
Existential state of the configuration on the device.
|
|
text
string
|
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
Tested against IOS XRv 6.1.3.
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 Ansible Network Guide
For more information on using Ansible to manage Cisco devices see the Cisco integration page.
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:
Authors¶
Trishna Guha (@trishnaguha)
Kedar Kekan (@kedarX)