Vh! d dl mZmZmZ eZdZdZdZd dl Z d dl
Z
d dl m Z d dl
mZmZmZmZmZmZ G d d e Z G d
d e Z G d d
e Zd Zedk( r e yy) )absolute_importdivisionprint_functiona
module: iosxr_banner
author:
- Trishna Guha (@trishnaguha)
- Kedar Kekan (@kedarX)
short_description: Module to configure multiline banners.
description:
- 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.
version_added: 1.0.0
requirements:
- ncclient >= 0.5.3 when using netconf
- lxml >= 4.1.1 when using netconf
extends_documentation_fragment:
- cisco.iosxr.iosxr
notes:
- This module works with connection C(network_cli) and C(netconf). See L(the IOS-XR
Platform Options,../network/user_guide/platform_iosxr.html).
options:
banner:
description:
- Specifies the type of banner to configure on remote device.
required: true
type: str
choices:
- login
- motd
text:
description:
- 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 I(state=present).
type: str
state:
description:
- Existential state of the configuration on the device.
default: present
type: str
choices:
- present
- absent
a
- 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
a5
commands:
description: The list of configuration mode commands sent to device with transport C(cli)
returned: always (empty list when no commands to send)
type: list
sample:
- banner login
- "@this is my login banner"
- that contains a multiline
- string@
xml:
description: NetConf rpc xml sent to device with transport C(netconf)
returned: always (empty list when no xml rpc to send)
type: list
sample:
- '
motd
Ansible banner example
'
N)
AnsibleModule) build_xml
etree_find
get_config
is_cliconf
is_netconf load_configc e Zd Zd Zd Zy)
ConfigBasec B || _ dg d| _ i | _ i | _ y )NF)changedwarnings)_module_result_want_have)selfmodules l/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/iosxr/plugins/modules/iosxr_banner.py__init__zConfigBase.__init__w s# #(b9
c $ | j j d }|r(dj t | j }| j
j
| j j d || j j d d y )Ntextz{0}bannerstater r r )r paramsformatstrstripr update)r r s r map_params_to_objz ConfigBase.map_params_to_obj} sp ||""6* <<D 12D
,,--h7 ,,W5
r N)__name__
__module__ __qualname__r r% r r r r v s
r r c 0 e Zd Z fdZd Zd Zd Z xZS )CliConfigurationc , t t | | y N)superr+ r r r __class__s r r zCliConfiguration.__init__ s
.v6r c t }| j j d }|dk( r| j j d dk7 rd| j j v r| j d r|j
dj | j j d n|dk( r| j d r| j d j j d | j j d k7 rYdj | j j d }|| j d j z
}|j
| || j d < |rZ| j j }t | j ||
}|rt | | j d < d
| j d< y y )Nr absentr zno banner {0!s}r presentunicode_escapez
banner {0!s} commands)commitprepareddiffTr )listr r r getkeysappendr! r encodedecoder# r
check_moder dict)r r5 r
banner_cmdr6 r9 s r map_obj_to_commandsz$CliConfiguration.map_obj_to_commands sq 6 ##G, H zz~~g&(2$**//++
60B 1 8 8 9L9LX9V WX
i
zz&!djj&8&?&?&A&H&H ' ''( - 3 3DLL4G4G4Q R
djj 0 6 6 88
+#+ Z 000F t||XfED'+T': V$&*DLL # r c ~ dj | j j d }t | j | }t j
d|t j }|r|j d }nd }| j j d dd}|r
||d< d |d
< | j j | y ) Nz banner {0!s}r )
config_filterzbanner (\S+) (.*) r2 )r r r r3 r )
r! r r r researchDOTALLgroupr r$ )r
cli_filteroutputmatchr objs r map_config_to_objz"CliConfiguration.map_config_to_obj s #**4<<+>+>x+HI
DLL
C . B ;;q>DD ,,X6J CK$CL
# r c z | j | j | j | j S r- )r% rO rC r r s r runzCliConfiguration.run s0 "||r )r& r' r( r rC rO rR
__classcell__r0 s @r r+ r+ s 7+. r r+ c * e Zd Z fdZd Zd Z xZS )NCConfigurationc t t | | t j | _ | j
j
dddddfdddifd d
d d fg y )
Nr zbanners/bannerT operation)xpathtagattribza:bannerrY zbanner/banner-nameza:textzbanner/banner-textedit)rY rX )r. rV r collections OrderedDict
_banners_metar$ r/ s r r zNCConfiguration.__init__ sh
ot-f5 ( 4 4 6 !!%5dkZ[g'; <=%9OP
r c . | j j d }t d| j | j j d }t | j d| }d }d }t |d ,t |d j }t |d j }d }|d k( r*|| j j d
k( rt | rd }n|d k( rd
}g | j d< |rt d| j | j j | }|| j j }t | j |||| } | rN|| j d< | j j rt | | j d< d| j d< y y y y )Nr bannersfilter)xmapr opcoderunning)sourcerE z banner-textz banner-namer2 r deleter3 mergexml)r6 re
nc_get_filterr7 r9 Tr )
r r r r_ r r r lenr r@ r _diffrA )
r r _get_filterre banner_name banner_textrd _edit_filterr6 r9 s
r map_obj_to_xml_rpcz"NCConfiguration.map_obj_to_xml_rpc s ##G, ##<<&&
T\\);W g} - 9$Wm<AAK$Wm<AAK H 0C0CH0M!MRUVaRb F
i
F U $''||** L ' !\\ 4 44"LL ! #"- *6DLL'||))/3T/B V,.2DLL+ ( r c Z | j | j | j S r- )r% rq r rQ s r rR zNCConfiguration.run s$ !||r )r& r' r( r rq rR rS rT s @r rV rV s
/3b r rV c 0 t t dddg t t dddg } d g}t | |d
}d }t | r t | }nt | r t | }d }||j
} |j d i | y )
z%main entry point for module executionTloginmotd)requiredchoicesr3 r2 )defaultrw r )r r3 )r )
argument_spec required_ifsupports_check_modeNr) )rA r r
r+ r rV rR exit_json)ry rz r
config_objectresults r mainr s TGV+<=
V9y(.CDM 33K
# F M&(0
F '/
F ""$F v r __main__)
__future__r r r type
__metaclass__
DOCUMENTATIONEXAMPLESRETURNr] rG ansible.module_utils.basicr Hansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.iosxrr r r r
r r objectr r+ rV r r& r) r r r s A @
*
X (
4 4
(. z . bA j A H : zF r