VhU`ddlmZmZmZeZddlmZeddZeddZ GddZ y ) )absolute_importdivisionprint_function) namedtupleKVPairz key valueItemz index detailsceZdZddZedZdZddZddZddZ ddZ dd Z dd Z dd Z dd Zdd ZddZddZddZddZddZddZddZddZddZddZddZddZy) MSOSchemaNc||_||_|rE|j|\|_|_|_|j j d|_n$|j|\|_|_|_i|_||_ ||_ |jr|j|jn'|jr|j|j|r*|jr|j|j|yyy)N displayName)mso schema_namequery_schema_by_ididpathschemaget query_schemaschema_objects template_id template_nameset_template_from_id set_templateset_site)self mso_modulerr site_name schema_idrs i/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/mso/plugins/module_utils/schema.py__init__zMSOSchema.__init__s& .8.K.KI.V +DGTY #{{}=D .8.E.Ek.R +DGTY  &*     % %d&6&6 7      d00 1 ++ MM$,,i 8,9cdtfdt|Dd}|Dcgc]$}D]}|j|j&}}}||fScc}}w)a Get the first matched object from a list of mso object dictionaries. :param search_list: Objects to search through -> List. :param kv_list: Key/value pairs that should match in the object. -> List[KVPair(Str, Str)] :return: The index and details of the object. -> Item (Named Tuple) Values of provided keys of all existing objects. -> List c,tfd|DS)Nc3nK|],}j|j|jk(.ywN)rkeyvalue).0kvitems r zCMSOSchema.get_object_from_list..kv_match../s'C(BHH4Cs25)all)kvsr*s `rkv_matchz0MSOSchema.get_object_from_list..kv_match.sCsCD Dr!c3PK|]\}}|st||ywr%)r)r(indexr*kv_listr.s rr+z1MSOSchema.get_object_from_list..1s(mKE4U]^egkUld5$'ms&&N)next enumeraterr&) search_listr1matchr*r)existingr.s ` @rget_object_from_listzMSOSchema.get_object_from_list$s` Em9[;Qmost1<OwODHHRVV$O$OOhPs)Ac|D]W}||jjvs dj||j}|jj |Yy)z Validate that attributes are set to a value that is not equal None. :param required_schema_objects: List of schema objects to verify. -> List :return: None zJRequired attribute '{0}' is not specified on schema instance with name {1}msgN)rkeysformatrr fail_json)rrequired_schema_objects schema_objectr:s rvalidate_schema_objects_presentz)MSOSchema.validate_schema_objects_present5sd 5 ,MD$7$7$<$<$>>biijwy}zJzJK""s"+ ,r!cZtd|g}|j|jjd|\}}|s?|r=dj |dj |}|j j||jjd|_ ||jd<y) a Get template item that matches the name of a template. :param template_name: Name of the template to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template item. -> Item(Int, Dict) | None name templatesz>Provided template '{0}' not matching existing template(s): {1}, r9 templateIDtemplateN) rr7rrr<joinr r=detailsrr)rr fail_moduler1r5r6r:s rrzMSOSchema.set_template@s&-0133DKKOOK4PRYZxRYYZgimirirs{i|}C HH  3  ' ==,,\:*/J'r!cZtd|g}|j|jjd|\}}|s?|r=dj |dj |}|j j||jjd|_ ||jd<y) a Get template item that matches the id of a template. :param template_id: ID of the template to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template item. -> Item(Int, Dict) | None rErCzAProvided template ID '{0}' not matching existing template(s): {1}rDr9rBrFN) rr7rrr<rGr r=rHrr)rrrIr1r5r6r:s rrzMSOSchema.set_template_from_idPs, 4533DKKOOK4PRYZxU\\]hjnjsjst|j}~C HH  3  '"]]..v6*/J'r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) a Get template VRF item that matches the name of a VRF. :param vrf: Name of the VRF to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template VRF item. -> Item(Int, Dict) | None rFrBvrfsz4Provided VRF '{0}' not matching existing VRF(s): {1}rDr9 template_vrfN r@rr7rrHrr<rGr r=)rvrfrIr1r5r6r:s rset_template_vrfzMSOSchema.set_template_vrf_ ,,j\:&#&'33D4G4G 4S4[4[4_4_`f4gipqxHOOPSUYU^U^_gUhiC HH  3  '.3N+r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) a Get template VRF RP item that matches the ip of a VRF RP. :param ip: IP of the RP to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template VRF RP item. -> Item(Int, Dict) | None rM ipAddress rpConfigsz2Provided IP '{0}' not matching existing IP(s): {1}rDr9template_vrf_rpNrN)riprIr1r5r6r:s rset_template_vrf_rpzMSOSchema.set_template_vrf_rpns ,,n-=>+r*+33D4G4G4W4_4_4c4cdo4pryzxFMMbRVR[R[\dRefC HH  3  '16-.r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) a Get template bridge domain item that matches the name of a bd. :param bd: Name of the bd to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template bd item. -> Item(Int, Dict) | None rFrBbdsz2Provided BD '{0}' not matching existing bd(s): {1}rDr9 template_bdNrN)rbdrIr1r5r6r:s rset_template_bdzMSOSchema.set_template_bd}s ,,j\:&"%&33D4G4G 4S4[4[4_4_`e4fhopxFMMbRVR[R[\dRefC HH  3  '-2M*r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y ) aQ Get template bridge domain dhcp relay policy item that matches the name of a bd. :param relay_policy_ref: Reference of the relay policy to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template bd relay policy item. -> Item(Int, Dict) | None rFrefrZ dhcpLabelszZProvided Relay Policy Reference '{0}' not matching existing relay policy reference(s): {1}rDr9template_bd_dhcp_relay_policyNrN)rrelay_policy_refrIr1r5r6r:s r!set_template_bd_dhcp_relay_policyz+MSOSchema.set_template_bd_dhcp_relay_policys ,,j\:%!12333D4G4G 4V4^4^4b4bco4pryzxnuuwGIMIRIRS[I\]C HH  3  '?D; Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template anp item. -> Item(Int, Dict) | None rFrBanpsz4Provided ANP '{0}' not matching existing anp(s): {1}rDr9 template_anpNrN)ranprIr1r5r6r:s rset_template_anpzMSOSchema.set_template_anprQr!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) a Get template endpoint group item that matches the name of an epg. :param epg: Name of the epg to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template epg item. -> Item(Int, Dict) | None rerBepgsz4Provided EPG '{0}' not matching existing epg(s): {1}rDr9template_anp_epgNrN)repgrIr1r5r6r:s rset_template_anp_epgzMSOSchema.set_template_anp_epgs ,,n-=>&#&'33D4G4G4W4_4_4c4cdj4kmtuxHOOPSUYU^U^_gUhiC HH  3  '27./r!cp|jdgtd|td|g}|j|jdjj d|\}}|s@|r>dj ||dj|}|jj|||jd<y ) a Get template endpoint group contract item that matches the reference and type of an contract. :param contract_ref: Reference of the contract to match. -> Str :param relation_type: Relation_type of the contract to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template epg item. -> Item(Int, Dict) | None rj contractRefrelationshipTypecontractRelationshipszXProvided Contract Reference '{0}' with type '{1}' not matching existing contacts(s): {2}rDr9template_anp_epg_contractNrN)r contract_ref relation_typerIr1r5r6r:s rset_template_anp_epg_contractz'MSOSchema.set_template_anp_epg_contracts ,,.@-AB-6?QS`8ab33D4G4GHZ4[4c4c4g4gh5ACJKxlssmTYYx-@C HH  3  ';@78r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) aN Get template endpoint group item that matches the name of an EPG uSeg Attribute. :param useg_attr: Name of the EPG uSeg Attribute to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template EPG uSeg Attribute item. -> Item(Int, Dict) | None rjrB uSegAttrszPProvided uSeg Attribute '{0}' does not match the existing uSeg Attribute(s): {1}rDr9template_anp_epg_useg_attributeNrNr useg_attrrIr1r5r6r:s rset_template_anp_epg_useg_attrz(MSOSchema.set_template_anp_epg_useg_attrs ,,.@-AB&),-33D4G4GHZ4[4c4c4g4ghs4tv}~xdkkluw{xAxABJxKLC HH  3  'AF=>r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) aF Get template endpoint group annotation that matches the key of an EPG annotation. :param useg_attr: Key of the EPG Annotation to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template EPG Annotation item. -> Item(Int, Dict) | None rjtagKeytagAnnotationszLProvided Annotation Key '{0}' does not match the existing Annotation(s): {1}rDr9template_anp_epg_annotationNrN)rannotation_keyrIr1r5r6r:s rset_template_anp_epg_annotationz)MSOSchema.set_template_anp_epg_annotations ,,.@-AB(N3433D4G4GHZ4[4c4c4g4ghx4y|CDx`gghvx|yByBCKyLMC HH  3  '=B9:r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) a Get template external epg item that matches the name of an anp. :param anp: Name of the anp to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Template anp item. -> Item(Int, Dict) | None rFrB externalEpgszFProvided External EPG '{0}' not matching existing external_epg(s): {1}rDr9template_external_epgNrN)r external_epgrIr1r5r6r:s rset_template_external_epgz#MSOSchema.set_template_external_epgs ,,j\:&,/033D4G4G 4S4[4[4_4_`n4oqxyxZaabnptpypy{CqDEC HH  3  '7<34r!c |jjds7dj|j}|jj |t d|jj|t d|g}|j|jjd|\}}|sF|rDdj||dj|dd d }|jj |||jd <y ) aK Get site item that matches the name of a site. :param template_name: Name of the template to match. -> Str :param site_name: Name of the site to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site item. -> Item(Int, Dict) | None siteszdNo sites associated with schema '{0}'. Associate the site with the schema using (M) mso_schema_site.r9siteId templateNamezjProvided site '{0}' not associated with template '{1}'. Site is currently associated with template(s): {2}rDNsite) rrr<rr r=r lookup_siter7rGr)rrrrIr:r1r5r6s rrzMSOSchema.set_sites{{w'xAEAQAQRC HH  3  '(DHH$8$8$CDf^]jFkl33DKKOOG4LgVx~FF=$))HQTTN*CC HH  3  '&+F#r!c |jddgtd|jj|j|j dj jd|g}|j|j dj jd|\}}|s?|r=dj|dj|}|jj| ||j d <y ) a Get site bridge domain item that matches the name of a bd. :param bd_name: Name of the bd to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site bd item. -> Item(Int, Dict) | None rFrbdRefrB)rrFr[rYz7Provided BD '{0}' not matching existing site bd(s): {1}rDr9site_bdN) r@rr bd_refrrrHrr7r<rGr=)rbd_namerIr1r5r6r:s r set_site_bdzMSOSchema.set_site_bd s ,,j&-AB'488??TWWtObObcmOnOvOvOzOz|BPCHO?$PQR33D4G4G4O4W4W4[4[\a4bdklxKRRSZ\`\e\efn\opC HH  3  ').I&r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) a Get site bridge domain subnet item that matches the ip of a subnet. :param subnet: Subnet (ip) to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site bd subnet item. -> Item(Int, Dict) | None rrVsubnetszBProvided subnet '{0}' not matching existing site bd subnet(s): {1}rDr9site_bd_subnetNrN)rsubnetrIr1r5r6r:s rset_site_bd_subnetzMSOSchema.set_site_bd_subnets ,,i[9$'(33D4G4G 4R4Z4Z4^4^_h4ikrsxV]]^dfjfofopxfyzC HH  3  '05,-r!c|jddgtd|jdjj dg}|j |jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y ) a Get site application profile item that matches the name of a anp. :param anp_name: Name of the anp to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site anp item. -> Item(Int, Dict) | None reranpRefrdz9Provided ANP '{0}' not matching existing site anp(s): {1}rDr9site_anpN r@rrrHrr7r<rGr r=)ranp_namerIr1r5r6r:s r set_site_anpzMSOSchema.set_site_anp+s ,,nf-EF(D$7$7$G$O$O$S$ST\$]^_33D4G4G4O4W4W4[4[\b4celmxMTTU]_c_h_hiq_rsC HH  3  '*/J'r!c|jddgtd|jdjj dg}|j |jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y ) z Get site anp epg item that matches the epgs. :param epg: epg to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site anp epg item. -> Item(Int, Dict) | None rrjepgRefriz=Provided EPG '{0}' not matching existing site anp epg(s): {1}rDr9 site_anp_epgNr)repg_namerIr1r5r6r:s rset_site_anp_epgzMSOSchema.set_site_anp_epg:s ,,j:L-MN(D$7$78J$K$S$S$W$WX`$abc33D4G4G 4S4[4[4_4_`f4gipqxQXXYacgclclmucvwC HH  3  '.3N+r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) aF Get site endpoint group item that matches the name of an EPG uSeg Attribute. :param useg_attr: Name of the EPG uSeg Attribute to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site EPG uSeg Attribute item. -> Item(Int, Dict) | None rrBrvzZProvided Site uSeg Attribute '{0}' does not match the existing Site uSeg Attribute(s): {1}rDr9site_anp_epg_useg_attributeNrNrxs rset_site_anp_epg_useg_attrz$MSOSchema.set_site_anp_epg_useg_attrIs ,,n-=>&),-33D4G4G4W4_4_4c4cdo4pryzxnuuvBFBKBKLTBUVC HH  3  '=B9:r!c |jddgtd|jj|j|j dj jd|g}|j|j dj jd|\}}|s?|r=dj|dj|}|jj| ||j d <y ) a% Get site contract item that matches the name of a contract. :param contract_name: Name of the contract to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site contract item. -> Item(Int, Dict) | None rFrrnrB)rrFcontract contractszCProvided Contract '{0}' not matching existing site contract(s): {1}rDr9 site_contractN) r@rr rrrrrHrr7r<rGr=)r contract_namerIr1r5r6r:s rset_site_contractzMSOSchema.set_site_contractXs ,,j&-AB txx44twwQUQdQdeoQpQxQxQ|Q|~DREP]4 ^   33D4G4G4O4W4W4[4[\g4hjqrxW^^_lnrnwnwyAoBCC HH  3  '/4O,r!c |jddgtd|jj|j|j dj jd|g}|j dj jd}|j||\}}|s?|r=dj|dj|}|jj| ||j d <y ) a+ Get site item that matches the name of a service graph. :param service_graph: Name of the service graph to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site service graph item. -> Item(Int, Dict) | None rFrserviceGraphRefrB)rrF service_graph serviceGraphszRProvided Site Service Graph '{0}' not matching existing site service graph(s): {1}rDr9site_service_graphN) r@rr service_graph_refrrrHrr7r<rGr=)rrrIr1r5r6r:s rset_site_service_graphz MSOSchema.set_site_service_graphks ,,j&-AB !**TWWtGZGZ[eGfGnGnGrGrsyGzK]*^  "008@@DD_U334FPxfmmoACGCLCLMUCVWC HH  3  '4901r!cX|jdgtd|g}|j|jdjj d|\}}|s?|r=dj |dj|}|jj|||jd<y) a/ Get site anp epg static port path item that matches the path of Static Port. :param path: Path of the Static Port to match. -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: Site anp epg item. -> Item(Int, Dict) | None rr staticPortszNProvided Static Port Path '{0}' not matching existing static port path(s): {1}rDr9site_anp_epg_static_portNrN)rrrIr1r5r6r:s rset_site_anp_epg_static_portz&MSOSchema.set_site_anp_epg_static_ports ,,n-=>&$'(33D4G4G4W4_4_4c4cdq4rt{|xbiijnptpypy{CqDEC HH  3  ':?67r!)NNNN)T)__name__ __module__ __qualname__r staticmethodr7r@rrrPrWr\rbrgrlrtrzrrrrrrrrrrrr!rr r s9$ ,0 0 4 7 3 E 4 8A$ G C =,* / 6 0 4 C5&:. @r!r N) __future__rrrtype __metaclass__ collectionsrrrr rr!rrs<A@ " Hk *&/*~@~@r!