Vhu(ddlmZmZmZeZdZdZdZddl Z ddl Z ddl Z ddl Z ddl Z ddlmZddlmZdZ ddlmZmZd Zdd lmZmZmZdd lmZmZdd l m!Z!m"Z"ddl#m$Z$dZ%e%dze%zdze%zZ&dZ'e jPde&zdzZ)e jPde&zdze'zdzZ*e jPde&zdzZ+e jPde&zdze'zdzZ,e jPde&zdzZ-e jPde'zdzZ.dZ/dZ0dZ1dZ2d Z3d!Z4d"Z5d#Z6d$Z7d%Z8d&Z9d'Z:d(Z;d)Zd,Z?d-Z@d.ZAd/ZBd0ZCd1ZDd8d2ZEd3ZFd d4deGfd5ZHd6ZIeJd7k(reIyy#e$re j0Zd ZYPwxYw)9)absolute_importdivisionprint_functiona module: xml short_description: Manage bits and pieces of XML files or strings description: - A CRUD-like interface to managing bits of XML files. extends_documentation_fragment: - community.general.attributes attributes: check_mode: support: full diff_mode: support: full options: path: description: - Path to the file to operate on. - This file must exist ahead of time. - This parameter is required, unless O(xmlstring) is given. type: path aliases: [dest, file] xmlstring: description: - A string containing XML on which to operate. - This parameter is required, unless O(path) is given. type: str xpath: description: - A valid XPath expression describing the item(s) you want to manipulate. - Operates on the document root, V(/), by default. type: str namespaces: description: - The namespace C(prefix:uri) mapping for the XPath expression. - Needs to be a C(dict), not a C(list) of items. type: dict default: {} state: description: - Set or remove an xpath selection (node(s), attribute(s)). type: str choices: [absent, present] default: present aliases: [ensure] attribute: description: - The attribute to select when using parameter O(value). - This is a string, not prepended with V(@). type: raw value: description: - Desired state of the selected attribute. - Either a string, or to unset a value, the Python V(None) keyword (YAML Equivalent, V(null)). - Elements default to no value (but present). - Attributes default to an empty string. type: raw add_children: description: - Add additional child-element(s) to a selected element for a given O(xpath). - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add an empty C() child element), or a hash where the key is an element name and the value is the element value. - This parameter requires O(xpath) to be set. type: list elements: raw set_children: description: - Set the child-element(s) of a selected element for a given O(xpath). - Removes any existing children. - Child elements must be specified as in O(add_children). - This parameter requires O(xpath) to be set. type: list elements: raw count: description: - Search for a given O(xpath) and provide the count of any matches. - This parameter requires O(xpath) to be set. type: bool default: false print_match: description: - Search for a given O(xpath) and print out any matches. - This parameter requires O(xpath) to be set. type: bool default: false pretty_print: description: - Pretty print XML output. type: bool default: false content: description: - Search for a given O(xpath) and get content. - This parameter requires O(xpath) to be set. type: str choices: [attribute, text] input_type: description: - Type of input for O(add_children) and O(set_children). type: str choices: [xml, yaml] default: yaml backup: description: - Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. type: bool default: false strip_cdata_tags: description: - Remove CDATA tags surrounding text values. - Note that this might break your XML file if text values contain characters that could be interpreted as XML. type: bool default: false insertbefore: description: - Add additional child-element(s) before the first selected element for a given O(xpath). - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add an empty C() child element), or a hash where the key is an element name and the value is the element value. - This parameter requires O(xpath) to be set. type: bool default: false insertafter: description: - Add additional child-element(s) after the last selected element for a given O(xpath). - Child elements must be given in a list and each item may be either a string (for example C(children=ansible) to add an empty C() child element), or a hash where the key is an element name and the value is the element value. - This parameter requires O(xpath) to be set. type: bool default: false requirements: - lxml >= 2.3.0 notes: - Use the C(--check) and C(--diff) options when testing your expressions. - The diff output is automatically pretty-printed, so may not reflect the actual file content, only the file structure. - This module does not handle complicated xpath expressions, so limit xpath selectors to simple expressions. - Beware that in case your XML elements are namespaced, you need to use the O(namespaces) parameter, see the examples. - Namespaces prefix should be used for all children of an element where namespace is defined, unless another namespace is defined for them. seealso: - name: XML module development community wiki (archived) description: More information related to the development of this xml module. link: https://github.com/ansible/community/wiki/Module:-xml - name: Introduction to XPath description: A brief tutorial on XPath (w3schools.com). link: https://www.w3schools.com/xml/xpath_intro.asp - name: XPath Reference document description: The reference documentation on XSLT/XPath (developer.mozilla.org). link: https://developer.mozilla.org/en-US/docs/Web/XPath author: - Tim Bielawa (@tbielawa) - Magnus Hedemark (@magnus919) - Dag Wieers (@dagwieers) a? # Consider the following XML file: # # # Tasty Beverage Co. # # Rochefort 10 # St. Bernardus Abbot 12 # Schlitz # # 10 # # #
http://tastybeverageco.com
# # - name: Remove the 'subjective' attribute of the 'rating' element community.general.xml: path: /foo/bar.xml xpath: /business/rating/@subjective state: absent - name: Set the rating to '11' community.general.xml: path: /foo/bar.xml xpath: /business/rating value: 11 # Retrieve and display the number of nodes - name: Get count of 'beers' nodes community.general.xml: path: /foo/bar.xml xpath: /business/beers/beer count: true register: hits - ansible.builtin.debug: var: hits.count # Example where parent XML nodes are created automatically - name: Add a 'phonenumber' element to the 'business' element community.general.xml: path: /foo/bar.xml xpath: /business/phonenumber value: 555-555-1234 - name: Add several more beers to the 'beers' element community.general.xml: path: /foo/bar.xml xpath: /business/beers add_children: - beer: Old Rasputin - beer: Old Motor Oil - beer: Old Curmudgeon - name: Add several more beers to the 'beers' element and add them before the 'Rochefort 10' element community.general.xml: path: /foo/bar.xml xpath: '/business/beers/beer[text()="Rochefort 10"]' insertbefore: true add_children: - beer: Old Rasputin - beer: Old Motor Oil - beer: Old Curmudgeon # NOTE: The 'state' defaults to 'present' and 'value' defaults to 'null' for elements - name: Add a 'validxhtml' element to the 'website' element community.general.xml: path: /foo/bar.xml xpath: /business/website/validxhtml - name: Add an empty 'validatedon' attribute to the 'validxhtml' element community.general.xml: path: /foo/bar.xml xpath: /business/website/validxhtml/@validatedon - name: Add or modify an attribute, add element if needed community.general.xml: path: /foo/bar.xml xpath: /business/website/validxhtml attribute: validatedon value: 1976-08-05 # How to read an attribute value and access it in Ansible - name: Read an element's attribute values community.general.xml: path: /foo/bar.xml xpath: /business/website/validxhtml content: attribute register: xmlresp - name: Show an attribute value ansible.builtin.debug: var: xmlresp.matches[0].validxhtml.validatedon - name: Remove all children from the 'website' element (option 1) community.general.xml: path: /foo/bar.xml xpath: /business/website/* state: absent - name: Remove all children from the 'website' element (option 2) community.general.xml: path: /foo/bar.xml xpath: /business/website set_children: [] # In case of namespaces, like in below XML, they have to be explicitly stated. # # # # # # # NOTE: There is the prefix 'x' in front of the 'bar' element, too. - name: Set namespaced '/x:foo/x:bar/y:baz/@z:my_namespaced_attribute' to 'false' community.general.xml: path: foo.xml xpath: /x:foo/x:bar/y:baz namespaces: x: http://x.test y: http://y.test z: http://z.test attribute: z:my_namespaced_attribute value: 'false' - name: Adding building nodes with floor subnodes from a YAML variable community.general.xml: path: /foo/bar.xml xpath: /business add_children: - building: # Attributes name: Scumm bar location: Monkey island # Subnodes _: - floor: Pirate hall - floor: Grog storage - construction_date: "1990" # Only strings are valid - building: Grog factory # Consider this XML for following example - # # # # part to remove # # # part to keep # # - name: Delete element node based upon attribute community.general.xml: path: bar.xml xpath: /config/element[@name='test1'] state: absent a2 actions: description: A dictionary with the original xpath, namespaces and state. type: dict returned: success sample: {xpath: xpath, namespaces: [namespace1, namespace2], state: present} backup_file: description: The name of the backup file that was created. type: str returned: when O(backup=true) sample: /path/to/file.xml.1942.2017-08-24@14:16:01~ count: description: The count of xpath matches. type: int returned: when parameter O(count) is set sample: 2 matches: description: The xpath matches found. type: list returned: when parameter O(print_match) is set msg: description: A message related to the performed action(s). type: str returned: always xmlstring: description: An XML string of the resulting output. type: str returned: when parameter O(xmlstring) is set N)BytesIO) LooseVersion)etree objectifyTF) AnsibleModulejson_dict_bytes_to_unicodemissing_required_lib) iteritems string_types)to_bytes to_native)MutableMappingz[a-zA-Z-][a-zA-Z0-9_\-\.]*|:z('(?:.*)'|"(?:.*)")z^(.*)/(z)$z )/text\(\)=$z ^(.*)/(@(?:z))$z))=z )\[(.*)\]$z^(.*)/text\(\)=ctjtjtjt}tjtjtj|}||k7SN)rtostringr fromstringorig_doc)docorig_objobjs i/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/community/general/plugins/modules/xml.py has_changedrsP~~i225>>(3KLMH ..--ennS.AB CC Oc|j||}g}|D]"}|j|j|$tj|}d|d|}t ||||d|y)N namespacesz selector 'z ' match: F)changedmsg)xpathappendgetpathjsondumpsfinish) moduletreer%r"match match_xpathsm match_strr$s rdo_print_matchr1sh JJuJ 4EL -DLLO,- <(I',i 8C 64 EsCrc p|jd|z|}d|z}t||||d|t|y)z. Return the count of nodes matching the xpath z count(/%s)r!zfound %d nodesF)r#r$hitcountN)r%r*int)r+r,r%r"hitsr$s r count_nodesr6s< ::lU*z: BD T !C 64 EsSQUYWrct|||r1|j||}t|dtjryy)z Test if a given xpath matches anything and if that match is a node. For now we just assume you're only searching for one specific thing.r!rTF) xpath_matchesr% isinstancer_Element)r,r%r"r-s ris_noder;s:T5*- 5Z 8 eAh / rcttdd}t|||rC|j||}t |dtj ry|t |d|ryy)zu Test if a given xpath matches and that match is an attribute An xpath attribute search will only match one item_ElementStringResultNr!rTF)getattrrr8r%r9_ElementUnicodeResult)r,r%r"ElementStringResultr-s r is_attributerAsc"%)?FT5*- 5Z 8 eAh ; ; < ,E!HFY1Z rc,|j||ryy)z Test if a node exists r!TF)r%)r,r%r"s rr8r8s zz%Jz/ rcd} |j||D]~}d}t|||r6|j}|jj |j Ht |||r |jj|utd t|||||y #t$r#}|jd|d|d Yd }~y d }~wwxYw) z, Delete an attribute or element from a tree Fr!TzImpossible errorr#zCouldn't delete xpath target:  ()r$N) r%rA getparentattribpopattrnamer;remove Exceptionr* fail_json)r+r,r%r"r#resultparentes rdelete_xpath_targetrRsGAjj:j> 4FGD%4))+ !!&//2uj1  "))&1 233 4$ vtUJ@ SqQRRSsBB** C3CCcht|D]}|j||j|yr)listrLextend)childrenr-elements rreplace_children_ofrXs-; W LLrc|j||}t|||}|Dcgc]}tj|}}d} |D]x} t t | t |k(rHt t | D]0\} } tj| || k7s"t|| d} ikt|| d} z| Scc}w)Nr!FT)r%children_to_nodesrrlenrT enumeraterX) r+r,r%r"rVin_typematchescchildren_as_stringr#r-idxrWs rset_target_children_innerrbsjj:j6G!7;H5=>%..+>>G  tE{ s8} , )$u+ 6  W>>'*.@.EE'%8"G   % 0G  N#?sCcDt||||||}t|||||y)NrD)rbr*)r+r,r%r"rVr]r#s rset_target_childrenrds''eZSZ[G 64 G?? 2;As*G4c`d|vr)|jd\}}dj|||S|S)Nr {{{0}}}{1})rformat)namer"nsnamerawnames r nsnameToClarkrIs: d{ JJsO"":f#5w?? Krc \t|\}}||k(s|.|jd|dtj|dyd}t |||st ||||}t |||r|r|D]\}}|rd|ddk7r\|dd k7rTt |t||gd } |r| D] } || _ |j|| D]} | j| d}m|rp|dd k(rh|d d} t |t| |gd } |j|| D]4} | j| | D]} |D]} t || d | z|d}6|dk(r3|j|| D]} | j|k7s|| _d}|rr|ddk(rjt|d d|}|j|| D]C} || jvxs| j||k7}|s(|xs|}|d}n|}|| j|<E|jdtj|dz|S)NzCan't process Xpath z" in order to spawn nodes! tree is T pretty_printrGFr@r|yamlr!rnz./r}zunknown tree transformation=%s) rrNrrr;check_or_make_targetrZrtextr%rUrI)r+r,r%r" inner_xpathchangesr#eoa eoa_valuerinkrjrWsubexpr attributechangingvalues rrrSs-e4['u'/#U^^Dt%LN OG 4j 1&vt[*Mt[*-' '1 q S)s1v}Q3,VmC6T5UW]^&,"+,!JJ{zJJ#DKK)"G#Q3ab',VmGZ6X5Y[ab JJ{zJJ#DKK)&Y'0YG1TG^ZXYY #G# JJ{zJJ'D Y.$- "&' Q3)#ab':> #zz+*zM :G ) ? i7>>R[C\`iCiH")"5X$,$&E$-E49y1 :  %EW[jnHo%o pc1 qf Nrc\d}t|||st||||}t|||||y)NF)r;rr*)r+r,r%r"r#s rensure_xpath_existsrs3G 4 +&vtUJG 64 G4rc d} t|||st||||}t|||s-|j d|d t j|d  |j|| D]} |s+|xs| j|k7}| j|k7s(|| _ 0|xs| j||k7}d|vr)|jd\} } dj|| | }| j||k7s| j|||S#t$rr}d}|jjrd|vrd}|j |d|d|dt j|d tj Yd}~cd}~wwxYw)NFr}rzRXML document has namespace(s) defined, but no namespace prefix(es) used in xpath! zXpath z causes a failure: z -- tree is Trr$ exceptionz$ does not reference a node! tree is rGr!r)r;rrMgetrootnsmaprNrr traceback format_excr%rgetrrset) r+r,r%r"rrr#rQmissing_namespacerWattr_ns attr_names rset_target_innerrsG GtUJ/*64 KG 4 +#U^^Dt%LN O::e :; .8',,%"7G||u$$ B'++i"8E"AGi%.__S%9"(// 70CYO {{9%. Iu- . N7 G <<>  Cu$4 u /5>>$]a;bdoxpDpDpF  G G GsD FA'FFcBt||||||}t|||||yr)rr*)r+r,r%r"rrr#s r set_targetrs&vtUJ 5QG 64 G4rc t|||s|jd|zg}|j||D])}|j|j|j i+t ||||dt|t||yNz#Xpath %s does not reference a node!rGr!F)r#r$r3r^)r;rNr%r&tagrr*r[)r+r,r%r"elementsrWs rget_element_textrs 4 +BUJKH::e :;5gll345 64 Es8}WZ[cWdnvwrc vt|||s|jd|zg}|j||D]Z}i}|jD]&}|j |}|j ||i(|j |j|i\t||||dt|t||yr) r;rNr%keysrupdater&rr*r[) r+r,r%r"rrWrtkeyrs rget_element_attrrs 4 +BUJKH::e :;.<<> 'CKK$E LL#u & ' e,- . 64 Es8}WZ[cWdnvwrc|dk(rQtt|d} tj}tj||}|j S|dk(r0t|trtj|St|trt|dkDr|jdtt|\}}t|trw|jd d} tj||}| Kt| t s|jd t#| zt%|| } |j'| |Stj|}||_|S|jd t#|zy|jd |zy#tj $r}|jd|zYd}~yd}~wwxYw) Nxmlsurrogate_or_stricterrorsz%Error while parsing child element: %srGrrnz1Can only create children from hashes with one key_z(Invalid children type: %s, must be list.zBInvalid child type: %s. Children must be either strings or hashes.z>Invalid child input type: %s. Type must be either xml or yaml.)rrr XMLParserparserXMLSyntaxErrorrNr9rElementrr[nextr rJrTtyperZrUr) r+rtr]infileparserrjrQrrrVsubnodess rchild_to_elementrs%%0EFG N__&F;;vv.D<<> ! F  e\ *==' ' ~ .5zA~  %X Y % 01LS%%0 99S$/}}S%0'%h5((-WZ^_gZh-h(i0BHKK)K}}S)! K   !ehlmrhs!s  t]`ggh9## N   !H1!L  M M Ns9F##G6GGcN|gn|}|Dcgc]}t|||c}Scc}w)z8turn a str/hash/list of str&hash into a list of elements)r)r+rVrrts rrZrZ s,%r8H?G He VUD 1 HH Hs"cNtj|dd|jd}td}|jdr|jd}t |d5}||j k7rcd|d <|j sR|jd r!|j|jd|d <|j|dd|jddddn+|jd r||d <||jd k7rd|d <|jd i|y#1swYxYw)NTUTF-8rxml_declarationencodingrFrDpathrbr#backup backup_file xmlstringrv) rrparamsdictopenread check_mode backup_localwrite exit_json)r+r, xml_stringrOxml_file xml_contents r make_prettyrs-dW[a[h[hiw[xyJ F}}V==( (D ! }[[--//$(y!((}}X.060C0CFMMRXDY0Z}-JJx^d^k^klz^{J|  } } { #({ {3 3 $F9 Fv } }s A7DD$r}c tt|||jdt|}|jds|r||d<|jds|r||d<|r||d<|dr|jrBtt j t d d d t j |d d d  |d <|jdrk|js_|jdr!|j|jd|d<|j|jdd d |jd |jdr)t j |d d |jd |d<|jdi|y)Nstate)r%r"r)actionsr#count print_matchr^r$r#Trr)beforeafterdiffrrrrrrv) rrr_diffrrrrrrr) r+r,r%r"r#r$r3r^rOs rr*r*+sr !--( D! F}}W"w }}]#w#y u  i <<!~~hweijnnT4'`deF6N == ):):}}X&(.(;(;FMM&|d<|d=3Yd}~d}~wwxYw#tj0$r(}|j d@|xsdAd<|d=3Yd}~d}~wwxYw#|r|j3wwxYw)DNrdestfile)raliasesrstr)rr%r"r)rdefaultrpresentabsentensure)rrchoicesrrrawr add_childrenrT)rr set_childrenrboolFrrrr)rr input_typerr)rrrrstrip_cdata_tagsrgrhT)rrrrr)rrrrrrr)rrrrrr) argument_specsupports_check_mode required_by required_ifrequired_one_ofmutually_exclusivelxmlr.c32K|]}t|ywrr.0fs r zmain..Hy|Hz2.3.0zTThe xml ansible module requires lxml 2.3.0 or newer installed on the managed machinerGc32K|]}t|ywrrrs rr zmain..r r z3.0.0z[Using lxml version lower than 3.0.0 does not guarantee predictable element attribute order.rrrz*The target XML source '%s' does not exist.z"Syntax error in xpath expression: rErFz&Evaluation error in xpath expression: )remove_blank_text strip_cdatazError while parsing document: rzDon't know what to dorv)'r rrr HAS_LXMLrNr LXML_IMP_ERRrjoinr LXML_VERSIONwarnrrosrisfilerXPathXPathSyntaxErrorXPathEvalErrorrrrclosecopydeepcopyrr1r6rrrRrdrkrrr)r+rrr%r"rrrrrrrrrrrrrgrhrrQrrs rmainrQs  6FF+;< & E" 4  E9x>S^f]gh  E"  & 6E: 6E: FE2 &%8 659 ek6-BC P VU3 "vu=! "659# $&%8% (!!iI!)  dWI & D7) , TG9 - D7) ,  [ ! h Y [ ! ] + O,F\}}V$H{+J MM' "E|,J MM' "E &v}}W'= >E k*I-fmmN.KLL-fmmN.KLL==0LmmI&G|,J-- .K MM' "E ]]8 $F}}%78==0L-- .K 1&9\R chhHU5G5GHH ILY`La ast chhHU5G5GHH ILY`La a qr F Xj9NOPF WW^^H %(D)F   !MPX!X  Y   c E" j__|QabF++ff-C  LLN}}S!HvsE:6 FC 3+eZ8 F eZ8 FC ;FC L*UFC L*Vbdop  63z9eD FC ;FC  01})) _  TY[\%] ^^'' c  X]_`%a bb c## j   HLdXdLdfg!h  i i j  LLN sgAU8S 3-T: T7S=7U8=T7T2,U82T77U8:U5 U0*U80U55U88V __main__)NNr)K __future__rrrr __metaclass__ DOCUMENTATIONEXAMPLESRETURNrr(rreriorBansible_collections.community.general.plugins.module_utils.versionrrrrr r ImportErrorransible.module_utils.basicr r r ansible.module_utils.sixr r+ansible.module_utils.common.text.convertersrr/ansible.module_utils.common._collections_compatr_IDENT_NSIDENT_XPSTRcompilerrrrrrrr1r6r;rAr8rRrXrbrdrkrfrxrrrrrrrrrrZrtupler*r__name__rvrrr1s CB W r` D < [ %H gf<KJ & C<& 3 & / ! bjjX!5!<='RZZ H(<(NQW(WZ](]^$"**]X%=%EF!+MH,Du,Lv,UX[,[!\2::i(2^CD!rzz"5">"DE DX $A2 2= 0  BAH5!H5 x x$iNI45:rAW\W^#LV2r zFk'9'')LHs E55FF