Vhk d dl mZmZmZ eZdZdZdZd dl Z d dl
Z
d dl m Z d dl
mZmZmZmZmZmZmZ d Z G d d
e Z G d d e Z G d
de Zd Zedk( r e yy) )absolute_importdivisionprint_functionaf
module: iosxr_system
author:
- Peter Sprygada (@privateip)
- Kedar Kekan (@kedarX)
short_description: Module to manage the system attributes.
description:
- This module provides declarative management of node system attributes on Cisco IOS
XR devices. It provides an option to configure host system parameters or remove
those parameters from the device active 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).
- name-servers I(state=absent) operation with C(netconf) transport is a success, but
with rpc-error. This is due to XR platform issue. Recommended to use I(ignore_errors)
option with the task as a workaround.
options:
hostname:
description:
- Configure the device hostname parameter. This option takes an ASCII string value.
type: str
vrf:
description:
- VRF name for domain services
type: str
default: "default"
domain_name:
description:
- Configure the IP domain name on the remote device to the provided value. Value
should be in the dotted name form and will be appended to the C(hostname) to
create a fully-qualified domain name.
type: str
domain_search:
description:
- Provides the list of domain suffixes to append to the hostname for the purpose
of doing name resolution. This argument accepts a list of names and will be
reconciled with the current active configuration on the running node.
type: list
elements: str
lookup_source:
description:
- The C(lookup_source) argument provides one or more source interfaces to use
for performing DNS lookups. The interface provided in C(lookup_source) must
be a valid interface configured on the device.
type: str
lookup_enabled:
description:
- Provides administrative control for enabling or disabling DNS lookups. When
this argument is set to True, lookups are performed and when it is set to False,
lookups are not performed.
type: bool
default: true
name_servers:
description:
- The C(name_serves) argument accepts a list of DNS name servers by way of either
FQDN or IP address to use to perform name resolution lookups. This argument
accepts wither a list of DNS servers See examples.
type: list
elements: str
state:
description:
- State of the configuration values in the device's current active configuration. When
set to I(present), the values should be configured in the device active configuration
and when set to I(absent) the values should not be in the device active configuration
default: present
choices:
- present
- absent
type: str
a
- name: configure hostname and domain-name (default vrf=default)
cisco.iosxr.iosxr_system:
hostname: iosxr01
domain_name: test.example.com
domain_search:
- ansible.com
- redhat.com
- cisco.com
- name: remove configuration
cisco.iosxr.iosxr_system:
hostname: iosxr01
domain_name: test.example.com
domain_search:
- ansible.com
- redhat.com
- cisco.com
state: absent
- name: configure hostname and domain-name with vrf
cisco.iosxr.iosxr_system:
hostname: iosxr01
vrf: nondefault
domain_name: test.example.com
domain_search:
- ansible.com
- redhat.com
- cisco.com
- name: configure DNS lookup sources
cisco.iosxr.iosxr_system:
lookup_source: MgmtEth0/0/CPU0/0
lookup_enabled: true
- name: configure name servers
cisco.iosxr.iosxr_system:
name_servers:
- 8.8.8.8
- 8.8.4.4
a
commands:
description: The list of configuration mode commands to send to the device
returned: always
type: list
sample:
- hostname iosxr01
- ip domain-name test.example.com
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:
- '
default
0
redhat.com
'
N)
AnsibleModule) build_xml
etree_find
etree_findall
get_config
is_cliconf
is_netconf load_configc r t | j | }t | j | }||fS N)set
difference)wanthaveaddsremovess l/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/iosxr/plugins/modules/iosxr_system.py diff_listr s4 t9 %D$i""4(G '? c e Zd Zd Zd Zy)
ConfigBasec b || _ dg d| _ t | _ t | _ y )NF)changedwarnings)_module_resultdict_want_have)selfmodules r __init__zConfigBase.__init__ s' #(b9 V
V
r c
| j j | j j d | j j d | j j d | j j d | j j d | j j d | j j d d y ) Nhostnamevrf domain_name
domain_search
lookup_sourcelookup_enabled name_servers)r' r( r) r* r+ r, r- )r! updater paramsr# s r map_params_to_objz ConfigBase.map_params_to_obj s
LL / /
;||**51 #|| 2 2= A!% !4!4_!E!% !4!4_!E"&,,"5"56F"G $ 3 3N C
r N)__name__
__module__ __qualname__r% r1 r r r r s
r r c B e Zd Z fdZd Zd Zd Zd Zd Zd Z xZ
S )CliConfigurationc , t t | | y r )superr7 r% r# r$ __class__s r r% zCliConfiguration.__init__ s
.v6r c v t } j j d } fd}|dk( r j d dk7 r|j d j d r|j d j d r-|j d
j j d j d s|j d j d
D ]" }|j dj | $ j d D ]" }|j dj | $ n|dk( r |d r-|j dj j d |d r-|j dj j d |d r-|j dj j d d } j d s j d rd}n j d r j d sd }||j | j d
wt j d
j d
\ }}|D ]" }|j dj | $ |D ]" }|j dj | $ j d wt j d j d \ }}|D ]" }|j dj | $ |D ]" }|j dj | $ g j d< |ri j j }t j || } | rt | j d< | j d< d j d < y y ) Nstatec j j | xr7 j j | j j | k7 S r )r! getr" )xr# s r needs_updatez:CliConfiguration.map_obj_to_commands..needs_update s: ::>>!$Q$**..*;tzz~~a?P*P Qr absentr' iosz no hostnamer) zno domain namer+ z'no domain lookup source-interface {0!s}r, zno domain lookup disabler- zno domain name-server {0!s}r* zno domain list {0!s}presentzhostname {0!s}zdomain name {0!s}z$domain lookup source-interface {0!s}domain lookup disablezdomain name-server {0!s}zdomain list {0!s}commands)commitprepareddiffTr ) listr r/ r" appendformatr! r r
check_moder
r )
r# rF r= rA itemcmdr r rG rJ s
` r map_obj_to_commandsz$CliConfiguration.map_obj_to_commands sg 6 ##G, R H zz*%.
.zz-( 01zz/*=DDTZZP_E`a :: ./ :;
>2
L = D DT JK
L
?3
E 6 = =d CD
E i
J' 0 7 7
:8N OPM* 3 : :4::m;T UVO,:AA$**_B]^ C:: ./DJJ?O4P- ,-djjAQ6R0$zz.)5 )$**^*DdjjQ_F` a
g MD OO$>$E$Ed$KLM # PD OO$A$H$H$NOP zz/*6 )$**_*EtzzRaGb c
g FD OO$7$>$>t$DEF # ID OO$:$A$A$$GHI $& Z 000F t||XfED'+T': V$'/DLL $&*DLL # r c t t j d|t j }|r|j d S y )Nz^hostname (\S+) researchMgroupr# configmatchs r parse_hostnamez CliConfiguration.parse_hostname s/ ,fbdd; ;;q> ! r c t t j d|t j }|r|j d S y )Nz^domain name (\S+)rS rT rY s r parse_domain_namez"CliConfiguration.parse_domain_name s/ /> ;;q> ! r c t t j d|t j }|r|j d S y )Nz%^domain lookup source-interface (\S+)rS rT rY s r parse_lookup_sourcez$CliConfiguration.parse_lookup_source s/ BFBDDQ ;;q> ! r c \ t | j }| j j | j | | j | t
j d|t j | j | d|vt
j d|t j d y )Nz^domain list (\S+)rE z^domain name-server (\S+))r' r) r* r+ r, r- )
r
r r" r. r\ r^ rU findallrW r` )r# rZ s r map_config_to_objz"CliConfiguration.map_config_to_obj s DLL)
/ / 7 # 5 5f =!#,A6244!P!%!9!9&!A"9"G "
+GQSQUQU V
r c z | j | j | j | j S r )r1 rc rQ r r0 s r runzCliConfiguration.run* s0 "||r ) r2 r3 r4 r% rQ r\ r^ r` rc re
__classcell__r; s @r r7 r7 s( 7A+F"
"
"
r r7 c * e Zd Z fdZd Zd Z xZS )NCConfigurationc X t t | | t j | _ t j | _ t j | _ t j | _ t j | _ t j | _
y r ) r9 ri r% collections OrderedDict _system_meta_system_domain_meta_system_server_meta_hostname_meta_lookup_source_meta _lookup_metar: s r r% zNCConfiguration.__init__3 sx
ot-f5 ' 3 3 5#.#:#:#< #.#:#:#< ) 5 5 7#.#:#:#< ' 3 3 5r c , j j dddddfdddddfdd dd
fd d dd
dfg j j dddddfdddddfdd dd
fdddddfddddd
dfdddd
fdddd
fg j j dddddfdddddfdd dd
fdddddfddddd
dfdd dd
fd d dd
fg j j d d dd
dfg j
j dddddfdddddfdd dd
fd!d"dd
dfg j j dddddfdddddfdd dd
fd#d$ddd
dfg j j d% }t d&d'( }t j d)|* }t d+d'( }t j d)|* }t |d, }| |j nd }t |d }i }|D ] } t }
t } t | d- } | | j nd }
t | d. }| |j nd }t | d/ }|D ] }| j |j t | d0 }|D ] }|
j |j t | d1 }| |j nd }t | d# d2nd}|| |
||d3||
< d }i }i }i }t }t } t } t } t } t } i }! | j d ,|d4k( rrd5} ,fd6}" |"d7 r j d j d7 d8} |"d9 rd9|i} j d: s,d: s j d |d< |"d; r$ j d |!d< j d; |!d;< j d< rki }# j d7 |#d7< j d |#d< d=|#d>< j d< D ]. }|,d< v s ||#d<< | j |#j% 0 j d? ri }$ j d |$d< d=|$d>< j d? D ]. }|,d? v s ||$d?< |j |$j% 0 n%|d@k( r dA} ,fdB}" |"d7 r j d j d7 d8} j d9 # j d9 |k7 rd9 j d9 i} j d: s,d: r j d |d< |"d; r$ j d |!d< j d; |!d;< j d< rt' j d< ,d< \ }%}&i }# j d7 |#d7< j d |#d< d=|#d>< |%D ]. }|,d< vs ||#d<< | j |#j% 0 |&D ]. }|,d< v s ||#d<< | j |#j% 0 j d? rt' j d? ,d? \ }'}(i }$ j d |$d< d=|$d>< |'D ]. }|,d? vs ||$d?< | j |$j% 0 |(D ]. }|,d? v s ||$d?< | j |$j% 0 g j( dC< t })|r|r(|)j t d+ j ||D |r(|)j t d& j ||D |!r(|)j t d& j
|!|D |r(|)j t d& j ||D |d5k( rw| r(|)j t d& j | |D |r|)j t d& j ||D j d dEk7 rdFg j( dG< n|dAk( r| r(|)j t d& j | |D | r(|)j t d& j | d5D | r(|)j t d& j | |D | r(|)j t d& j | d5D d }*|)r1 j j* }+t- j |)|+||H }*|*rN j j. rt1 |*I j( dJ< |) j( dC< d j( dK< y y # t" $ r d g g d dd3,Y $w xY w)LNvrfszip-domain/vrfsTedit)xpathtag operationr( zip-domain/vrfs/vrfza:vrfzip-domain/vrfs/vrf/vrf-name)rv rx z
a:domain_namezip-domain/vrfs/vrf/namerx )rv rx attriblistszip-domain/vrfs/vrf/listsrK z ip-domain/vrfs/vrf/lists/list)rv rw rx ry za:orderz#ip-domain/vrfs/vrf/lists/list/orderza:domain_searchz'ip-domain/vrfs/vrf/lists/list/list-nameserverszip-domain/vrfs/vrf/serversserverz!ip-domain/vrfs/vrf/servers/serverz'ip-domain/vrfs/vrf/servers/server/orderza:name_serversz0ip-domain/vrfs/vrf/servers/server/server-addressz
a:hostnamezhost-names/host-nameza:lookup_sourcez#ip-domain/vrfs/vrf/source-interfacelookupzip-domain/vrfs/vrf/lookupr= z ip-domainfilter)opcoderunning)source
config_filterz
host-namesz host-namezvrf-namenamez list-namezserver-addresszsource-interfaceF)r) r* r- r+ r, rB deletec T j | d uxr j | | k( S r r! r@ r# sys_nodes r rA z8NCConfiguration.map_obj_to_xml_rpc..needs_update s, zz!}D0QTZZ]hqk5QQr r) )r( r) r' r, r+ r* 0orderr- rD mergec x j | d uxr' | d u xs | d uxr j | | k7 S r r r s r rA z8NCConfiguration.map_obj_to_xml_rpc..needs_update sQ zz!}D0 QK4' R 4/PDJJqMXa[4Pr xml)xmapr/ r defaultzname-servers delete operation with non-default vrf is a success, but with rpc-error. Recommended to use 'ignore_errors' option with the task as a workaroundr )rG r
nc_get_filterrH rJ r )rm r. rn ro rp rq rr r r/ r r
r textr rK rL r! KeyErrorcopyr r rN r
_diffr )-r# r= _get_filterr
hostname_runn hostname_eler' vrf_elevrf_mapr( name_server_list domain_list vrf_name_elevrf_namedomain_name_eler)
domain_eledomain
server_eler| lookup_source_eler+ r, r hostname_param lookup_param system_paramsys_server_paramssys_domain_paramsadd_domain_paramsdel_domain_paramsadd_server_paramsdel_server_paramslookup_source_paramsrA domain_param server_param domain_addsdomain_removes server_addsserver_removes_edit_filter_listrJ rG r s- ` @r map_obj_to_xml_rpcz"NCConfiguration.map_obj_to_xml_rpc< sf #3DvVW"6tRXYZ$APVWX#!:%+"-
''#3DvVW"6tRXYZ$APVWX$>tZ`ab!@ #%+"- &KZ` ab% GV\]
.
''#3DvVW"6tRXYZ$APVWX :4V\]
!D #%+"- GV\]
%!S%++
@
"" ! 46U`a
''#3DvVW"6tRXYZ$APVWX%!F%+"-
#3DvVW"6tRXYZ$APVWX !< #%+"-
" ##G, H= T\\);W X> "4<< Q\]
!-= (4(@<$$d / C #v &K%c:6L,8,D|(($H (f 5O2A2M/..SWK&sK8J$
0""6;;/
0 's,<=J$
5 '' 4
5 !+30B C 6G6S - 2 2Y]M&0h&?&KUQUN +!, 0!."0 !GH - < F F F F F F ! tzz% 01H H F
R M*'+zz%'8TaIb c J'",h!7:: ./AQ8R&*jj&7 U#O,.2jj.?$U+8<
?8S$_5zz/* ! .2jj .G ]+&*jj&7 U#(+ W% "jj 9 FF /!::8> _5)00 1B1B1DEF
zz.) ! &*jj&7 U#(+ W% "jj 8 FF .!997= ^4)00 1B1B1DEF
i
F
M*'+zz%'8TaIb c zz*%1djj6LPX6X",djj.D!E:: ./H=M4N&*jj&7 U#O,.2jj.?$U+8<
?8S$_5zz/*.7JJ/ _-/+ ^ " .2jj .G ]+&*jj&7 U#(+ W% ) FF Xo%>>8> _5)00 1B1B1DEF - FF /!::8> _5)00 1B1B1DEF
zz.).7JJ~. ^,/+ ^ " &*jj&7 U#(+ W% ) FF Xn%==7= ^4)00 1B1B1DEF - FF .!997= ^4)00 1B1B1DEF
! U F !(( $ ! 0 0 - % !(( # ! . . + % $!(( # ! 5 5 3 % !(( # ! . . + % !$%,,! '!%!9!9#4#) %%,,! '!%!9!9#4#) zz%(I5 z4 Z0 7"$%,,! '!%!9!9#4#) %%,,! '!%!9!9#4#+ %%,,! '!%!9!9#4#) %%,,! '!%!9!9#4#+ 000F ! ) D ||!!'+T': V$"3DLL &*DLL # y #!# "!%"& H s d8 8e
e
c Z | j | j | j S r )r1 r r r0 s r re zNCConfiguration.run s$ !||r )r2 r3 r4 r% r re rf rg s @r ri ri 2 s 6J+X r ri c
t t d t dd t d t dd t dd t d t dd t d d
gd } t | d
}d}t | r t | }nt | r t | }d}|r|j
} |j di | y)z-Main entry point for Ansible module executionstr)typer )r r rK )r elementsboolTrD rB )choicesr )r' r( r) r* r- r+ r, r= )
argument_specsupports_check_modeNr5 )r r r r7 r ri re exit_json)r r$
config_objectresults r mainr s 5! eY /e$7v6&6Ix0)D M D
QFM&(0
F '/
F ""$F v r __main__)
__future__r r r r
__metaclass__
DOCUMENTATIONEXAMPLESRETURNrk rU ansible.module_utils.basicr Hansible_collections.cisco.iosxr.plugins.module_utils.network.iosxr.iosxrr r r r
r r r
r objectr r7 ri r r2 r5 r r r s
A @
K
Z$ L
< 4
*h z h VZ j Z z 8 zF r