cisco.iosxr.iosxr_banner_module.rst

cisco.iosxr.iosxr_banner

Module to configure multiline banners.

Version added: 1.0.0

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

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	Choices/Defaults	Comments
banner string / required	Choices: login motd	Specifies the type of banner to configure on remote device.
state string	Choices: present ← absent	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

• This module works with connection network_cli and netconf. 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.

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	Returned	Description
commands list	always (empty list when no commands to send)	The list of configuration mode commands sent to device with transport cli Sample: ['banner login', '@this is my login banner', 'that contains a multiline', 'string@']
xml list	always (empty list when no xml rpc to send)	NetConf rpc xml sent to device with transport netconf Sample: ['<config xmlns:xc="urn:ietf:params:xml:ns:netconf:base:1.0"> <banners xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-infra-infra-cfg"> <banner xc:operation="merge"> <banner-name>motd</banner-name> <banner-text>Ansible banner example</banner-text> </banner> </banners> </config>']

Status

Authors

• Trishna Guha (@trishnaguha)
• Kedar Kekan (@kedarX)