Vh"ddlmZmZmZeZdZdZdZdZ ddl m Z ddl m Z mZmZGdd e Zd Zed k(rey y ) )absolute_importdivisionprint_functionz:Abinash Mishra, Madhan Sankaranarayanan, Rishita Chowdharya --- module: pnp_intent short_description: Resource module for Site and PnP related functions description: - Manage operations add device, claim device and unclaim device of Onboarding Configuration(PnP) resource - API to add device to pnp inventory and claim it to a site. - API to delete device from the pnp inventory. - API to reset the device from errored state. version_added: 6.6.0 extends_documentation_fragment: - cisco.dnac.intent_params author: Abinash Mishra (@abimishr) Madhan Sankaranarayanan (@madhansansel) Rishita Chowdhary (@rishitachowdhary) options: config_verify: description: Set to True to verify the Cisco Catalyst Center config after applying the playbook config. type: bool default: false state: description: The state of Cisco Catalyst Center after module completion. type: str choices: - merged - deleted default: merged config: description: - List of details of device being managed. type: list elements: dict required: true suboptions: device_info: description: - Provides the device-specific information required for adding devices to the PnP database that are not already present. - For adding a single device, the list should contain exactly one set of device information. If a site name is also provided, the device can be claimed immediately after being added. - For bulk import, the list must contain information for more than one device. Bulk import is intended solely for adding devices; claiming must be performed with separate tasks or configurations. type: list required: true elements: dict suboptions: hostname: description: - Defines the desired hostname for the PnP device after it has been claimed. - The hostname can only be assigned or changed during the claim process, not during bulk or single device additions. type: str state: description: - Represents the onboarding state of the PnP device. - Possible values are 'Unclaimed', 'Claimed', or 'Provisioned'. type: str pid: description: Pnp Device's pid. type: str serial_number: description: Pnp Device's serial_number. type: str is_sudi_required: description: Sudi Authentication requiremnet's flag. type: bool site_name: description: Name of the site for which device will be claimed. type: str project_name: description: Name of the project under which the template is present type: str default: Onboarding Configuration template_name: description: - Name of template to be configured on the device. - Supported for EWLC from Cisco Catalyst Center release version 2.3.7.x onwards. type: str template_params: description: - Parameter values for the parameterised templates. - Each varibale has a value that needs to be passed as key-value pair in the dictionary. We can pass values as variable_name:variable_value. - Supported for EWLC from Cisco Catalyst Center release version 2.3.7.x onwards. type: dict image_name: description: Name of image to be configured on the device type: str golden_image: description: Is the image to be condifgured tagged as golden image type: bool pnp_type: description: Specifies the device type for the Plug and Play (PnP) device. - Options include 'Default', 'CatalystWLC', 'AccessPoint', or 'StackSwitch'. - 'Default' is applicable to switches and routers. - 'CatalystWLC' should be selected for 9800 series wireless controllers. - 'AccessPoint' is used when claiming an access point. - 'StackSwitch' should be chosen for a group of switches that operate as a single switch, typically used in the access layer. type: str choices: - Default - CatalystWLC - AccessPoint - StackSwitch default: Default static_ip: description: Management IP address of the Wireless Controller type: str subnet_mask: description: Subnet Mask of the Management IP address of the Wireless Controller type: str gateway: description: Gateway IP address of the Wireless Controller for getting pinged type: str vlan_id: description: Vlan Id allocated for claimimg of Wireless Controller type: str ip_interface_name: description: Specifies the interface name utilized for Plug and Play (PnP) by the Wireless Controller. Ensure this interface is pre-configured on the Controller prior to device claiming. type: str rf_profile: description: - Radio Frequecy (RF) profile of the AP being claimed. - RF Profiles allow you to tune groups of APs that share a common coverage zone together. - They selectively change how Radio Resource Management will operate the APs within that coverage zone. - HIGH RF profile allows you to use more power and allows to join AP with the client in an easier fashion. - TYPICAL RF profile is a blend of moderate power and moderate visibility to the client. - LOW RF profile allows you to consume lesser power and has least visibility to the client. type: str choices: - HIGH - LOW - TYPICAL requirements: - dnacentersdk == 2.6.10 - python >= 3.9 notes: - SDK Method used are device_onboarding_pnp.DeviceOnboardingPnp.add_device, device_onboarding_pnp.DeviceOnboardingPnp.get_device_list, device_onboarding_pnp.DeviceOnboardingPnp.claim_a_device_to_a_site, device_onboarding_pnp.DeviceOnboardingPnp.delete_device_by_id_from_pnp, device_onboarding_pnp.DeviceOnboardingPnp.get_device_count, device_onboarding_pnp.DeviceOnboardingPnp.get_device_by_id, device_onboarding_pnp.DeviceOnboardingPnp.update_device, sites.Sites.get_site, software_image_management_swim.SoftwareImageManagementSwim.get_software_image_details, configuration_templates.ConfigurationTemplates.gets_the_templates_available - Paths used are post /dna/intent/api/v1/onboarding/pnp-device post /dna/intent/api/v1/onboarding/pnp-device/site-claim post /dna/intent/api/v1/onboarding/pnp-device/{id} get /dna/intent/api/v1/onboarding/pnp-device/count get /dna/intent/api/v1/onboarding/pnp-device put /onboarding/pnp-device/${id} get /dna/intent/api/v1/site get /dna/intent/api/v1/image/importation get /dna/intent/api/v1/template-programmer/template aW - name: Import multiple switches in bulk only cisco.dnac.pnp_intent: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" dnac_log_level: "{{dnac_log_level}}" dnac_log: true state: merged config_verify: true config: - device_info: - serial_number: QD2425L8M7 state: Unclaimed pid: c9300-24P is_sudi_required: false - serial_number: QTC2320E0H9 state: Unclaimed pid: c9300-24P hostname: Test-123 - serial_number: ETC2320E0HB state: Unclaimed pid: c9300-24P - name: Add a new EWLC and claim it cisco.dnac.pnp_intent: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" dnac_log_level: "{{dnac_log_level}}" dnac_log: true state: merged config_verify: true config: - device_info: - serial_number: FOX2639PAY7 hostname: New_WLC state: Unclaimed pid: C9800-CL-K9 site_name: Global/USA/San Francisco/BGL_18 template_name: Ansible_PNP_WLC template_params: hostname: IAC-EWLC-Claimed project_name: Onboarding Configuration image_name: C9800-40-universalk9_wlc.17.12.01.SPA.bin golden_image: true pnp_type: CatalystWLC static_ip: 204.192.101.10 subnet_mask: 255.255.255.0 gateway: 204.192.101.1 vlan_id: 1101 ip_interface_name: TenGigabitEthernet0/0/0 - name: Claim a pre-added switch, apply a template, and perform an image upgrade for a specific site cisco.dnac.pnp_intent: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" dnac_log_level: "{{dnac_log_level}}" dnac_log: true state: merged config_verify: true config: - device_info: - serial_number: FJC271924EQ hostname: Switch state: Unclaimed pid: C9300-48UXM site_name: Global/USA/San Francisco/BGL_18 template_name: "Ansible_PNP_Switch" image_name: cat9k_iosxe_npe.17.03.07.SPA.bin project_name: Onboarding Configuration template_params: hostname: SJC-Switch-1 interface: TwoGigabitEthernet1/0/2 - name: Remove multiple devices from the PnP dashboard safely (ignores non-existent devices) cisco.dnac.pnp_intent: dnac_host: "{{dnac_host}}" dnac_username: "{{dnac_username}}" dnac_password: "{{dnac_password}}" dnac_verify: "{{dnac_verify}}" dnac_port: "{{dnac_port}}" dnac_version: "{{dnac_version}}" dnac_debug: "{{dnac_debug}}" dnac_log_level: "{{dnac_log_level}}" dnac_log: true state: deleted config_verify: true config: - device_info: - serial_number: QD2425L8M7 - serial_number: FTC2320E0HA - serial_number: FKC2310E0HB ah #Case_1: When the device is claimed successfully. response_1: description: A dictionary with the response returned by the Cisco Catalyst Center Python SDK returned: always type: dict sample: > { "response": { "response": String, "version": String }, "msg": String } #Case_2: Given site/image/template/project not found or Device is not found for deletion response_2: description: A list with the response returned by the Cisco Catalyst Center Python SDK returned: always type: list sample: > { "response": [], "msg": String } #Case_3: Error while deleting/claiming a device response_3: description: A string with the response returned by the Cisco Catalyst Center Python SDK returned: always type: dict sample: > { "response": String, "msg": String } ) AnsibleModule)DnacBasevalidate_list_of_dictsget_dict_resultcteZdZfdZdZdZdZdZdZddZ dZ d Z d Z d Z d Zd ZdZdZxZS)PnPc$t||yN)super__init__)selfmodule __class__s i/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/dnac/plugins/modules/pnp_intent.pyrz PnP.__init__As  cB|jsd|_d|_|Sddddddddddddddddd ddd d dd ddd ddddddddddddddddddddddd}t|j|\}}|rSdj dj ||_|j t|jdd|_|S||_dj t||_|j t|jdd|_|S)ag Validate the fields provided in the playbook. Checks the configuration provided in the playbook against a predefined specification to ensure it adheres to the expected structure and data types. Parameters: - self: The instance of the class containing the 'config' attribute to be validated. Returns: The method returns an instance of the class with updated attributes: - self.msg: A message describing the validation result. - self.status: The status of the validation (either 'success' or 'failed'). - self.validated_config: If successful, a validated version of the 'config' parameter. Example: To use this method, create an instance of the class and call 'validate_input' on it.If the validation succeeds, 'self.status' will be 'success'and 'self.validated_config' will contain the validated configuration. If it fails, 'self.status' will be 'failed', and 'self.msg' will describe the validation issues. z/config not available in playbook for validationsuccessstrF)typerequireddictzOnboarding Configuration)rrdefaultboollistT)rrelementsDefault) template_nametemplate_params project_name site_name image_name golden_image device_infopnp_type rf_profile static_ip subnet_maskgatewayvlan_idip_interface_name sensorProfilez#Invalid parameters in playbook: {0} ERRORfailedz2Successfully validated playbook config params: {0}INFO) configmsgstatusrformatjoinlogrvalidated_config)rpnp_spec valid_pnpinvalid_paramss rvalidate_inputzPnP.validate_inputDsL0{{HDH#DKK',?(.EB%*(BD"'U;#(e<%+?$*(.0!&EiP#(e<"'U;$)u= %59 %59*/U!C&+?# *%; KK% ! > <CC .)+DH HHS]G ,"DKK )GNNsS\~^ TXX'  rcd}d}d} |jdddd|jjdid }|r|j dj |jjdt|d|jd}t|dk(rQ|djd}d}|j dj ||jjdd||fS#t$r[|j d j |jjdd |j jd g YwxYw)ab Check whether the site exists or not, along with side id Parameters: - self: The instance of the class containing the 'config' attribute to be validated. Returns: The method returns an instance of the class with updated attributes: - site_exits: A boolean value indicating the existence of the site. - site_id: The Id of the site i.e. required to claim device to site. Example: Post creation of the validated input, we this method gets the site_id and checks whether the site exists or not FNexecsitesget_sitenamer#Tfamilyfunctionparams op_modifiesz>Exception occurred as site '{0}' was not foundCRITICALSite not foundr4responsez4Received site details for '{0}': {1}DEBUGrKridzSite Name: {1}, Site ID: {0}r2) dnac_applywantget Exceptionr8r6r fail_jsonrlen)r site_existssite_idrKsites rget_site_detailszPnP.get_site_detailss?   E.tv.# k :; H  HH &tyy}}['A3x= QSZ \<< +D4yA~q'++d+" 7>>w VaHbceklW%% E HH%%+VDIIMM+,F%G U KK ! !&6 ! D Es4C66A EEc  |jdddd|jjdid}r|j d j |jjdt|d |jd}|djd}|D]f}|ddk(s |jdjd}|j dj ||jjddhS#t$r[|j dj |jjdd |j jd g Y;wxYw)a Fetches the type of site Parameters: - self: The instance of the class containing the 'config' attribute to be validated. Returns: The method returns an instance of the class with updated attributes: - site_type: A string indicating the type of the site (area/building/floor). Example: Post creation of the validated input, we this method gets the type of the site. r?r@rArBr#TrCz>Exception occurred as site '{0}' was not foundrHrIrJz3Received site details for '{0}': {1}rLrKradditionalInfo nameSpaceLocation attributesrz#Site type for site name '{1}' : {0}r2) rOrPrQrRr8r6rrSr)rrKrWsite_additional_infoitem site_types r get_site_typezPnP.get_site_typesY E.tv.# k :; H  HH &tyy}}['A3x= QSZ \<< +D#'7;;/?#@ , z $ 2 $ 6 : :6 BIHHBII)UYU^U^UbUbcnUoprxy z  E HH**0&{1K*Lj Z KK ! !&6 ! D Es4DA E21E2c|d}g}|D]F}i}|jd|d<d|vr|jd|d<||d<|j|H|jdjt |d|S) a Store pnp parameters from the playbook for pnp processing in Cisco Catalyst Center. Parameters: - self: The instance of the class containing the 'config' attribute to be validated. - params: The validated params passed from the playbook. Returns: The method returns an instance of the class with updated attributes: - pnp_params: A dictionary containing all the values indicating the type of the site (area/building/floor). Example: Post creation of the validated input, it fetches the required paramters and stores it for further processing and calling the parameters in other APIs. r& serial_number serialNumberis_sudi_requiredisSudiRequired deviceInfozPnP paramters passed are {0}r2)popappendr8r6r)rrF params_listdevice_info_listparam device_dicts rget_pnp_paramszPnP.get_pnp_paramss$]+   1EK$)IIo$>E. !!U**/))4F*G&'(-K %  # #K 0  1 /66s;7GH&Qrc|jd|jdd}|jdjt|d|S)a Get image name and the confirmation whether it's tagged golden or not Parameters: - self: The instance of the class containing the 'config' attribute to be validated. - params: The validated params passed from the playbook. Returns: The method returns an instance of the class with updated attributes: - image_params: A dictionary containing all the values indicating name of the image and its golden image status. Example: Post creation of the validated input, it fetches the required paramters and stores it for further processing and calling the parameters in other APIs. r$r%)r$is_tagged_goldenzImage details are {0}r2)rQr8r6r)rrF image_paramss rget_image_paramszPnP.get_image_paramssJ&!**\2 & > : (//L0ABFKrc`|j|d|jj|y)z| Method for failing discovery if there is any discrepancy in the PnP credentials passed by the user rHr4N)r8rrS)rr4s rpnp_cred_failurezPnP.pnp_cred_failures' j! #&rc\d|jjdi}|jdjd}|jjddddgd}|jd rV|rTt|trDt |dkDr6g|d <|j D]\}}||d}|d j| |jjd |jjd |jjd |jjd||d}|ddk(rx|jdjdsd}|j||jdjdsd}|j||jdjdsd}|j||jdjdsd}|j||jdjdsd}|j||jdd|d<|jdd|d<|jdd|d<t|jdjd|d<|jdd|d <|dd!k(rG|jdjd"sd#}|j||jdd"|d$<|jd%jt|d&|S)'a, Get the paramters needed for claiming the device to site. Parameters: - self: The instance of the class containing the 'config' attribute to be validated. Returns: The method returns an instance of the class with updated attributes: - claim_params: A dictionary needed for calling the POST call for claim a device to a site API. Example: The stored dictionary can be used to call the API claim a device to a site via SDK imageIdimage_idrr! template_idkeyvalueconfigIdconfigParametersrr device_idrVr'hostname)deviceIdsiteIdrr imageInfo configInfor CatalystWLCr)zSA static IP address is required to claim a wireless controller. Please provide one.rtr*zqPlease provide a subnet mask to claim a wireless controller. This information is mandatory for the configuration.r+zUA gateway IP is required to claim a wireless controller. Please ensure to provide it.r-a Please provide the Interface Name to claim a wireless controller. This information is necessary for making it a logical interface post claiming which can used to help manage the Wireless SSIDs broadcasted by the access points, manage the controller, access point and user data, plus more.r,zPlease provide the Vlan ID to claim a wireless controller. This is a required field for the process to create and set the specified port as trunk during PnP.staticIP subnetMaskvlanIdipInterfaceName AccessPointr(z0The RF Profile for claiming an AP must be passed rfProfilez$Parameters used for claiming are {0}r2) haverQr9 isinstancerrTitemsrirPrurr8r6) r imageinfor! configinfor|r} config_dict claim_paramsr4s rget_claim_paramszPnP.get_claim_paramss7 tyy}}Z0 //2667HI m4!  >>* %//40'!+57J12&5&;&;&=K U#&%*' ##56==kJ K k2iimmI.IIMM*- j1"$    = 0))!,00=k%%#%.))!,00?K%%#%.))!,00;m%%#%.))!,001DEv%%#%.))!,00;Q%%#%.'+'<')>q)A-)PL &&*&;&;A&>y&IL #%()>)>q)A)E)Ei)P%QL ".2.C.CA.FGZ.[L* +  = 0))!,00>H%%#%.(,(=(=a(@(NL % 7>>sj | |_|j |jd3d*|_|S|jjddjd#s,d?|_|j |jd)d*|_|Sd@|_|j |jd&d|_||_ |S)Aa Get the current image, template and site details from the Cisco Catalyst Center. Parameters: - self: The instance of the class containing the 'config' attribute to be validated. Returns: The method returns an instance of the class with updated attributes: - self.image_response: A list of image passed by the user - self.template_list: A list of template under project - self.device_response: Gets the device_id and stores it Example: Stored paramters are used to call the APIs to get the current image, template and site details to call the API for various types of devices pnp_paramsrMr?device_onboarding_pnpget_device_listrcTrCzKDevice details for the device with serial number '{0}': {1}rLz;Device with serial number {0} is not found in the inventoryWARNINGzAdding the device to databaserF device_foundrrNrz Device Id: statemergedsoftware_image_management_swimget_software_image_detailsrqrKzEImage details obtained from the API 'get_software_image_details': {0}configuration_templatesgets_the_templates_available project_namesr"z.List of templates under the project '{0}': {1}get_device_by_idzFDevice details retrieved after calling the 'get_device_by_id' API: {0}rgmodez=Installation mode of the device with the serial no. '{0}':{1}r2r#zThe site name must be a stringr0r1rVz,Site Exists: {0} Site Name: {1} Site ID: {2}r'rfloorzPlease ensure that the site type is specified as 'floor' when claiming an AP. The site type is given as '{0}'. Please change the 'site_type' into 'floor' to proceed.zThe image '{0}' is either not present or not tagged as 'Golden' in the Cisco Catalyst Center. Please verify its existence and its tag status.r$rHINSTALLz}The system must be in INSTALL mode to upgrade the image. The current mode is '{0}'. Please switch to INSTALL mode to proceed. imageUuidrxz!Image ID for the image '{0}': {1}r z(Either project not found or it is Empty.rB templateIdryzTemplate '{0}' is not found.z1Either Site Name or Device details must be added.zxSuccessfully collected all project and template parameters from Cisco Catalyst Center for comparison)rTrPrQrOr8r6rr4r5rrFrrXrar9rr ) rrdevice_responseimage_response image_list template_listdev_details_response install_moderUr#rVr template_detailss rget_havez PnP.get_haves_  tyy}}\* +q 05doof5.*')GH O HH##)6$))--*H#oJ^#_ah j$_)=)BV]]^b^g^g^k^kl{^|}@IJ:'   ',^$ #'D / 2 6 6t -JK $ ! IPPQUQZQZQ^Q^_mQnpsuBqCDFMN'>tv'>2/ /!"4"8"8">? $ ($ ahhilnBjCDFMN377 EII&Q X__`d`i`i`m`mn}`~AMNPVW$ !$))-- ">|L?DHHHS]G4"*DKK IIMM+6 )-)>)>)@&g&-DOHHMTTU`bkmtuw}~yy}}Z0MA--/7:(++16$2D2D2F+G!H!HHS]G<*2DK#'K:!+$OOUvVZVkVklmVnVrVrsWAPB:6&. # :!+'94(MMSVT`Ma!H HHS]J?*2DK#'K+5a=+<+<[+IZ(!D!K!KDIIMMZhLiLmLmnzL{~ABFGQBR~S"TV\]$(IIMM/$BM$ -*]D2Q(3DH HHTXXz:*2DK#'K+:=&R_+`(+2B2F2F|2TD/'E'L'L]'[DH HHTXXz:*2DK#'K 99==6q9==lK#V73&. # J 6"   rc|j||j||jd|jd|jd|jdd|_t |jjddk(rb|jddd jd |jd <|jddd jd |jd <|jdd k(r|jd|jd<|jd|jd<|jd|jd<|jd|jd<|jd|jd<n0|jddk(r|jd|jd<d|_|j |j dd|_|S)a3 Get all the image, template and site and pnp related information from playbook that is needed to be created in Cisco Catalyst Center. Parameters: - self: The instance of the class containing the 'config' attribute to be validated. - config: validated config passed from the playbook Returns: The method returns an instance of the class with updated attributes: - self.want: A dictionary of paramters obtained from the playbook. - self.msg: A message indicating all the paramters from the playbook are collected. - self.status: Success. Example: It stores all the paramters passed from the playbook for further processing before calling the APIs r'r#r"r )rqrr'r#r"r rrMrrgrdrcrrr)r*r+r,r-rr(zBSuccessfully collected all parameters from playbook for comparisonr2r)rrrnrQrPrTr4r8r5)rr3s rget_wantz PnP.get_want(s*!11&9--f5 :.K0"JJ~6#ZZ8    tyy}}\* +q 0 ,'*<8N# IIo &  ,'*<8J IIj ! 99Z M 1%+ZZ %DIIl # 6"  rc t|jjdts,d|_|j |jdd|_|St|jjddkDrrg}|jjdD]}|jdddd |d d id }|j dj|d d t|d|sXt|dk(sg|j||j djt|dt|jjdt|z dk(r?g|jd<d|jd<|j |jdd|S|jjdDcgc]}||vr| }}|jdddd|id }|j dj|dt|jddkDrdjt|jd|jd<|j |jdd||jd<|j|jd<d |jd<|Sd|_|j |jdd|_|S|jjd d d!}|jjd d"d!}|jjd#sK|jds,d$|_|j |jdd|_|S|jd%s4|j d&d|jddd'|jjddd }|jd |jd <|j d(jt|d|jd rgd)|jd<|j |jdd||jd<|j|jd<d |jd<|Sd*|_|j |jddd|_|S|j d&|jddd'|jjddd }|jj!|jd |jd <|j d+jt|d|j#} |jd,| d-<|jddd.d | /} |j d0jt|d| jdd1k(rv|jd rgd2|jd<|j |jdd| |jd<|j|jd<d |jd<|Sd3|_|j |jddd|_|S|jddd4d |/} |j d5jt| d|jddd4d |/} |j d6jt| d|jddd7d,|jd8id } |j d9jt| dd:}| jd jd;r | jd jd;}| jd jd<}|j d=j|d|jd%sX|jjd#|jd<d>|jd<|j |jdd|Sd |jjddjd i}||d d;<|j d?j|d|jddd@|jd8|dAd }|j dBjt|d|dCk(r|j%}|jdddDd|id }|j dEjt|ddF|jd<|j |jdd||jd<|j|jd<d |jd<|S| jddk(r| jddk(r|dGk(sx|jjd#|jd<dH|jd<|j |jdd|jd rd |jd<|S|j#} |j dIjt| d|jddd.d | /} |j dJjt| d| jdd1k(redK|jd<|j |jdd| |jd<|j|jd<d |jd<|Scc}w)La If given device doesnot exist then add it to pnp database and get the device id Args: self: An instance of a class used for interacting with Cisco Catalyst Center. Returns: object: An instance of the class with updated results and status based on the processing of differences. Based on the length of devices passed it adds/claims or does both. Description: The function processes the differences and, depending on the changes required, it may add, update,or resynchronize devices in Cisco Catalyst Center. The updated results and status are stored in the class instance for further use. rz$Device Info must be passed as a listr0r1rMr?rrrcrgrdTrCziDevice details for serial number {0} obtained from the API 'get_device_list': {1}rLzDetails of the added device:{0}r2rrKzDevices are already addedr4rimport_devices_in_bulkpayloadzDResponse from API 'import_devices_in_bulk' for imported devices: {0} successListz#{0} device(s) imported successfullydiffchangedzBulk import failedrH Provisioned)rcrPlannedrz@Device needs to be added before claiming. Please add device_infor#zAdding device to pnp database add_devicez@Response from API 'add device' for a single device addition: {0}zOnly Device Added SuccessfullyzDevice Addition Failedz>Response from API 'add device' for single device addition: {0}rNrclaim_a_device_to_a_siterDrErGrFzGResponse from API 'claim a device to a site' for a single claiming: {0}zDevice Claimedz%Device Added and Claimed SuccessfullyzDevice Claim Failedget_device_countzAResponse from 'get device count' API for provisioned devices: {0}zFResponse from 'get_device_count' API for devices in planned state: {0}rrzResponse from 'claim_a_device_to_a_site' API for claiming: {0}z Only Device Claimed Successfully)rrPrQrr4r8r5rTrOr6rriresultr9rrcheck_return_statusrr)r devices_addeddevicemulti_device_response bulk_list bulk_paramsprovisioned_count_paramsplanned_count_paramsdev_add_responserclaim_responseprov_dev_responseplan_dev_responseris_stack pnp_stateupdate_payloadupdate_responsereset_paramtersreset_responses rget_diff_mergedzPnP.get_diff_merged^s "$))-- 5t<=DH HHTXXw '"DKK tyy}}\* +a /M))-- 5 \(?(?2.+VL-A.-QR $ )% FFLfVT`MabpMqsvxMtNGOQXY)s3H/IQ/N!((0HH>EEc&kRTZ[ \DIIMM,/03}3EE!K*, J'%@ E"U+Y7 #iimmL9.I 2$//&1.1!9- K HH[bbcnoqx y;??=12Q6%J%Q%Q  67&9 E"U+V4*5 J'&*&;&; F#)- I& +DH HHTXXz *"DKK"YY]]?;"$  "YY]]?;  yy}}^,99\*]7+&  99[)8&A#:4??6#:2)99==6q9 $ $ +;*>*>|*L ,'[bbcfgwcxy|CD99\*)IDKK&HHT[[/8.>DKK +*.*?*?DKK'-1DKK * 8DHHHT[[/<"*DK 89#:4??6#:2)99==6q9 $ $  335*:*>*>|*L ,'Y``adeuavwzAB#446 +;+?+?+E Z(!8!827 $' "biijmn~jACJK!%%j15EE$))T`Ja)PDKK&HHT[[/8.+// =AA'JH(,,\:>>wG  /66yA6Jyy%&*iimmN&CDKK #!:DKK  HHT[[' 3K& l(CA(F(J(J<(XY08|$W- [bbcqrt{|1$//&1*$))K0-/   T[[\_`o\pqsz{  "335O4T__V4.'!?3 N HHZaabeftbuvx A!ADKK  HHT[[' 0&4DKK #"&"7"7DKK %)DKK "K  ! !* - 2  ! !* - 2  $&*iimmN&CDKK #! 24??622; $ ),  228& 9Mn9]_bck_l2movx<< b155g>)K#**6,+?+OPIIMM,/66v>.6DKK +)JDKK&HHT[[/<3 =6  ! #%)DKK "&5DKK #"&))-- "=DKK !E!L!LSQ`Ma!bDKK  HHT[[' 0  "7DKK  HHT[[' 3&5DKK # rc|jdjt|jd|jdjt|d|jj dD]}|j dddd|d d id }|r8t|d k(r*dj|d d }|j|d^dj|d d }|j|dd|_|S)a Verify the merged status(Creation/Updation) of PnP configuration in Cisco Catalyst Center. Args: - self (object): An instance of a class used for interacting with Cisco Catalyst Center. - config (dict): The configuration details to be verified. Return: - self (object): An instance of a class used for interacting with Cisco Catalyst Center. Description: This method checks the merged status of a configuration in Cisco Catalyst Center by retrieving the current state (have) and desired state (want) of the configuration, logs the states, and validates whether the specified device(s) exists in the DNA Center configuration's PnP Database. Current State (have): {0}r2Desired State (want): {0}rr?rrrcrgrdTrCrMz_Requested Device with Serial No. {0} is present in Cisco Catalyst Center and addition verified.zRRequested Device with Serial No. {0} is not present in Cisco Catalyst CenterCenterrr r8r6rrrPrQrOrTr5rr3rrr4s rverify_diff_mergedzPnP.verify_diff_mergeds  ,33C NCVL ,33CK@&IiimmL1 )F5doof5.*' )=n)MN O  S%9Q%>**0& 1En1U*Vf%#VF<$8$HIi(' )*   rc|jdjt|jd|jdjt|d|jj dD]}|j dddd|d d id }|rt|d k(s*dj|d d }|j|d^dj|d d }|j|dd|_|S)a Verify the deletion status of PnP configuration in Cisco Catalyst Center. Args: - self (object): An instance of a class used for interacting with Cisco Catalyst Center. - config (dict): The configuration details to be verified. Return: - self (object): An instance of a class used for interacting with Cisco Catalyst Center. Description: This method checks the deletion status of a configuration in Cisco Catalyst Center. It validates whether the specified device(s) exists in the Cisco Catalyst Center configuration's PnP Database. rr2rrr?rrrcrgrdTrCrMzKRequested Device with Serial No. {0} is not present in the Cisco DNACenter.zHRequested Device with Serial No. {0} is present in Cisco Catalyst Centerrrrrs rverify_diff_deletedzPnP.verify_diff_deleteds  ,33C NCVL ,33CK@&IiimmL1 )F5doof5.*' )=n)MN O $_)=)B$fVL%9.%IJf%77=vf\>RSa>b7ci(% )(   rr )__name__ __module__ __qualname__rr=rXrarnrrrurrrrrrrr __classcell__)rs@rr r @s\!@D)&V&P >4'Rh%NPd4lqf8t(T&rr ciddddddddddd d gd d ddd ddddddddddddddddddddddddddddddddddddddddd dd!dd"dd#d$d%d&d'd'd(gd)}t|d*}t|}|jjd&}||jvr-d+|_d,j ||_|j|jj|jjd}|jD]}|j|j|j|jj|j|j|su|j||j|j d.i|j"y-)/z/ main entry point for module execution dnac_hostTr)rr dnac_port443)rr dnac_usernameadminuser)rraliases dnac_password)rno_log dnac_verifyrTrue dnac_versionz2.2.3.3 dnac_debugFdnac_logdnac_log_levelrdnac_log_file_pathzdnac.logdnac_log_appendvalidate_response_schema config_verifydnac_api_task_timeoutintidnac_task_poll_intervalr3rr)rrrrrdeleted)rchoices) argument_specsupports_check_modeinvalidzState {0} is invalidN)rr rFrQsupported_statesr5r6r4rr=r9 reset_valuesrrget_diff_state_applyverify_diff_state_apply exit_jsonr) element_specrccc_pnprrr3s rmainrs_ KdE!B%E!B#eU[T\%]$et%D"Fv#F  #Uy$I  !6e"D E B%u&K)5Z*P&4'H/D0Q$f%G,e-M.!/L4VT x>ST!L&/46F&kG NN  w 'E G,,,",33E: ##% 002NN&&7M**Q 446..0+$$U+-AAC  2G + +E 26 : N N P QF&w~~&r__main__N) __future__rrrr __metaclass__ __author__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicr8ansible_collections.cisco.dnac.plugins.module_utils.dnacrrr r rrrrrr"sj A@ J a Di T# H5[([|-'` zFr