VhddlmZmZmZeZ ddlmZdZ ddl m Z m Z dZ ddlmZddlmZddlmZmZ dd lZdd lZdZdd lZdd lZdd lZdd lZdd lZdd lZdd lZdd l Z Gd d Z!d Z"d Z#dZ$dZ%dZ&dZ'dZ(e(fdZ)dZ*dZ+dZ,dZ-dZ.dZ/d!dZ0dZ1dZ2Gdde3Z4dZ5e6d k(re5y y #e $rdZYwxYw#e $rdZ YwxYw#e $rdZYwxYw)")absolute_importdivisionprint_function)FernetTF)api exceptions) to_native) validation)ABCMetaabstractmethodNceZdZdZeZdZdZdZdZ dZ dZ dZ e d Zd Zd Zd Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdPdZ dZ!dZ"dZ#dZ$d Z%d!Z&dQd"Z'd#Z(d$Z)d%Z*d&Z+d'Z,dRd)Z-dRd*Z.d+Z/dSd,Z0d-Z1d.Z2d/Z3d0Z4d1Z5d2Z6d3Z7d4Z8d5Z9d6Z:d7Z;d8Zd;Z?d<Z@dTd=ZAd>ZBd?ZCd@ZDdAZEdBZFdCZGdDZHdEZIdFZJdRdGZKdHZLdIZMdJZNdKZOdLZPdMZQdTdNZRdOZSy()UDnacBasezAClass contains members which can be reused for all intent modulesFc ||_|j|_tj|jj d|_i|_i|_g|_d|_ d|_ |j|j}t||_ d|jji|_|j |j"|j$|j&|j(|j*|j,d|_|j0|j2|j4|j6|j8|j:|j<d|_|j d|_ |jj d|_!|j|_"tG|jDj d jId d|_%tG|jDj d jId d|_&|jDj d |_'d d d dddd|_(|jPjSD]%\}}tU|d|jId dz|'|j@rtVjXs|j dxsd|_-|jZj]|_-|j_|j dxsd|_0|jc|j dsdnd|_2|jgdtijjd|_6dtV_,|joddnGtijjd|_6|jljqtijr|jod ju|dgd|_;d!gggd"|_<y)#Nconfigsuccess)paramsexec)mergeddeletedreplaced overriddengatheredrenderedparseddnac_logdnac_api_task_timeout dnac_version.iii i1 iH iK )z2.2.2.32.2.3.3z2.3.3.02.3.5.3z2.3.7.6z2.3.7.9version__dnac_log_levelWARNINGdnac_log_file_pathzdnac.logdnac_log_appendwaloggerTz Logging configured and initiatedDEBUG empty_loggerz%Cisco Catalyst Center parameters: {0}F)changeddiffresponsewarnings)=modulercopydeepcopygetrhavewantvalidated_configmsgstatusget_dnac_paramsDNACSDKdnac_exec dnac_applyget_diff_mergedget_diff_deletedget_diff_replacedget_diff_overriddenget_diff_gatheredget_diff_renderedget_diff_parsedget_diff_state_applyverify_diff_mergedverify_diff_deletedverify_diff_replacedverify_diff_overriddenverify_diff_gatheredverify_diff_renderedverify_diff_parsedverify_diff_state_applyr max_timeoutpayloadintreplacerdnac_version_in_integerdnac_version_in_string dnac_versionsitemssetattrr_DnacBase__is_log_initr$uppervalidate_dnac_log_levelr&validate_dnac_log_file_path dnac_log_mode setup_loggerlogging getLoggerr*log addHandler NullHandlerformatsupported_statesresult)selfr1 dnac_params version_key version_values h/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/dnac/plugins/module_utils/dnac.py__init__zDnacBase.__init__0s> mm mmFMM$5$5h$?@   " **4;;7 ;/ !499??3/3/C/C040E0E151G1G373K3K151G1G151G1G/3/C/C %'!372I2I373K3K484M4M6:6Q6Q484M4M484M4M262I2I (*$$ 3 ;;??+BC}}  0 0 @ H Hb QR'*4<<+;+;N+K+S+STWY[+\']$&*ll&6&6~&F#   +/*<*<*B*B*D U &K D*{':':3'DDm T U ==!7!7"-//2B"C"PyD "&"5"5";";"=D   ( ( *&1oo6J&K&YzD #  , , .,7OO version2, -1 if version1 < version2, and 0 if they are equal rc3&K|] }|dkD ywrN.0parts rj z1DnacBase.compare_dnac_versions..sJD1HJNrc3&K|] }|dkD ywrqrrrss rjrvz1DnacBase.compare_dnac_versions..sK$TAXKrw)listmaprQsplitziplenany)rfversion1version2v1_partsv2_partsv1v2s rjcompare_dnac_versionszDnacBase.compare_dnac_versionsxsC!456C!456(H- FBBwb   x=3x= (J#h-.1IJJ1 QPQ Q ]S] *K(3x=>2JKK2 RQR Rrlc8|jjdS)Nr)rPr4rfs rjget_ccc_versionzDnacBase.get_ccc_versions||//rlc|jSN)rTrs rjget_ccc_version_as_stringz"DnacBase.get_ccc_version_as_strings***rlc|jSr)rSrs rjget_ccc_version_as_integerz#DnacBase.get_ccc_version_as_integers+++rlc8|jj|Sr)rUr4)rfrs rjget_ccc_version_as_int_from_strz(DnacBase.get_ccc_version_as_int_from_strs!!%%l33rlc<|jsd|_d|_|Sy)Nz/config not available in playbook for validationfailed)rr8r9rs rjvalidate_inputzDnacBase.validate_inputs!{{HDH"DKKrlcd|_|SNTrrs rjr?zDnacBase.get_diff_merged  rlcd|_|Srrrs rjr@zDnacBase.get_diff_deleted  rlcd|_|Srrrs rjrAzDnacBase.get_diff_replaced  rlcd|_|Srrrs rjrBzDnacBase.get_diff_overridden rlcd|_|Srrrs rjrCzDnacBase.get_diff_gatheredrrlcd|_|Srrrs rjrDzDnacBase.get_diff_renderedrrlcd|_|Srrrs rjrEzDnacBase.get_diff_parsedrrlcd|_|Srrrs rjrGzDnacBase.verify_diff_mergedrrlcd|_|Srrrs rjrHzDnacBase.verify_diff_deletedrrlcd|_|Srrrs rjrIzDnacBase.verify_diff_replacedrrlcd|_|Srrrs rjrJzDnacBase.verify_diff_overriddenrrlcd|_|Srrrs rjrKzDnacBase.verify_diff_gatheredrrlcd|_|Srrrs rjrLzDnacBase.verify_diff_renderedrrlcd|_|Srrrs rjrMzDnacBase.verify_diff_parsedrrlctjtjtjtjtj d}|j |jtj}tj|}tjdd}tj|j|j}|j||j||j|y)zMSet up a logger with specified name and configuration based on dnac_log_levelINFOr+r%ERRORCRITICALz%%(asctime)s %(levelname)s %(message)sz%m-%d-%Y %H:%M:%S)datefmt)modeN)r^rr+r%rrr4r$r_ Formatter FileHandlerr&r\ setFormattersetLevelra)rf logger_name level_mappinglevelr* formatter file_handlers rjr]zDnacBase.setup_loggersLL]]]]((  !!$"5"5wG"";/%%&MWjk **4+B+BI[I[\ !!),,'rlch|jdvr$tdj|jy)z>Validates if the logging level is string and of expected valuerz'Invalid log level: 'dnac_log_level:{0}'N)r$ ValueErrorrcrs rjrZz DnacBase.validate_dnac_log_levels4   &W WFMMdNaNabc c Xrlctjj|j}tjj |}tjj |st dj|y)z Validates the specified log file path, ensuring it is either absolute or relative, the directory exists, and has a .log extension. z0The directory for log file '{0}' does not exist.N)ospathabspathr&dirnameexistsFileNotFoundErrorrc)rfr& log_directorys rjr[z$DnacBase.validate_dnac_log_file_paths_  WW__T-D-DE(:; ww~~m,#$V$]$]^p$qr r-rlc P|jr|jj}tjd|z}|d}tj |}d|d|j d|jd|d }t|j|j} | |yy)aLogs formatted messages with specified log level and incrementing the call stack frame Args: self (obj, required): An instance of the DnacBase Class. message (str, required): The log message to be recorded. level (str, optional): The log level, default is "info". The log level can be one of 'DEBUG', 'INFO', 'WARNING', 'ERROR', or 'CRITICAL'. rnr : z N) r __class____name__inspectstack getframeinfofunctionlinenogetattrr*lower) rfmessagerframeIncrement class_namecallerframerecordframeinfo log_message log_methods rjr`z DnacBase.logs ==00J ' N0B C %a(E''.D2EEkRT[ \ )    ;;A6#a&> H   txx ( ( )sA5B.:2B.. D 7A DD c d}|S)a- Retrieves the limit for 'get_device_list' API to collect the device details.. Args: self (object): An instance of a class that provides access to Cisco Catalyst Center. Returns: int: The limit for 'get_device_list' api device details, which is set to 500 by default. Description: This method returns a predefined limit for the number of device details that can be processed or retrieved from 'get_device_list' api. Currently, the limit is set to a fixed value of 500. rr)rfapi_response_limits rjget_device_details_limitz!DnacBase.get_device_details_limits!!!rlc|s dj||_d|_|St|ts dj||_d|_|S|j d}|j d.|j dj d|_d|_|S|j d}t j } t j }||z |jk\r[d j|j| d j|z|_|j|jd d|_ |S|j|}|jdj||d|j dd ur|j drt|j d|_d} | |jjvrdt j|jj d|j||_nt|j d|_d|_ |S||j djvr3d |jd<|d ur|j d|_d|_ |S|jdj|j d|d )a Get the site id from the site name. Args: self - The current object details. response (dict) - API response. validation_string (str) - String used to match the progress status. api_name (str) - API name. data (bool) - Set to True if the API is returning any information. Else, False. Returns: self 0The response from the API '{api_name}' is empty.api_namer;The response from the API '{api_name}' is not a dictionary.r/ errorcodedetailtaskIdTzJMax timeout of {max_timeout} sec has reached for the task id '{task_id}'. )rOr;Exiting the loop due to unexpected API '{api_name}' status.r%z*Getting task details from task ID {0}: {1}r+isError failureReasonzcheck task treednac_task_poll_intervalprogressr-datar Progress is {0} for task ID: {1})rcr8r9rrr4timerOr`r rrsleeprcheck_task_tree_responsere) rfr/validation_stringrrr start_timeend_time task_details string_checks rjcheck_task_response_statusz#DnacBase.check_task_response_statussB* H#DKK(D)M* H#DKK<< + << $ 0||J/33H=DH"DKK,,x(YY[ yy{H:%$*:*::g"Ft/?/?FQX__iq_rs9-& 4 1 009L HHAHHR^_ah i *d2##O4"<#3#3O#DEDH#4L#txx~~'77 4;;??3L#MN#'#@#@#I"<#3#3J#?@DH&  !L$4$4Z$@$F$F$HH)- I&4<+//7DH'   HH7>>|?O?OPZ?[]degn oArlcl|jj|jjy)z1Reset all neccessary attributes to default valuesN)r5clearr6rs rj reset_valueszDnacBase.reset_valuess   rlcRd} |jjddd|i}|jdj||d|S#t$rU}|j djt ||_|j|jYd}~|Sd}~wwxYw) z Get the execution details of an API Args: exec_id (str) - Id for API execution Returns: response (dict) - Status for API execution Nr"get_business_api_execution_details execution_idrrrz}Successfully retrieved execution details by the API 'get_business_api_execution_details' for execution ID: {0}, Response: {1}r+zAn error occurred while executing API call to Function: 'get_business_api_execution_details' due to the the following exception: {0}.) r<r=r`rcrrrr8r)rfexec_idr/rs rjget_execution_detailszDnacBase.get_execution_detailss )yy=&0'H HHUfWh/ : )    ;;A6#a&> H   txx ( ( )sAA B&A B!!B&c|s dj||_d|_|St|ts dj||_d|_|S|j d}t j } t j }||z |jk\r[dj|j|d j|z|_|j|jd d|_ |S|j|}|j d d k(r d|jd <d|_d|_ |S|j dr |j d|_d|_ |S)z Checks the response status provided by API in the Cisco Catalyst Center Args: response (dict) - API response api_name (str) - API name Returns: self rrrr executionIdTzTMax timeout of {max_timeout} sec has reached for the execution id '{execution_id}'. )rOr+rr%r9SUCCESSr-zSuccessfully executedr bapiError) rcr8r9rrr4rrOr`r.re)rfr/rr+r!r"execution_detailss rjcheck_execution_response_statusz(DnacBase.check_execution_response_statussmB* H#DKK(D)M* H#DKK||M2 YY[ yy{H:%$*:*::q"Ft/?/?lF[X__iq_rs9-&  !% : :< H  $$X.);)- I&2'  !$$[1,00=&  -rlc tj|}t|tr|S y#tj$rYywxYw)a  Check whether the input is string dictionary or string. Args: task_details_data (string) - Input either string dictionary or string. Returns: value (dict) - If the input is string dictionary, else returns None. N)jsonloadsrrJSONDecodeError)rftask_details_datavalues rjcheck_string_dictionaryz DnacBase.check_string_dictionaryKsL JJ01E%& '##   s&+AAcP |j|}|j|jdkrX|jd}|djd}|D]+}|ddk(s |jdjd}- S|j d j t |d |jd}|djd} |S#t$r=}d j |||_|j|jYd }~Sd }~wwxYw) a Get the type of a site in Cisco Catalyst Center. Args: self (object): An instance of a class used for interacting with Cisco Catalyst Center. site_name (str): The name of the site for which to retrieve the type. Returns: site_type (str or None): The type of the specified site, or None if the site is not found. Description: This function queries Cisco Catalyst Center to retrieve the type of a specified site. It uses the get_site API with the provided site name, extracts the site type from the response, and returns it. If the specified site is not found, the function returns None, and an appropriate log message is generated. r!r/radditionalInfo nameSpaceLocation attributestypez+Received API response from 'get_sites': {0}r+z?An exception occurred while fetching the site '{0}'. Error: {1}N) get_siterrr4r`rcrrr8r)rf site_namer/sitesite_additional_infoitem site_typers rjget_sites_typezDnacBase.get_sites_type\s  )}}Y/H..0D4X4XYb4cc||J/'+Aw{{3C'D$0GDK(J6$(HH\$:$>$>v$F GFMMcRZm\^ef||J/ GKK/   )X__`iklmDH   txx ( (  )s%A%C("C AC D%(2D  D%Ncg}d}|~|jdj|d|j|\}}|s%|jdj|d||fS|jdj||d|jdj|d|j|jkr|jdj|jdd |i}|j d d |}|jd d|rRd |vrN|j d gD]9}|j dgD]"}|j|j d$;|jdj||dn|jdj|jdd |i} |j dd| }|jdd|r;d|vr7|j dgD]"}|j|j d$|jdj||d|s"|jdj||d||fS)a{ Retrieve device IDs associated with a specific site in Cisco Catalyst Center. Args: site_id (str): The unique identifier of the site. Returns: tuple: A tuple containing the API response and a list of device IDs associated with the site. Returns an empty list if no devices are found or if an error occurs. N>Site ID not provided. Retrieving Site ID for site name: '{0}'.r+@Site '{0}' does not exist, cannot proceed with device retrieval.r,Retrieved site ID '{0}' for site name '{1}'.6Initiating retrieval of device IDs for site ID: '{0}'.z>Using 'get_membership' API for Catalyst Center version: '{0}'.site_idsitesget_membershipz?Received response from 'get_membership'. Extracting device IDs.devicer/ instanceUuidz8Retrieved device IDs from membership for site '{0}': {1}zFUsing 'get_site_assigned_network_devices' API for DNAC version: '{0}'. site_design!get_site_assigned_network_deviceszRReceived response from 'get_site_assigned_network_devices'. Extracting device IDs.deviceIdz>Retrieved device IDs from assigned devices for site '{0}': {1}z4No devices found for site '{0}' with site ID: '{1}'.r%)r`rc get_site_idrversion_2_3_5_3execute_get_requestr4append) rfrCrN device_ids api_response site_existsget_membership_paramsrQrF(get_site_assigned_network_devices_paramss rjget_device_ids_from_sitez!DnacBase.get_device_ids_from_site}s{   ? HHU\\]fgip q#'#3#3I#> G[[bbclmovw#Z// HHCJJ7T]^`g h IPPQXY[bc    4 4 4 HHU\\]a]n]noqx y%.$8 !33G=MOdeL HHVX_ `L 8*..x<DF & :r :D"))$((>*BCDD HHOVVW^`jkmt u HH]ddeievevwzA B8A77K 433MCfiQRL HHikr s l :*..z2>>F%%fjj&<=> HHU\\]dfpqsz { HHKRRS\^efhq rZ''rlcg}|jdj|d|||jdj|d|j|\}}|s#|jdj|d|S|jdj||d|j||\}}|s1dj||_|j |j|jd j|t |d|D]}|jd j|dd |i}|jd d |} | s1dj||_|j |j|j| jd|jdj|d|S)ax Retrieves device details for all devices within a specified site. Args: site_id (str): The ID of the site from which to retrieve device details. Returns: list: A list of device details retrieved from the specified site. Raises: SystemExit: If the API call to get device IDs or device details fails. rMrrJr+rKrrLzNNo response received from API call 'get_device_ids_from_site' for site ID: {0}z)Device IDs retrieved from site '{0}': {1}z G[[bbclmovw** HHCJJ7T]^`g h$(#@#@G#T jgnnovwDH   txx ( <CCGSQ[_]_fg$ bI HHSZZ[degm n'+Y&7 #229>PRijKellmvw""488, & &{z'B C HHELLYWY` a b#"rlcJi}g}|j|\}}|s1dj||_|j|j|j dj|d|j ||}|j dj||d|D]}|j d}|j d} |j d} |j d } |j d } | d k(rF| d k(rA| d k7r| ||<m|j|dj|| } |j | d|j|dj|| | } |j | d|s!|j dj|d||fS)a Retrieves a mapping of management IP addresses to instance IDs for reachable devices from a specified site. Args: site_id (str): The ID of the site from which to retrieve device details. Returns: tuple: A tuple containing: - dict: A mapping of management IP addresses to instance IDs for reachable devices. - list: A list of management IP addresses of skipped devices. z`Site '{0}' does not exist in the Cisco Catalyst Center, cannot proceed with device(s) retrieval.z:Initiating retrieval of device details for site ID: '{0}'.rz0Device details retrieved for site ID: '{0}': {1}r+managementIpAddressrRreachabilityStatuscollectionStatusr ReachableManagedz Unified APz*Skipping device {0} as its family is: {1}.r%zHSkipping device {0} as its status is {1} or its collectionStatus is {2}.z'No reachable devices found at Site: {0})rVrcr8rr`rhr4rY)rfrCmgmt_ip_to_instance_id_mapskipped_devices_listr\rNrdrg management_ip instance_uuidreachability_statuscollection_status device_familyr8s rjget_reachable_devices_from_sitez(DnacBase.get_reachable_devices_from_sites&("!!%!1!1)!<gyAABKLDH   txx ( MTTU\]_ef#?? 7S CJJ7Tghjqr/ )K'OO,ABM'OON;M"-//2F"G  +0B C 'OOH5M#k16G96T L0@M.}=(// >FMM%}CHHS),$++M:`gg!#68Ii(/ )2* HH>EEgNPV W)+???rlc d|jdj|dg}d}d\}}}|j|jkr2|jdj|jdd\}}}n1|jdj|jdd\}}}||d |d |i}|jd j|||d |j |||} | s%|jd j|d dn|jd jt | j d|d d|j| j dt | j d|kr"|jdj|dn0||z }||d <|jdj|d dd} |r1|jdjt ||dd|i} | S|jdj|d| S)aS Retrieve site details from Cisco Catalyst Center based on the provided site name. Args: - site_name (str): The name or hierarchy of the site to be retrieved - limit (int): Default value given as 500, it can be updated. Returns: - response (dict or None): The response from the API call, typically a dictionary containing site details. Returns None if an error occurs or if the response is empty. Criteria: - This function uses the Cisco Catalyst Center SDK to execute the 'get_sites' function from the 'site_design' family. - If the response is empty, a warning is logged. - Any exceptions during the API call are caught, logged as errors, and the function returns None. z:Initiating retrieval of site details for site name: '{0}'.r+rn)NNNz8Using 'get_site' API for Catalyst Center version: '{0}'.)rOrBnamez9Using 'get_sites' API for Catalyst Center version: '{0}'.)rS get_sitesname_hierarchyoffsetlimitzESending initial API request: Family='{0}', Function='{1}', Params={2}z;No data received from API (Offset={0}). Exiting pagination.z+Received {0} site(s) from API (Offset={1}).r/zOReceived less than limit ({0}) results, assuming last page. Exiting pagination.z0Incrementing offset to {0} for next API request.Nz1Total {0} site(s) retrieved for site name: '{1}'.z+No site details found for site name: '{0}'.r%)r`rcrrWrXr}r4extend) rfrCr| response_allr{ api_family api_function param_keyrequest_paramsr/ site_responses rjrBzDnacBase.get_sites: M "G - .>+ L)    4 4 4 HHOVD--. 92M /J i HHPVD--. 92^ /J i#Y&'5Q X__  n67> @// L.YHVx 897D HHBIIHLL,-~h/GIJQ S    Z 8 98<< +,u4j1 eOF'-N8 $ HHGNNx(*+2 4%*  HHHVC -y97 D'6M HHBII)TV_ `rlc |j|}|1dj||_|j|j|j dj|t |d|j d}|dj d}d}||fS#t$r?}d j|||_|j|jYd}~fSd}~wwxYw) aX Retrieve the site ID and check if the site exists in Cisco Catalyst Center based on the provided site name. Args: site_name (str): The name or hierarchy of the site to be retrieved. Returns: tuple (bool, str or None): A tuple containing: 1. A boolean indicating whether the site exists (True if found, False otherwise). 2. The site ID (str) if the site exists, or None if the site does not exist or an error occurs. Criteria: - This function calls `get_site()` to retrieve site details from the Cisco Catalyst Center SDK. - If the site exists, its ID is extracted from the response and returned. - If the site does not exist or if an error occurs, an error message is logged, and the function returns a status of 'failed'. Nz,No site details retrieved for site name: {0}z+Site details retrieved for site '{0}'': {1}r+r/rraTzzAn exception occurred while retrieving Site details for Site '{0}' does not exist in the Cisco Catalyst Center. Error: {1})rBrcr8rr`rr4r)rfrCr/rDrNr\rs rjrVzDnacBase.get_site_id_s )}}Y/HIPPQZ[""488, HHBII)UXYaUbcel m<< +D1gkk$'GKW%% )#VIq1 H   txx ( (W%% )sBB C$%2CC$c p |jdj|d|j|}|jdsMdj||_|j|jd|j |j|ddjd}|jdj||d|d vr>d |_|j|jd|j |j|jd j|d|j |}|sMd j||_|j|jd|j |jt|jd}d d|igi}|j|jdkrI |jdddd||d} |jdj| d|j| d|jdk(rud|jd<djt|||jd<| jd|jd<|j|jddyd|jd<djt|||jd<| jd|jd<|j|jddy||d#} |jd$j|t| d |j&j)d%d&d| } |jd'j|t| t| dd|j+| d()|jdryd*j|t| |_|j|jdd |_ |j"j%|j!y"#t $r}} dj|t|t| |_|j|jdd |_ |j"j%|j!Yd"} ~ y"d"} ~ wwxYw#t $rr} d+j|t| } |j| t| zdt| } d |_ |j"j%| | ,Yd"} ~ y"d"} ~ wwxYw)-a Assign devices to the specified site. Args: self (object): An instance of a class used for interacting with Cisco Catalyst Center. device_ids (list): A list of device IDs to assign to the specified site. site_name (str): The complete path of the site location. site_id (str): The ID of the specified site location. Returns: bool: True if the devices are successfully assigned to the site, otherwise False. Description: Assigns the specified devices to the site. If the assignment is successful, returns True. Otherwise, logs an error and returns False along with error details. zFetching site details for '{0}'r+r/z,Invalid site response received for site: {0}rrrAzSite '{0}' found with type: {1})buildingfloorz0Device(s) can only be assigned to building/floorz*Retrieving IP addresses for device IDs: {}z/No valid IP addresses found for device IDs: {0}rQipr!rrOassign_devices_to_siteT)rNrPrrrrzReceived API response: {0}rr-z0Successfully assigned device(s) {0} to site {1}.r8r0rFz-Unable to assigned device(s) {0} to site {1}.z6Error while assigning device(s) to site: {0}, {1}, {2}rr8N) deviceIdssiteIdzAAssigning device(s) to site '{0}' with the following details: {1}rS assign_network_devices_to_a_siteziReceived API response from 'assign_network_device_to_site' while assigning devices to site: {0}, {1}, {2}assign_device_to_siterzEFailed to receive a valid response from site assignment API: {0}, {1}zQException occurred while assigning devices to site '{0}'. Assignment details: {1}r)r`rcrBr4r8rget_device_ips_from_device_idsryvaluesrrr>r4r9rerrr1rr<r=check_tasks_response_status)rfrZrCrNrrG device_ip ip_addressparamr/rassign_network_device_to_siter8site_assgin_detailss rjrzDnacBase.assign_device_to_sites 299)DgN i0   ,ELLYWDH HHTXXw '   txx (!*-a044V<  299)YOQXY 1 1IDH HHTXXw '   txx ( =DDZPRYZ77 C HOOPZ[DH HHTXXw '   txx ()**,-a0 *   * * ,0T0TU^0_ _ 424??62"5 $#*#( 5<HHKRRSVX_`bij 44U; &/ 7#  0  %?EFtD,,T2F FMGs#CcLt|tr_i}|jD]H\}}|dk(rd}n%tjdd|j }|j |}|||<J|St|tr|Dcgc]}|j |c}S|Scc}w)z Replace 'site_type' key with 'type' in the config. Args: config (list or dict) - Configuration details. Returns: updated_config (list or dict) - Updated config after replacing the keys. rGrArr)rrrVrrrupdate_site_type_keyryrs rjrzDnacBase.update_site_type_keyBs fd #J$lln 0 U+%$G ff%98SIOOQG 55e< &/ 7#  0  %@FGD--d3G GMHsB!c T|jdjt|di}|D] } |jj dddd|i}|r|jdj|t|d |j d }|rY|d d }|r(|||<|jd j||dntd||<|jdj|dnMd||<|jdj|dn&d||<|jdj|d|jdj|d|S#t $r=}dj|t|}|j|dd||<Yd}~sd}~wwxYw)a Get the list of unique device IPs for list of specified hostnames of devices in Cisco Catalyst Center. Parameters: self (object): An instance of a class used for interacting with Cisco Catalyst Center. hostnames (list): The hostnames of devices for which you want to retrieve the device IPs. Returns: device_ip_mapping (dict): Provide the dictionary with the mapping of hostname of device to its ip address. Description: Queries Cisco Catalyst Center to retrieve the unique device IP's associated with a device having the specified list of hostnames. If a device is not found in Cisco Catalyst Center, an error log message is printed. z@Entering 'get_device_ips_from_hostnames' with hostname_list: {0}rrbget_device_listThostnamerz-Received API response for hostname '{0}': {1}r+r/rrjz)Added device IP '{0}' for hostname '{1}'.Nz*No management IP found for hostname '{0}'.r%z(No response received for hostname '{0}'.z?No response received from 'get_device_list' for hostname '{0}'.rzCException occurred while fetching device IP for hostname '{0}': {1}zCExiting 'get_device_ips_from_hostnames' with device IP mapping: {0}r`rcrr<r=r4r)rf hostnamesdevice_ip_mappingrr/rrrs rjget_device_ips_from_hostnamesz&DnacBase.get_device_ips_from_hostnames[s SZZ[^_h[ijlrs! 3H 399??$. $&1 + HHLSST\^abj^klnuv'||J7H$,QK0E$F $:C-h7 HH%P%W%WXack%lntu:>-h7 HH%Q%X%XYa%bdmn6:)(3!K!R!RS[!\^gh26%h/HH^eefnoqxy1 3> V]]^oprxy   3 e l lmuwz{|w} ~ 0.2!(+ 3sDE!! F'*2F""F'c |jdjt|di}|D],} |jdj|d|jj dddd|i}|r|jd j|t|d |j d }|rY|d d }|r(|||<|jdj||dntd||<|jdj|dnMd||<|jdj|dn&d||<|jdj|d/|jdj|d|S#t $r=}dj|t|}|j|dd||<Yd}~d}~wwxYw)a Get the list of unique device IPs for a specified list of serial numbers in Cisco Catalyst Center. Parameters: self (object): An instance of a class used for interacting with Cisco Catalyst Center. serial_numbers (list): The list of serial number of devices for which you want to retrieve the device IPs. Returns: device_ip_mapping (dict): Provide the dictionary with the mapping of serial number of device to its ip address. Description: Queries Cisco Catalyst Center to retrieve the unique device IPs associated with a device having the specified serial numbers.If a device is not found in Cisco Catalyst Center, an error log message is printed. zFEntering 'get_device_ips_from_serial_numbers' with serial_numbers: {0}rz+Fetching device info for serial number: {0}rbrT serialNumberrz2Received API response for serial number '{0}': {1}r+r/rrjz.Added device IP '{0}' for serial number '{1}'.Nz/No management IP found for serial number '{0}'.r%z-No response received for serial number '{0}'.zDNo response received from 'get_device_list' for serial number '{0}'.rzHException occurred while fetching device IP for serial number '{0}': {1}zHExiting 'get_device_ips_from_serial_numbers' with device IP mapping: {0}r)rfserial_numbersr serial_numberr/rrrs rj"get_device_ips_from_serial_numbersz+DnacBase.get_device_ips_from_serial_numberss Y``adesatuw}~+ 8M 8FMMm\^de99??$. $*M: + HHQXXYfhklthuvxA'||J7H$,QK0E$F $?H-m< HH%U%\%\]fhu%vx~?C-m< HH%V%]%]^k%lnwx;?)-8!P!W!WXe!fhqr7;%m4HHcjjkxy|CD3 8@ [bbctuw}~   8 j q qrBEFGBH!I 037!-0 8D(F G 2GGc |jdjt|di}|D],} |jdj|d|jj dddd|i}|r|jd j|t|d |j d }|rY|d d }|r(|||<|jdj||dntd||<|jdj|dnMd||<|jdj|dn&d||<|jdj|d/|jdj|d|S#t $r=}dj|t|}|j|dd||<Yd}~d}~wwxYw)a Get the list of unique device IPs for list of specified mac address of devices in Cisco Catalyst Center. Parameters: self (object): An instance of a class used for interacting with Cisco Catalyst Center. mac_addresses (list): The list of mac address of devices for which you want to retrieve the device IPs. Returns: device_ip_mapping (dict): Provide the dictionary with the mapping of mac address of device to its ip address. Description: Queries Cisco Catalyst Center to retrieve the unique device IPs associated with a device having the specified mac addresses. If a device is not found in Cisco Catalyst Center, an error log message is printed. zDEntering 'get_device_ips_from_mac_addresses' with mac_addresses: {0}rz)Fetching device info for mac_address: {0}rbrT macAddressrz0Received API response for mac address '{0}': {1}r+r/rrjz,Added device IP '{0}' for mac address '{1}'.Nz-No management IP found for mac address '{0}'.r%z+No response received for mac address '{0}'.zBNo response received from 'get_device_list' for mac address '{0}'.rzFException occurred while fetching device IP for mac address '{0}': {1}zGExiting 'get_device_ips_from_mac_addresses' with device IP mapping: {0}r)rf mac_addressesr mac_addressr/rrrs rj!get_device_ips_from_mac_addressesz*DnacBase.get_device_ips_from_mac_addressess W^^_bcp_qrtz{( 6K 6DKKKXZ`a99??$. $(+6 + HHOVVWbdghpdqrt{|'||J7H$,QK0E$F $=F-k: HH%S%Z%Z[dfq%rtz{=A-k: HH%T%[%[\g%hjst9=)+6!N!U!UVa!bdmn59%k2HHahhituw~3 6@ Zaabstv|}   6 h o op{~ABC~D!E 015!+. 6rc |jdjt|di}|D],} |jdj|d|jj dddd|i}|r|jd j|t|d |j d }|rY|d d }|r(|||<|jdj||dntd||<|jdj|dnMd||<|jdj|dn&d||<|jdj|d/|jdj|d|S#t $r=}dj|t|}|j|dd||<Yd}~d}~wwxYw)a Get the list of unique device IPs for list of specified hostnames of devices in Cisco Catalyst Center. Parameters: self (object): An instance of a class used for interacting with Cisco Catalyst Center. hostname_list (list): The hostnames of devices for which you want to retrieve the device IPs. Returns: device_id_mapping (dict): Provide the dictionary with the mapping of ip address of device to device id. Description: Queries Cisco Catalyst Center to retrieve the unique device IP's associated with a device having the specified list of hostnames. If a device is not found in Cisco Catalyst Center, an error log message is printed. z>Entering 'get_device_ids_from_device_ips' with device ips: {0}rz%Fetching device id for device ip: {0}rbrFmanagement_ip_addressrz/Received API response for device ip '{0}': {1}r+r/rraz+Added device ID '{0}' for device ip '{1}'.Nz(No device ID found for device ip '{0}'.r%z*No response received for device ip '{0}'.zANo response received from 'get_device_list' for device ip '{0}'.rzEException occurred while fetching device ID for device ip '{0}': {1}zKExiting 'get_device_ids_from_device_ips' with unique device ID mapping: {0}r)rf device_ipsdevice_id_mappingrr/rerrs rjget_device_ids_from_device_ipsz'DnacBase.get_device_ids_from_device_ipss QXXY\]gYhikqr# 4I 4@GG RTZ[99??$. %3Y? + HHNUUV_ademanoqxy'||J7H$,QK$5 $;D-i8 HH%R%Y%YZcen%oqwx;?-i8 HH%O%V%VW`%aclm7;))4!M!T!TU^!_ajk37%i0HH`gghqrt{|3 4@ ^eefwx{A B   4 g n noxz}~{A!B 0/3!), 4rc |jdjt|di}|D],} |jdj|d|jj dddd|i}|r|jd j|t|d |j d }|rY|d d }|r(|||<|jdj||dntd||<|jdj|dnMd||<|jdj|dn&d||<|jdj|d/|jdj|d|S#t $r=}dj|t|}|j|dd||<Yd}~d}~wwxYw)a Retrieves the management IP addresses of devices based on the provided device IDs. Args: device_ids (list): A list of device IDs for which the management IP addresses need to be fetched. Returns: device_ip_mapping (dict): Provide the dictionary with the mapping of id of device to its ip address. Description: This function iterates over a list of device IDs, makes an API call to Cisco Catalyst Center to fetch the management IP addresses of the devices, and returns a list of these IPs. If a device is not found or an exception occurs, it logs the error or warning and continues to the next device ID. z>Entering 'get_device_ips_from_device_ids' with device ips: {0}rz%Fetching device ip for device id: {0}rbrFrarz/Received API response for device id '{0}': {1}r+r/rrjz+Added device IP '{0}' for device id '{1}'.Nz(No device ID found for device id '{0}'.r%z*No response received for device id '{0}'.zANo response received from 'get_device_list' for device id '{0}'.rzDException occurred while fetching device ip for device id '{0}': {1}zFExiting 'get_device_ips_from_device_ids' with device IP mapping: '{0}'r)rfrZrrer/rrrs rjrz'DnacBase.get_device_ips_from_device_ids&s QXXY\]gYhikqr# 4I 4@GG RTZ[99??$. % ), + HHNUUV_ademanoqxy'||J7H$,QK0E$F $;D-i8 HH%R%Y%YZcen%oqwx;?-i8 HH%O%V%VW`%aclm7;))4!M!T!TU^!_ajk37%i0HH`gghqrt{|3 4@ Y``arsu{|   4 f m mnwy|}~y!A 0/3!), 4rc|jdj|dd} |jjdddd|i}|s#|jd j|d |S|j d }|s#|jd j|d |S|jd jt |d|dd}|r$|jdj||d|S|jdj|d  |S#t $rW}dj|t ||_|jdd|jdjYd}~|Sd}~wwxYw)aI Retrieves the ID of a network device tag from the Cisco Catalyst Center based on the tag name. Args: self (object): An instance of the class used for interacting with Cisco Catalyst Center. tag_name (str): The name of the tag whose ID is to be retrieved. Returns: str or None: The tag ID if found, or `None` if the tag is not available or an error occurs. Description: This function queries the Cisco Catalyst Center API to retrieve the ID of a tag by its name. It sends a request to the 'get_tag' API endpoint with the specified `tag_name`. If the tag is found, the function extracts and returns its `id`. If no tag is found or an error occurs during the API call, it logs appropriate messages and returns `None`. z9Entering 'get_network_device_tag_id' with tag_name: '{0}'rNtagget_tagFrxrz2No response received from 'get_tag' for tag '{0}'.r%r/z2Unable to fetch the tag details for the tag '{0}'.z)Received API response from 'get_tag': {0}r+rraz*Received the tag ID '{0}' for the tag: {1}z/Tag ID not found in the response for tag '{0}'.zZException occurred while fetching tag id for the tag '{0} 'from Cisco Catalyst Center: {1}r) r`rcr<r=r4rrr8set_operation_resultr)rftag_name device_tag_idr/ response_datars rjget_network_device_tag_idz"DnacBase.get_network_device_tag_idZs LSST\]_ef  _yy"!) 'H MTTU]^`ij$$$LL4M MTTU]^`ij$$ HH@GGMHZ[]d e)!,T2MELL]\degmnJQQRZ[]fg _-fXs1v& H  % %htxx H \ \ ^ ^ _s,AD+5D!AD9!D E=&A E88E=cg}|jD]]\}} |"|jdj|d+|jdj||d|j|_|S#t$rV}dj|t ||_|jdd|j djYd}~d}~wwxYw) aQ Extracts values from a dictionary and returns a list of non-None values. Args: self (object): An instance of the class used for interacting with Cisco Catalyst Center. dict_name (dict): The dictionary from which values are extracted. Each key-value pair is checked, and non-None values are included in the returned list. Returns: list: A list containing all non-None values from the dictionary. Description: This function iterates over a given dictionary, checking each key-value pair. If the value is `None`, it logs a debug message and skips that value. Otherwise, it appends the value to a list. If an exception occurs during this process, it logs the exception message and handles the operation result. Nz;Value for the key {0} is None so not including in the list.r+z'Fetch the value '{0}' for the key '{1}'zYException occurred while fetching value for the key '{0} 'from Cisco Catalyst Center: {1}rFr) rVr`rcrYrrr8rr)rf dict_name values_listrr:rs rjget_list_from_dict_valuesz"DnacBase.get_list_from_dict_valuess" #//+ cJC c=HHZaabefhopHHFMMeUXY[bc&&u- c c1&c!f%))(E488VL``bb  cs#A53A55 C>A CCc tj||jd}t|dk7ry|D]}dt |cxkrdkryyy#tj $rYywxYw)a  Validates an IPv4 address. Args: ip_address - String denoting the IPv4 address passed. Returns: bool - Returns true if the passed IP address value is correct or it returns false if it is incorrect rFrT)socket inet_atonr{r}rQerror)rfroctetsoctets rj is_valid_ipv4zDnacBase.is_valid_ipv4sz    Z (%%c*F6{a !CJ-#- .  !||  s(4AAAAAA.-A.cb tj|}y#tj$rYywxYw)z Validates an IPv6 address. Args: ip_address - String denoting the IPv6 address passed. Returns: bool: True if the IPv6 address is valid, otherwise False TF) ipaddress IPv6AddressAddressValueError)rfrrs rj is_valid_ipv6zDnacBase.is_valid_ipv6s2 &&z2B**  s ..c|i}t|tr|j||jD]\}}t j dd|j }|||<t|tr|j||St|tsd|D]%}t|ts|j||'|St|tr*|D]%}t|ts|j||'|S)aD Converts keys in a dictionary from CamelCase to snake_case and creates a keymap. Args: keymap (dict): Already existing key map dictionary to add to or empty dict {}. data (dict or list): Input data where keys need to be mapped using the key map. Returns: dict: A dictionary with the original keys as values and the converted snake_case keys as keys. Example: functions = Accesspoint(module) keymap = functions.map_config_key_to_api_param(keymap, device_data) rr) rrupdaterVrrrmap_config_key_to_api_paramry)rfkeymaprrr:rrFs rjrz$DnacBase.map_config_key_to_api_params >F dD ! MM& !"jjl K U&&!5xEKKM"%weT*44VUCt, %K%dD1 <? @ IIn5; rlcd} |jjddd|i}t|ts#|j dj |d|S|j d}|j d j | d |S#t$rU}|jd j t||_ |j|jYd}~|Sd}~wwxYw) ar Get the details of a specific task in Cisco Catalyst Center. Args: self (object): An instance of a class that provides access to Cisco Catalyst Center. task_id (str): The unique identifier of the task for which you want to retrieve details. Returns: dict or None: A dictionary containing detailed information about the specified task, or None if the task with the given task_id is not found. Description: Call the API 'get_task_details_by_id' to get the details along with the failure reason. Return the details. Nrget_task_details_by_idrar,zDInvalid response received when fetching task details for task ID: {}rr/zTask Details: {task_details})r#r+zyAn error occurred while executing API call to Function: 'get_task_details_by_id' due to the the following exception: {0}.) r<r=rrr`rcr4rrrr8r)rfrr#r/rs rjrzDnacBase.get_task_details_by_ids  )yy1g'H h-_ffgnoqxy###<< 3L HH3:: :UW^ _ )    ;;A6#a&> H   txx ( ( )sAB 3B C*A C%%C*c^d} |jjddd|i}|jdj|d|jdj||dt |t s#|jd j|d |S|j d }|jd j|d|S#t$rU}|jd jt||_ |j|jYd}~|Sd}~wwxYw)ae Get the tasks of a task ID in Cisco Catalyst Center. Args: self (object): An instance of a class that provides access to Cisco Catalyst Center. task_id (str): The unique identifier of the task for which you want to retrieve details. Returns: dict or None: A dictionary status information about the specified task, or None if the task with the given task_id is not found. Description: Call the API 'get_tasks_by_id' to get the status of the task. Return the details along with the status of the task. Nrget_tasks_by_idrar,zTask Details: {0}r+zVRetrieving task details by the API 'get_tasks_by_id' using task ID: {0}, Response: {1}rrr/zTask Status: {0}rrrs rjrzDnacBase.get_tasks_by_ids  )yy*g'H HH(//97 C HHmfWh/ :h-JQQRYZ\cd""",,z2K HH'..{;W E )    ;;A6#a&> H   txx ( ( )sBC2C D,A D''D,c|sd|_d|_|St|tsd|_d|_|S|j d}|j d.|j dj d|_d|_|S|j d}t j } t j |z }||j k\rYd j|j |d j|z|_|j|jd d|_ |S|j|}|jd j||d|j d}|dk(r1|j|} | j d|_d|_ |S|dk(r3d |jd<|jdj|d |S|jdj||dU)a Get the task response status from taskId Args: self: The current object details. response (dict): API response. api_name (str): API name. Returns: self (object): The current object with updated desired Fabric Transits information. Description: Poll the function 'get_tasks_by_id' until it returns either 'SUCCESS' or 'FAILURE' state or till it reaches the maximum timeout. Log the task details and return self. zresponse is emptyrzresponse is not a dictionaryr/rrrrTz:Max timeout of {0} sec has reached for the task id '{1}'. z4Exiting the loop due to unexpected API '{0}' status.r%z+Getting tasks details from task ID {0}: {1}r+r9FAILURErr1r-z5The task with task ID '{0}' is executed successfully.rr) r8r9rrr4rrOrcr`rrre) rfr/r task_inforr! elapsed_timer#rdetailss rjrz$DnacBase.check_tasks_response_statuss*DH"DKK(D)5DH"DKKLL, == % 1||J/33H=DH"DKK--)YY[ 99;3Lt///W"F4#3#3W=QXXYabc9-& , ) //8L HHBfWl3W >'**84Ki'55g>";;7&   ))- I&P &/63   HH7f['2G =7rlc||n|}||_|jj|||||dk(d|j|||S)a^ Update the result of the operation with the provided status, message, and log level. Args: - operation_status (str): The status of the operation ("success" or "failed"). - is_changed (bool): Indicates whether the operation caused changes. - status_message (str): The message describing the result of the operation. - log_level (str): The log level at which the message should be logged ("INFO", "ERROR", "CRITICAL", etc.). - additional_info (dict, optional): Additional data related to the operation result. Returns: self (object): An instance of the class. Note: - If the status is "failed", the "failed" key in the result dictionary will be set to True. - If data is provided, it will be included in the result dictionary. r)r9r8r/r-r)r9rerr`)rfoperation_status is_changedstatus_message log_leveladditional_infor/s rjrzDnacBase.set_operation_result sW '6&A?~&  &! !&(2    + rlcL|jdd|d|jy)z6Helper method to update the result as failed and exit.rFrN)rr)rfr8s rjrzDnacBase.fail_and_exit@s" !!(E3@   "rlcntj}|jdj|dy)zC Logs the full traceback of the current exception. zTraceback: {0}r+N) traceback format_excr`rc)rffull_tracebacks rjrzDnacBase.log_tracebackEs. #--/ !((8'Brlctj|z }||jjdkDr@dj||t ||_|j dd|j dyy)a Check if the elapsed time exceeds the specified timeout period and exit the while loop if it does. Args: - loop_start_time (float): The time when the while loop started. - task_id (str): ID of the task being monitored. - task_name (str): Name of the task being monitored. Returns: bool: True if the elapsed time exceeds the timeout period, False otherwise. rzUTask {0} with task id {1} has not completed within the timeout period of {2} seconds.rFrT)rrr4rcrQr8r)rfloop_start_timer task_namers rjcheck_timeout_and_exitzDnacBase.check_timeout_and_exitOshyy{_4 $++//*AB Bnuu7C $57DH  % %htxx Irlc |jdj|||d |jj||d|}|jdj||t |d||dk(st |t r%|s#|jd j||d yt |t r,d |vr(|d s#|jd j||d y|S#t$rW}|jd j|||t ||_ |j|jYd}~yd}~wwxYw)a  Makes a GET API call to the specified function within a given family and returns the response. Args: api_family (str): The family of the API to call. api_function (str): The specific function of the API to call. api_parameters (dict): Parameters to pass to the API call. Returns: dict or None: The response from the API call if successful, otherwise None. Logs detailed information about the API call, including responses and errors. zPInitiating GET API call for Function: {0} from Family: {1} with Parameters: {2}.r+FrzZResponse received from GET API call to Function: '{0}' from Family: '{1}' is Response: {2}rNrzMNo response received from GET API call to Function: '{0}' from Family: '{1}'.r%r/zaEmpty 'response' key in the API response from GET API call to Function: '{0}' from Family: '{1}'.zvAn error occurred while executing GET API call to Function: '{0}' from Family: '{1}'. Parameters: {2}. Exception: {3}.) r`rcr<r=rrrrrr8r)rfrrapi_parametersr/rs rjrXzDnacBase.execute_get_requestes]  ^ e ej.    , )yy!%!% 'H HHlss *c(m  8r>j46PYacjj$j  (D)jH.DXV`Maw~~$j  O )    3396, Tbdghidj3k H   txx ( ( )s%BC*,;C*(C** E 3A EE c  |jdj||d|jj||d|}|jdj||t |d|j d}|s#|jdj||d y |j jt| |j d }|jd j|||d|S#t$rW}|jdj|||t ||_ |j|jYd }~y d }~wwxYw)a Retrieve task ID from response after executing POST API call Args: api_family (str): The API family. api_function (str): The API function (e.g., "add_port_assignments"). api_parameters (dict): The parameters for the API call. z7Requested payload for the the function: '{0}' is: '{1}'rTrzVResponse received from API call to Function: '{0}' from Family: '{1}' is Response: {2}r+r/zINo response received from API call to Function: '{0}' from Family: '{1}'.r%N)r/rzRTask ID received from API call to Function: '{0}' from Family: '{1}', Task ID: {2}zrAn error occurred while executing API call to Function: '{0}' from Family: '{1}'. Parameters: {2}. Exception: {3}.) r`rcr<r=rr4rerrrrr8r)rfrrr)r/rrrs rjget_taskid_post_api_callz!DnacBase.get_taskid_post_api_calls\. ) HHNUUVbdrsu{ |yy!% % 'H HHhoo *c(m  %LL4M _ff$j   KK  t]; <#''1G HHdkk *g  N )    3396, Tbdghidj3k H   txx ( ( )s B"D%AD E  A EE ctj}|jdj||d |j|}|s7dj|||_|j dd|jdn|jdj|d |j d }|j d }tj|z }|j|||r%|jd j|||dn|r|d k(r|j|} | j d} | rdj||| |_n'dj||j|||_|j dd|jdn~|dk(r&||_|j dd|jd nS|jj d} |jdj| dtj| tj|z } |jdj||| d|S)a Retrieves and monitors the status of a task by its task ID. This function continuously checks the status of a specified task using its task ID. If the task completes successfully, it updates the message and status accordingly. If the task fails or times out, it handles the error and updates the status and message. Args: task_id (str): The unique identifier of the task to monitor. task_name (str): The name of the task being monitored. success_msg (str): The success message to set if the task completes successfully. Returns: self: The instance of the class with updated status and message. 6Starting task monitoring for '{0}' with task ID '{1}'.r+T9Error retrieving task status for '{0}' with task ID '{1}'rFr(Successfully retrieved task details: {0}rr9endTimeVTimeout exceeded after {0:.2f} seconds while monitoring task '{1}' with task ID '{2}'.rrzDFailed to execute the task {0} with Task ID: {1}.Failure reason: {2}z1Failed to execute the task {0} with Task ID: {1}.r1rrTWaiting for the next poll interval of {0} seconds before checking task status again.ICompleted monitoring task '{0}' with task ID '{1}' after {2:.2f} seconds.) rr`rcrr8rr4r'rrr) rfrr& success_msgr%r/r9r"rget_task_details_responsefailure_reason poll_intervaltotal_elapsed_times rj get_task_status_from_tasks_by_idz)DnacBase.get_task_status_from_tasks_by_idsO))+ IPPQZ\cdfmn++G4HV]]^gipq))(E488WM HH?FFxPRX Y\\(+F||I.H99;8L**?GYOlss$i  Y&040K0KG0T-%>%B%B?%SN%228&G^2\ PVVW`bij &G4--htxxQy(*DH--itxxP!KKOO,EFM HHkrrtABDK L JJ} %cf"YY[?: \ccdmovyKLNU V rlctj}|jdj||d |j|}|s7dj|||_|j dd|jdn|j dr^|j d } | |_| r$|xjd j| z c_|j dd|jdn|jd j|d tj|z } |j|||r%|jd j| ||dn;|j d} |j d} |j d} |jdj|| | d | r|rF|| vrB||_|j dd|jd |j|jd n|rF|| vrB||_|j dd|jd |j|jd nS|jj d}|jdj|dtj|dtj|z }|jdj|||d|S)a Retrieves and monitors the status of a task by its ID and validates the task's data or progress. Args: task_id (str): The ID of the task to check. task_name (str): The name of the task. data_validation (str, optional): A key to validate the task's data. Defaults to None. progress_validation (str, optional): A key to validate the task's progress. Defaults to None. failure_msg (str, optional): A custom message to log if the task fails. Defaults to None. success_msg (str, optional): A custom message to log if the task succeeds. Defaults to None. Returns: self: The instance of the class. r-r+Tr.rFrrrzFailure reason: {0}r/rr1rrr0z/Current task progress for '{0}': {1}, Data: {2}rrr2r3) rr`rcr r8rr4r'rr)rfrr& failure_msgr4progress_validationdata_validationr%r/r6rrrr"r7r8s rjget_task_status_from_task_by_idz(DnacBase.get_task_status_from_task_by_id#s))+ IPPQZ\cdfmn,,W5HV]]^gipq))(E488WM||I&!)o!>)!HH 5 < <^ LLH))(E488WM HH?FFxPRX Y 99;8L**?GYOlss$i  <<'D||J/H||I.H HHFMMiYacghjp q"$'>*DH--itxxPHHTXXv.&+>(+J*DH--itxxPHHTXXv.!KKOO,EFM HHkrrtABDK L JJ} %or"YY[?: \ccdmovyKLNU V rlc|||jdjd|jdjdtfd|DS)aA Check if the config given requires update by comparing current information with the requested information. This method compares the current fabric devices information from Cisco Catalyst Center with the user-provided details from the playbook, using a specified schema for comparison. Args: have (dict): Current information from the Cisco Catalyst Center of SDA fabric devices. want (dict): Users provided information from the playbook obj_params (list of tuples) - A list of parameter mappings specifying which Cisco Catalyst Center parameters (dnac_param) correspond to the user-provided parameters (ansible_param). Returns: bool - True if any parameter specified in obj_params differs between current_obj and requested_obj, indicating that an update is required. False if all specified parameters are equal. Description: This function retrieves the object parameters needed for the requires_update function. The obj_params will contain patterns to be compared based on the specified object. This function checks both the information provided by the user and the information available in the Cisco Catalyst Center. Based on the object_params the comparison will be taken place. If there is a difference in those information, it will return True. Else False. z#Current State (have): {current_obj}) current_objr+z%Desired State (want): {requested_obj}) requested_objc3zK|]2\}}tj|j| 4ywrdnac_compare_equalityr4)rt dnac_param ansible_paramr@rAs rjrvz+DnacBase.requires_update..sDB2 M-[__Z-H-:->->}-MOOBs8;)r`rcr~)rfr5r6 obj_paramsr@rAs @@rjrequires_updatezDnacBase.requires_updatepsi<   6==+=VX_` 8??m?\^efB6@BB Brl)r%r)Fr)r NN)Tr __module__ __qualname____doc__r __metaclass__rXrkrrrrrr rr?r@rArBrCrDrErGrHrIrJrKrLrMr]rZr[r`rrrr:r r r%r(r.r4r;rHr_rhrvrBrVrrrrrrrrrrrrrrrrrrrrr rrrrrrrr'rXr+r9r>rHrrrlrjrr)sKMMFUP80+,4               (*d s$(Z"7*0"&P "GR 61f"B5(n/#b5@nAF"&HpMd 4d&d*.20!d1!f1!f1!f2!h1f!F, $L X'R@$$:#J'R?B@# C,=)~6)pENKZ%BrlrcRt|dtxst|dtS)Nr)rrry)xs rjis_list_complexrPs# adD ! ;Z!d%;;rlc,tfd|DS)Nc3&K|]}|v ywrrr)rtelemls1s rjrvz has_diff_elem..s0DC0s)r~)rTls2s` rj has_diff_elemrVs 0C0 11rlct|}t|}||k7ry|dk(ry||k(}|ryt|s"t|st|t|k(Sd}||kDr|St|| xs t|| S)NFrTd)r}rPsetrV)list1list2 len_list1 len_list2attempt_std_cmp MAX_SIZE_CMPs rj compare_listr`sE IE IIA~unO 5 !/%*@5zSZ''L<"%/0Uue9T4UUrlcVt|j||j|SrrC)kdict1dict2s rj fn_comp_keyres 1uyy| < Normalize an IPv6 address for consistent comparison. z4Input must be a string representing an IPv6 address.)rrrrrr)ipv6normalized_addresss rjnormalize_ipv6_addressrisO dC NOO !6!6t!<=!!  s= A  A cyyttr3ttr#dvrdvrttk(SttrYttrIt j t j z}t fd|D Sttrttr tSk(S)NT:c3:K|]}t| ywr)re)rtr current_valuerequested_values rjrvz(dnac_compare_equality..slSXK}oNNls)rrrirrykeysr~r`)rmrnall_dict_paramss`` rjrDrDs-%*_c*J - C?$:2=AM4_EO//-&:ot+L}1134tO}t|ts|j ||j ||k(s:|}|cSd}|St|tsd}|S|j ||j ||k7rd}|S)Nrnr)rryr}rr4)rerr:cmp_fnrFs rjget_dict_resultrws&$ v;! &)T*::c?.6::c?e3K!F M M "dD)txx}/DQT Y^H^!F!M "F M  % M C $CE)A Mrlc ttddtdddtddd g tdd td d tdd td d td d }|S)NrT)rArequiredrQFi)rArydefaultadminuser)rArzaliases)rAno_logbool)rArzr )rrrrrrrvalidate_response_schema)r) argument_specs rjdnac_argument_specrsjED1EE3?wId3fd3ui8VU3!%64!@ M rlc tj|}|jdrWdt|cxkr|jdkr|S|j dj |||jd|S)a This function checks that the input `item` is a valid string and confirms to the constraints specified in `param_spec`. If the string is not valid or does not meet the constraints, an error message is added to `invalid_params`. Args: item (str): The input string to be validated. param_spec (dict): The parameter's specification, including validation constraints. param_name (str): The name of the parameter being validated. invalid_params (list): A list to collect validation error messages. Returns: str: The validated and possibly normalized string. Example `param_spec`: { "type": "str", "length_max": 255 # Optional: maximum allowed length } length_maxrnz>{0}:{1} : The string exceeds the allowed range of max {2} char)r check_type_strr4r}rYrcrF param_spec param_nameinvalid_paramss rj validate_strr sx,  $ $T *D~~l# D 9Z^^L9 9K :  ! !((.z4P\A](^  Krlc  tj|}|j dd}|j drQ||cxkr|dksCn|jdj |||j d|j d|S#t$r7}|jdj ||t ||cYd}~Sd}~wwxYw)a& This function checks that the input `item` is a valid integer and conforms to the constraints specified in `param_spec`. If the integer is not valid or does not meet the constraints, an error message is added to `invalid_params`. Args: item (int): The input integer to be validated. param_spec (dict): The parameter's specification, including validation constraints. param_name (str): The name of the parameter being validated. invalid_params (list): A list to collect validation error messages. Returns: int: The validated integer. Example `param_spec`: { "type": "int", "range_min": 1, # Optional: minimum allowed value "range_max": 100 # Optional: maximum allowed value } z{0}: value: {1} {2}N range_minrn range_maxzF{0}: {1} : The item exceeds the allowed range of min: {2} and max: {3})r check_type_intrrYrcrr4)rFrrrr min_values rjvalidate_integer_within_ranger/ s,((. {A.I~~k"I,XKAX,X T [ [D*.."=z~~k?Z \ K 3:::tSQRVTU sB C ,CC C c,tj|S)a  This function checks that the input `item` is a valid boolean value. If it does not represent a valid boolean value, an error message is added to `invalid_params`. Args: item (bool): The input boolean value to be validated. param_spec (dict): The parameter's specification, including validation constraints. param_name (str): The name of the parameter being validated. invalid_params (list): A list to collect validation error messages. Returns: bool: The validated boolean value. )r check_type_boolrs rj validate_boolrU s  % %d ++rlc" |jdt|jk(rg}|D]}|j|t |dk(rt j |S|d||di} |dr|d}|d}t|j|k(rB|D]<} t| j|k7s|jdj| |>n!|jdj|||S|jdj| |S#t$r+} t||\}} |j| Yd} ~ |Sd} ~ wwxYw#t$r+} |jdj| Yd} ~ |Sd} ~ wwxYw)a This function checks if the input `item` is a valid list based on the specified `param_spec`. It also verifies that the elements of the list match the expected data type specified in the `param_spec`. If any validation errors occur, they are appended to the `invalid_params` list. Args: item (list): The input list to be validated. param_spec (dict): The parameter's specification, including validation constraints. param_name (str): The name of the parameter being validated. invalid_params (list): A list to collect validation error messages. Returns: list: The validated list, potentially normalized based on the specification. rArnelementsz8{0} is not of the same datatype as expected which is {1}Nz{0} : is not a valid listz{0} : comes into the exception) r4rArrYr}r check_type_listrcrvalidate_list_of_dictsr}) rFrrr keys_listdict_key temp_dict get_spec_typeget_spec_elementelementrlist_invalid_paramss rj validate_listrg s J >>& !T$Z%8%8 8I& +  * +9~"!11$77"1z)A,'?@I ;j)$.v$6M'1*'=$Dz**m;'+"G#G}559II . 5 5$^$e$efmo%A!"" '--V]]^bdqr K  ! !"="D"DT"J K K ;,B4,S))%%&9:: K ; J>EEaHII KJsPA#E& E4AD#9AD# E# E, E EEE F# F  Fc|jdt|jk7r |jdj |t j |S)ar This function checks if the input `item` is a valid dictionary based on the specified `param_spec`. If the dictionary does not match the expected data type specified in the `param_spec`, a validation error is appended to the `invalid_params` list. Args: item (dict): The input dictionary to be validated. param_spec (dict): The parameter's specification, including validation constraints. param_name (str): The name of the parameter being validated. invalid_params (list): A list to collect validation error messages. Returns: dict: The validated dictionary. rAz{0} : is not a valid dictionary)r4rArrYrcr check_type_dictrs rj validate_dictr sJ ~~fd!4!44?FFtLM  % %d ++rlc vt}g}g}|D]}i}|s|jd||fS|D]r}|j|} | O||jdr!|jdj|n||jd} | ||<f||jd} tt t ttd} | j| } | r| | ||||} n"|jdj|| | ||jd} | r$| | vr |jd j| ||jd }|rD||jj| n&d j|}|d z }|d z }t|| ||<u|j|||fS)aOValidate/Normalize playbook params. Will raise when invalid parameters found. param_list: a playbook parameter list of dicts spec: an argument spec dict e.g. spec = dict(ip=dict(required=True, type='bool'), foo=dict(type='str', default='bar')) return: list of normalized input data z/No more spec to validate, but parameters remainryz"{0} : Required parameter not foundrzrA)rrQrryrz${0}:{1} : Unsupported data type {2}.choicesz{0} : Invalid choice providedr~z '{0}' is a no_log parameterz. Ansible module object must be passed to this z& function to ensure it is not logged ) r rYr4rcrrrrr no_log_valuesaddr) param_listspecr1v normalizedr list_entryvalid_params_dictrrF data_typeswitch validatorchoicer~r8s rjrr s AJN 4-   ! !"S T b ~ %%a- ,E>>%(D|;??:."))<CCEJ ;??95D/3%e,U /I#4%%% F 9-I tE{E>J%%:AA%yY%[__Y/Fv%"))7>>tD%[__X.F%((,,T2;BB5ICLLCFFC#C.('+ e $[- ,\ +,i4-l ~ %%rlzRate Limit exceededcdeZdZdZdZdZdZdZdZdZ dZ dd Z d Z d Z dd ZdZdZy )r;c ztdd|_|jd|_t j d|_trtj|jd|jddj|jd |jd  |jd |jd |jd|_|jdr5tr.|j jt jyyy|jdy)NFrr-rer dnacentersdkrrzhttps://{dnac_host}:{dnac_port}rr)rrrrr)usernamerbase_urlversionverifydebugzJDNA Center Python SDK is not installed. Execute 'pip install dnacentersdk'r)rrer4rr^r_r*DNAC_SDK_IS_INSTALLEDr DNACenterAPIrcLOGGING_IN_STANDARDra StreamHandlerr)rfrs rjrkzDNACSDK.__init__ s54 (. 3M(N%''7 ''O4O4:AA$jj5KAXB >2zz-0jj. DHzz,',? &&w'<'<'>?-@' NNkN lrlc"d|jd<y)NTr-rers rjr-zDNACSDK.changed s!% IrlcB|jd|jd<y)NzObject createdrerrs rjobject_createdzDNACSDK.object_created   0 HrlcB|jd|jd<y)NzObject updatedrerrs rjobject_updatedzDNACSDK.object_updated rrlcB|jd|jd<y)NzObject deletedrerrs rjobject_deletedzDNACSDK.object_deleted rrlc"d|jd<y)NzObject already absentrerrs rjobject_already_absentzDNACSDK.object_already_absent s 7 Hrlc"d|jd<y)NzObject already presentrerrs rjobject_already_presentzDNACSDK.object_already_present s 8 Hrlc"d|jd<y)NzDObject already present, but it has different values to the requestedrerrs rjobject_present_and_differentz$DNACSDK.object_present_and_different" s f HrlNcL|||jd<|r|jyy)Nre)rer-)rfr-res rjobject_modify_resultzDNACSDK.object_modify_result% s'  $*DKK !  LLN rlc@tjj|Sr)rrisfilerfrs rjis_filezDNACSDK.is_file+ sww~~i((rlc@tjj|Sr)rrbasenamers rjextract_file_namezDNACSDK.extract_file_name. sww **rlc |}|} t|j|}t||} |r|j dg} | rt | t ri} | D]d\} } t |j | ts&|j|| s;|j|| }|| }|t|df| | <f|jd| |jdd|js|rd|d<di|}n}|rt |tr|j dr|j d}d |i}tt|jd d } |di|}|j d d k(r |S|j d}|rut|vrO|jj!dtt#j$t&|j(||||fi|S|jj+| |S|S#t$r} |j| Yd} ~ d} ~ wwxYw#t,j.$rj} |jdj1t3| j4j6t3| j4j8||Yd} ~ Sd} ~ wt,j:$r8} |jdj1t3| ||Yd} ~ Sd} ~ wwxYw)Nr file_pathsrbmultipart_fieldsmultipart_monitor_callbackFactive_validationr0r+rr*r9r1r2z!!!!! %s !!!!!zAn error occured when executing operation for the family '{family}' having the function '{function}'. The error was: status_code: {error_status}, {error}) error_statusrrrz|An error occured when executing operation for the family '{family}' having the function '{function}'. The error was: {error})rrrrr)rrrrr4rryrrrr setdefaultrrRATE_LIMIT_MESSAGEr*warningrrRATE_LIMIT_RETRY_AFTERr=rrApiErrorrcr r/ status_codetextdnacentersdkException)rfrrrrkwargs family_name function_namefuncrfile_paths_paramsrrr: file_namerr/r+exec_details_paramsexec_details_funcr3 bapi_errors rjr=z DNACSDK._exec1 s   "TXXv.F68,D@ $*JJ|R$@!$4Et)L')$(9Y e%fjjos; VTW[@Y(,(>(>vc{(KI(.s I7@$yRVBW6X,U3 Y %%&8:JK%%&BDI4427F./>&> 6Jx68<< ;V'||M: '5|&D#$+DHHf-/S%!(9(P#-4:: +]FK$SY$ ))*5(GFI " NNqN ! ! "d""  NNL&i 0F0F&GyYZYcYcYhYhOi +mE   "//  NN.&y|K-&X    s\"HAH-9H-C(H-9A)H-#H-H- H* H%%H*-K3AJ%%K3;-K..K3c P|jjdi|t|)Nrr)rerr)rfr8rs rjrzDNACSDK.fail_json} s# $V$nrlc|jSrrrs rjrzDNACSDK.exit_json s {{rlrI)NF)rrJrKrkr-rrrrrrrrrr=rrrrrlrjr;r; sLm(&11189g )+JXrlr;cyrrrrrrlrjmainr srl__main__r)7 __future__rrrrArMcryptography.fernetrr ImportErrorrrrransible.module_utils._textr ansible.module_utils.commonr abcr r r^rros.pathrr2r6rrrrr!rrPrVr`rerirDrtrwrrrrrrrrrobjectr;rrrrrlrjrsDCB *J!,!02'  l!Bl!B^C<2V4= 000:, D#L,$/d,*C&L+JfJZ  zF{SJ"!"  s3B:CC:CCCCCC