VhiddlmZmZmZeZddlmZddlm Z ddl m Z e ddZ e ddZ e d d ZGd d Zy ))absolute_importdivisionprint_function)TEMPLATE_TYPES)generate_api_endpoint) namedtupleKVPairz key valueItemz index details SearchQueryz key kv_pairsceZdZddZedZdZddZddZdZ dZ d Z d Z dd Z d Zdd ZddZddZddZddZdZdZddZddZddZdZdZy) MSOTemplateNc||_d|_dj|j|_i|_d|_||_||_||_i|_ i|_ |rp|jj|j|j|_ |jrdj|j|j|_|jj|j |_|jjd|_|jjd|_n|jjdj|j|jj|jDcgc]2}d j|jd |jd 4c} nw|r|s|jjd |jj|j|j t |d|_ |jrdj|j|jjd |_|jj|j |_|jjd |_|jjd|_nc|r7|jj|jt |d|_n*|jj|j|_t#|jt$r$dD]}|jj'|d yycc}w)N templatesz {0}/summaries) templateIdz{0}/{1} displayName templateTypezBProvided template id '{0}' does not exist. Existing templates: {1}zTemplate '{0}' with id '{1}' templateNamermsgz8Template type must be provided when using template name. template_type)rr)r)_updateVersionversion)msotemplates_pathformatsummaries_pathtemplate template_path template_name template_idrtemplate_summarytemplate_objects_cacheget_obj query_objget fail_json query_objsr isinstancedictpop)self mso_modulerr r!rkeys k/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/mso/plugins/module_utils/template.py__init__zMSOTemplate.__init__s)-44T5H5HI *&* "&(# $(HH$4$4T5H5HUYUeUe$4$fD !$$%.%5%5d6I6I4K[K[%\" $ 2 243E3E F %)]]%6%6}%E"%)]]%6%6~%F"""\cc((-1HH,?,?@S@S,T (;AA(,,~B^`h`l`lmy`z{# ""'a"b$(HH$4$4##$2D2DSaboSprATB%5%D !$$%.%5%5d6I6I4K`K`KdKdeqKr%s" $ 2 243E3E F #'==#4#4\#B %)]]%6%6~%F"  HH//0C0CR`anRopSA/BDM HH//0C0CDDM dmmT *4 - !!#t, - +1s7N cdtfdt|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)r&r.value).0kvitems r/ zEMSOTemplate.get_object_from_list..kv_match..Ss'C(BHH4Cs25)all)kvsr8s `r/kv_matchz2MSOTemplate.get_object_from_list..kv_matchRsCsCD Dc3PK|]\}}|st||ywr4)r )r6indexr8kv_listr<s r/r9z3MSOTemplate.get_object_from_list..Us(mKE4U]^egkUld5$'ms&&N)next enumerater&r.) search_listr@matchr8r7existingr<s ` @r/get_object_from_listz MSOTemplate.get_object_from_listHs` Em9[;Qmost1<OwODHHRVV$O$OOhPs)AcN|jrt|jts5|jj dj |j |jjd|k7r,|jj dj |yy)zk Validate that attributes are set to a value that is not equal None. :return: None zTemplate '{0}' not found.rrzTemplate type must be '{0}'.N)rr)r*rr'rr r&)r,rs r/validate_templatezMSOTemplate.validate_templateYs| }}Jt}}d$C HH  #>#E#EdFXFX#Y  Z ==  ^ , = HH  #A#H#H#W  X >r=c|j||\}}|s@|r>dj||dj|}|jj ||S)a Get the object from a list of mso object dictionaries by name. :param object_description: Description of the object to search for -> Str :param search_list: Objects to search through -> List. :param kv_list: Key/value pairs that should match in the object. -> List[KVPair(Str, Str)] :param fail_module: When match is not found fail the ansible module. -> Bool :return: The object. -> Dict | None z Str :param search_list: Objects to search through -> List. :param uuid: UUID of the object to search for -> Str :param fail_module: When match is not found fail the ansible module. -> Bool :return: The object. -> Dict | None uuid)r rM)r,rKrCrOrLr@s r/get_object_by_uuidzMSOTemplate.get_object_by_uuidrs-&$'(112DkSZ\ghhr=c|jjdijdijdg}td|g}|jd||d}|jjdS) Get the UUID of a VLAN pool by name. :param vlan_pool_name: Name of the VLAN pool to search for -> Str :return: UUID of the VLAN pool. -> Str fabricPolicyTemplater vlanPoolsname VLAN PoolTrLrOrr&r rMdetails)r,vlan_pool_nameexisting_vlan_poolsr@rDs r/get_vlan_pool_uuidzMSOTemplate.get_vlan_pool_uuid~z #mm//0FKOOPZ\^_ccdoqst&.1222;@SU\jn2o}}  ((r=c|jjdijdijdg}td|g}|jd||d}|jjdS) rRrSrrTrOrVTrWrUrX)r,vlan_pool_uuidr[r@rDs r/get_vlan_pool_namezMSOTemplate.get_vlan_pool_namer]r=c|rn|rl|rj|j|td|td|g}|dr|djS|jj dj |||yiS)a Retrieves the details of a specific route map object based on the provided attributes. :param attr_name: The attribute name for error messaging. -> Str :param tenant_id: The ID of the tenant. -> Str :param tenant_name: The name of the tenant. -> Str :param route_map: The name of the route map. -> Str :param route_map_objects: The list of route map objects to search from. -> List :return: The details of the route map object if found, otherwise an empty dictionary. -> Dict rUtenantIdrz;Provided Route Map {0}: {1} with the tenant: {2} not found.rN)rFr rYrr'r)r, attr_name tenant_id tenant_name route_maproute_map_objectsroute_map_objects r/ get_route_mapzMSOTemplate.get_route_maps '8#88! *F:y,IJ   "'*222""'d'k'kluxACN(O"PIr=ct|fid|dd}|jj|}td|j dtd|j dtd|j dtd |g}|j ||}|d r|d S|jj d j|j d y )aV Get VRF object based on provided parameters. :param vrf_dict: Dictionary containing VRF details. -> Dict :param tenant_id: Id of the tenant. -> Str :param templates_objects_path: Path to the templates objects. -> Str :return: VRF object if found, otherwise fail with an error message. -> Dict vrftrue)typez tenant-idzinclude-commonrUrr schemaNameschemarbrzProvided VRF {0} not found.rN)rrr(r r&rFr'r)r,vrf_dictrdtemplates_objects_pathvrf_path vrf_objects vrf_kv_list vrf_objects r/get_vrf_objectzMSOTemplate.get_vrf_objects))?FE`i~DDEFhh))(3 68<</ 0 >8<< #; < <h!7 8 :y )  ..{KH a=a= HH  #@#G#G U[H\#]  ^r=c|jjdijdijdg}|s|r3|jd||rtd|g|Std|g|S|S)a Get the L3Out Node Routing Policy by UUID or Name. :param uuid: UUID of the L3Out Node Routing Policy to search for -> Str :param name: Name of the L3Out Node Routing Policy to search for -> Str :param fail_module: When match is not found fail the ansible module -> Bool :return: Dict | None | List[Dict] | List[]: The processed result which could be: When the UUID | Name is existing in the search list -> Dict When the UUID | Name is not existing in the search list -> None When both UUID and Name are None, and the search list is not empty -> List[Dict] When both UUID and Name are None, and the search list is empty -> List[] tenantPolicyTemplaterl3OutNodePolGroupszL3Out Node Routing PolicyrOrUrr&rMr )r,rOrUrL"existing_l3out_node_routing_policys r/$get_l3out_node_routing_policy_objectz0MSOTemplate.get_l3out_node_routing_policy_objects.2]]->->?UWY-Z-^-^_ikm-n-r-rtHJL.M* 455+-OjnRXY_aeRfRJLW tz|BDHuIRJLW 21r=c|jjdijdijdg}td|g}|jd||d}|jjdS) z Get the UUID of an Interface Policy Group by name. :param interface_policy_group: Name of the Interface Policy Group to search for -> Str :return: UUID of the Interface Policy Group. -> Str rSrinterfacePolicyGroupsrUzInterface Policy GroupsTrWrOrX)r,interface_policy_groupexisting_policy_groupsr@rDs r/get_interface_policy_group_uuidz+MSOTemplate.get_interface_policy_group_uuids "&!2!23I2!N!R!RS]_a!b!f!fg~AC"D&"89:223LNdfm{2A}}  ((r=c|jjdijdijdg}|s|r.|jd||r td|n td|g|S|S)a Get the IPSLA Monitoring Policy by UUID or Name. :param uuid: UUID of the IPSLA Monitoring Policy to search for -> Str :param name: Name of the IPSLA Monitoring Policy to search for -> Str :param fail_module: When match is not found fail the ansible module -> Bool :return: Dict | None | List[Dict] | List[]: The processed result which could be: When the UUID | Name is existing in the search list -> Dict When the UUID | Name is not existing in the search list -> None When both UUID and Name are None, and the search list is not empty -> List[Dict] When both UUID and Name are None, and the search list is empty -> List[] rxripslaMonitoringPolicieszIPSLA Monitoring PolicyrOrUrWrz)r,rOrUrLexisting_ipsla_policiess r/get_ipsla_monitoring_policyz'MSOTemplate.get_ipsla_monitoring_policys#'--"3"34JB"O"S"ST^`b"c"g"giBDF#G 455)')-%6&$3GH' 6  '&r=c|jjdijdg}|s|r3|jd||rtd|g|Std|g|S|S)a Get the L3Out by uuid or name. :param uuid: UUID of the L3Out to search for -> Str :param name: Name of the L3Out to search for -> Str :param fail_module: When match is not found fail the ansible module -> Bool :return: Dict | None | List[Dict] | List[]: The processed result which could be: When the UUID | Name is existing in the search list -> Dict When the UUID | Name is not existing in the search list -> None When both UUID and Name are None, and the search list is not empty -> List[Dict] When both UUID and Name are None, and the search list is empty -> List[] l3outTemplatel3outsL3OutrOrUrz)r,rOrUrLexisting_l3outss r/get_l3out_objectzMSOTemplate.get_l3out_objects--++OR@DDXrR 455gimQWX^`dQeQIKVW Wsy{ACGtHQIKVW Wr=cl|jdg}|r|jd|td|g|S|S)a Get the L3Out Node Group Policy by name. :param name: Name of the L3Out Node Group Policy to search for -> Str :param l3out_object: L3Out object to search Node Group Policy -> Dict :param fail_module: When match is not found fail the ansible module -> Bool :return: Dict | None | List[Dict] | List[]: The processed result which could be: When the Name is existing in the search list -> Dict When the Name is not existing in the search list -> None When the Name is None, and the search list is not empty -> List[Dict] When the Name is None, and the search list is empty -> List[] nodeGroupszL3Out Node Group PolicyrU)r&rMr )r,rU l3out_objectrLexisting_l3out_node_groupss r/get_l3out_node_groupz MSOTemplate.get_l3out_node_groups]&2%5%5lB%G" 556OQkntu{~BoCnDFQR R))r=c|jjdijdijdg}|s|r3|jd||rtd|g|Std|g|S|S)a Get the Fabric Node Settings by uuid or name. :param uuid: UUID of the Node Setting to search for -> Str :param name: Name of the Node Setting to search for -> Str :param fail_module: When match is not found fail the ansible module -> Bool :return: Dict | None | List[Dict] | List[]: The processed result which could be: When the UUID | Name is existing in the search list -> Dict When the UUID | Name is not existing in the search list -> None When both UUID and Name are None, and the search list is not empty -> List[Dict] When both UUID and Name are None, and the search list is empty -> List[] rSrnodePolicyGroupsz Node SettingsrOrUrz)r,rOrUrLexisting_objectss r/get_node_settings_objectz$MSOTemplate.get_node_settings_objects ==,,-CRHLLZY[\``asuwx 455oGWrvZ`agimZnZRT_` `}CDJLP}QZRT_` `r=c|jjdijdijdg}|s|r3|jd||rtd|g|Std|g|S|S)a Get the L3Out Interface Routing Policy by UUID or Name. :param uuid: UUID of the L3Out Interface Routing Policy to search for -> Str :param name: Name of the L3Out Interface Routing Policy to search for -> Str :param fail_module: When match is not found fail the ansible module -> Bool :return: Dict | None | List[Dict] | List[]: The processed result which could be: When the UUID | Name is existing in the search list -> Dict When the UUID | Name is not existing in the search list -> None When both UUID and Name are None, and the search list is not empty -> List[Dict] When both UUID and Name are None, and the search list is empty -> List[] rxrl3OutIntfPolGroupszL3Out Interface Routing PolicyrOrUrz)r,rOrUrL'existing_l3out_interface_routing_policys r/)get_l3out_interface_routing_policy_objectz5MSOTemplate.get_l3out_interface_routing_policy_object*s37--2C2CDZ\^2_2c2cdnpr2s2w2wyMOQ3R/ 45507)-%H  4:&$3GH   76r=c|jjdijdij|g}|j||td|gd}|jjdS)a4 Get the UUID of a Tenant Policy by name. :param tenant_template: The tenant object -> Dict :param policy_name: Name of the policy -> Str :param policy_type: The type of the policy specified in the API response -> Str :return: UUID of the tenant policy -> Str rxrrUTrWrO)rr&rMr rY)r,tenant_template policy_name policy_typeexisting_policiesrDs r/get_tenant_policy_uuidz"MSOTemplate.get_tenant_policy_uuid@s,44889OQSTXXYceghllmxz|}22;@QTZ[acnToSpC2D}}  ((r=ci|_yr4)r#)r,s r/clear_template_objects_cachez(MSOTemplate.clear_template_objects_cacheLs &(#r=cP|j|||}|r|jdSy)a1 Retrieve the name of a specific object type in the MSO template using its UUID. :param mso: An instance of the MSO class, which provides methods for making API requests -> MSO Class instance :param object_type: The type of the object to retrieve the name for -> Str :param uuid: The UUID of the object to retrieve the name for -> Str :return: Str | None: The processed result which could be: When the UUID is existing, returns object name -> Str When the UUID is not existing -> None rUN)get_template_object_by_uuidr&)r, object_typerOrLresponse_objects r/ get_template_object_name_by_uuidz,MSOTemplate.get_template_object_name_by_uuidOs1::;kZ "&&v. . r=c@d}|r,||jjvr|j|}n;|jjdj ||d}||j|<|s0|r.dj ||}|jj ||S)a Retrieve a specific object type in the MSO template using its UUID. :param object_type: The type of the object to retrieve -> Str :param uuid: The UUID of the object to retrieve -> Str :param use_cache: Use the cached result of the templates/objects API for the UUID -> Bool :return: Dict | None: The processed result which could be: When the UUID is existing, returns object -> Dict When the UUID is not existing -> None Nz#templates/objects?type={0}&uuid={1}GETz*Provided {0} with UUID of '{1}' not found.r)r#keysrrequestrr')r,rrOrL use_cacherrs r/rz'MSOTemplate.get_template_object_by_uuid]s !EEkSWXC HH  3  'r=c \|r6|jr|j|d<|jr|j|d<|rp|jD]Z}|j|jds%|j |jd|j|jdd|}|jd||jd<|jdr#|jd||jd<|jdr#|jd||jd<|jdr#|jd||jd<|jd s8|jd ||jd <]|S|S) a Return the updated config_data with the template values and reference_collections if provided :param config_data: The original config_data that requires to be updated -> Dict :param reference_collections: A dict containing the object type, references and the corresponding names -> Dict :param set_template: Adds the templateId and templateName to the config_data -> Bool :param use_cache: Use the cached result of the templates/objects API for the ref UUID -> Bool :return: Updated config_data with names for references -> Dict Example 1: reference_collections = { "qos": { "name": "qosName", "reference": "qosRef", "type": "qos", "template": "qosTemplateName", "templateId": "qosTemplateId", }, "interfaceRoutingPolicy": { "name": "interfaceRoutingPolicyName", "reference": "interfaceRoutingPolicyRef", "type": "l3OutIntfPolGroup", "template": "interfaceRoutingPolicyTemplateName", "templateId": "interfaceRoutingPolicyTemplateId", }, } config_data = { "qosRef": "unique-qos-id", "interfaceRoutingPolicyRef": "unique-interface-id" } updated_config_data = mso_template_object.set_names_for_references(mso_instance, config_data, reference_collections) Expected Output: { "templateName": "template_name", "templateId": "unique-template-id", "qosRef": "unique-qos-id", "interfaceRoutingPolicyRef": "unique-interface-id", "qosName": "Resolved QoS Name", "qosTemplateName": "Resolved QoS Template Name", "qosTemplateId": "Resolved QoS Template ID", "interfaceRoutingPolicyName": "Resolved Interface Routing Policy Name", "interfaceRoutingPolicyTemplateName": "Resolved Interface Routing Policy Template Name", "interfaceRoutingPolicyTemplateId": "Resolved Interface Routing Policy Template ID" } Example 2: reference_collections = { "stateLimitRouteMap": { "name": "stateLimitRouteMapName", "reference": "stateLimitRouteMapRef", "type": "mcastRouteMap" }, "reportPolicyRouteMap": { "name": "reportPolicyRouteMapName", "reference": "reportPolicyRouteMapRef", "type": "mcastRouteMap" }, "staticReportRouteMap": { "name": "staticReportRouteMapName", "reference": "staticReportRouteMapRef", "type": "mcastRouteMap" }, } config_data = { "stateLimitRouteMapRef": "unique-state-limit-id", "reportPolicyRouteMapRef": "unique-report-policy-id" } updated_config_data = mso_template_object.set_names_for_references(mso_instance, config_data, reference_collections) Expected Output: { "templateName": "template_name", "templateId": "unique-template-id", "stateLimitRouteMapRef": "unique-state-limit-id", "reportPolicyRouteMapRef": "unique-report-policy-id", "stateLimitRouteMapName": "Resolved State Limit Route Map Name", "reportPolicyRouteMapName": "Resolved Report Policy Route Map Name" } rr referencermTrUrschemaIdrorn)r!r valuesr&r)r, config_datareference_collections set_templaterreference_detailstemplate_objects r/*update_config_with_template_and_referencesz6MSOTemplate.update_config_with_template_and_referencesrsX ,0,<,< L)!!.2.@.@ N+ !%:%A%A%C i!??#4#8#8#EF&*&F&F)--f5{GXG\G\]hGi7jlpr{'OBQATATU[A\K 1 5 5f =>(,,Z8IXI\I\]kIl $5$9$9*$EF(,,\:KZK^K^_kKl $5$9$9,$GH(,,Z8IXI\I\]gIh $5$9$9*$EF(,,X6GVGZGZ[gGh $5$9$9($CD i r=c|rq|jdr_|jdsM|jds;|jjdj|jdyyyyy)NrUrr!zHEither 'template' or 'template_id' associated with '{}' must be providedr)r&rr'r)r, parameters r/$check_template_when_name_is_providedz0MSOTemplate.check_template_when_name_is_provideds} v. j8QU^UbUbcpUq HH  #m#t#tu~vCvCDJvK$L  MVr8Q.9r=c|jjdijdijdg}td|g}|jd||d}|jjdS) a Get the UUID of an Route Map Policy for Multicast by name. :param route_map_policy_for_multicast_name: Name of the Route Map Policy for Multicast to search for -> Str :return: UUID of the Route Map Policy for Multicast. -> Str rxrmcastRouteMapPoliciesrUzRoute Map Policy for MulticastTrWrOrX)r,#route_map_policy_for_multicast_nameexisting_route_map_policiesr@rDs r/'get_route_map_policy_for_multicast_uuidz3MSOTemplate.get_route_map_policy_for_multicast_uuids '+mm&7&78NPR&S&W&WXbdf&g&k&kmDFH'I#&"EFG223SUpryHL2M}}  ((r=)NNN)F)NNF)T)TF)NTF)__name__ __module__ __qualname__r0 staticmethodrFrHrMrPr\r`rirvr|rrrrrrrrrrrrrr=r/r r s2-h Y  i ) ),_22& )',"*" "7, )) /*cJM )r=r N) __future__rrrrm __metaclass__rsL A@ WZ" Hk *&/*7 Q)Q)r=