VhWddlmZmZmZeZdZdZdZdZ ddl Z ddl Z ddl m Z ddlmZmZGd d eZd Zed k(reyy) )absolute_importdivisionprint_functionzAbinash Mishraa --- module: provision_intent short_description: Resource module for provision functions description: - Manage operation related to wired and wireless provisioning - API to re-provision provisioned devices - API to un-provision provisioned devices version_added: '6.6.0' extends_documentation_fragment: - cisco.dnac.intent_params author: Abinash Mishra (@abimishr) 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 DNAC 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: management_ip_address: description: Management Ip Address . type: str required: true site_name: description: Name of site where the device needs to be added. type: str managed_ap_locations: description: Location of the sites allocated for the APs type: list elements: str dynamic_interfaces: description: Interface details of the controller type: list elements: dict suboptions: interface_ip_address: description: Ip Address allocated to the interface type: str interface_netmask_in_c_i_d_r: description: Ip Address allocated to the interface type: int interface_gateway: description: Ip Address allocated to the interface type: str lag_or_port_number: description: Ip Address allocated to the interface type: int vlan_id: description: Ip Address allocated to the interface type: int interface_name: description: Ip Address allocated to the interface type: str requirements: - dnacentersdk == 2.4.5 - python >= 3.9 notes: - SDK Methods used are sites.Sites.get_site, devices.Devices.get_network_device_by_ip, task.Task.get_task_by_id, sda.Sda.get_provisioned_wired_device, sda.Sda.re_provision_wired_device, sda.Sda.provision_wired_device, wireless.Wireless.provision - Paths used are get /dna/intent/api/v1/site get /dna/intent/api/v1/network-device/ip-address/{ipAddress} get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/business/sda/provision-device put /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/business/sda/provision-device post /dna/intent/api/v1/wireless/provision a - name: Create/Modify a new provision cisco.dnac.provision_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: true state: merged config: - site_name: string management_ip_address: string managed_ap_locations: list dynamic_interfaces: - vlan_id: integer interface_name: string interface_ip_address: string interface_gateway: string interface_netmask_in_c_i_d_r: integer lag_or_port_number: integer a # Case_1: Successful creation/updation/deletion of provision response_1: description: A dictionary with details of provision is returned returned: always type: dict sample: > { "response": { "response": String, "version": String }, "msg": String } # Case_2: Error while creating a provision response_2: description: A list with the response returned by the Cisco DNAC Python SDK returned: always type: list sample: > { "response": [], "msg": String } # Case_3: Already exists and requires no update response_3: description: A dictionary with the exisiting details as returned by the Cisco DNAC Python SDK returned: always type: dict sample: > { "response": String, "msg": String } N) AnsibleModule)DnacBasevalidate_list_of_dictsc\eZdZdZfdZdZdZd dZd dZdZ dZ d Z d Z d Z xZS) DnacprovisionzH Class containing member attributes for provision intent module c$t||yN)super__init__)selfmodule __class__s o/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/dnac/plugins/modules/provision_intent.pyrzDnacprovision.__init__s  cX|jsd|_d|_|Sddddddddddddd dd }t|j|\}}|r.d j d j ||_d |_|S||_|jt|d|_d|_|S)aH 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. Args: 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. z0config not available in playbook for validattionsuccessstrT)typerequiredlistF)rrelementsdict)management_ip_address site_namemanaged_ap_locationsdynamic_interfacesz#Invalid parameters in playbook: {0} failedzSuccessfully validated input) configmsgstatusrformatjoinvalidated_configlogr)rprovision_specvalid_provisioninvalid_paramss rvalidate_inputzDnacprovision.validate_inputs*{{IDH#DKK/4%F"'T:-316%8+1u/5#7  +A KK+ ' <CC .)+DH"DKK / _%&1  rc|jdddd|jddid}|jd }|d }|d k(rd }|S|d vrd}|Sd}|S)a Fetches the type of device (wired/wireless) 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: - device_type: A string indicating the type of the device (wired/wireless). Example: Post creation of the validated input, we this method gets the type of the device. execdevicesget_network_device_by_ip ip_addressrrTfamilyfunctionparams op_modifiesresponser3zWireless Controllerwireless)zSwitches and HubsRouterswiredN) dnac_applyr'get)r dev_responsedev_dict device_family device_types r get_dev_typezDnacprovision.get_dev_types /tv./ $"7"7":;R"ST   ##J/ * 1 1$K  > >!KKrc d}d|i} |jddd|d}|j}|jds5tjd |jd tj r>d j ||jd }|jj|y|jd dk7rd}ntjd|jjt||S)a Fetches the status of the task once any provision API is called 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: - result: A dict indiacting wheter the task was succesful or not Example: Post creation of the provision task, this method fetheches the task status. Ftask_idTr.taskget_task_by_idr2isErrorr!progress)flagsz:Discovery task with id {0} has not completed - Reason: {1} failureReason)r#z In Progress)discovery_task)r;r7r<research IGNORECASEr%r fail_jsontimesleepresultupdater)rrCrRr5r7r#s rget_task_statuszDnacprovision.get_task_statussW%.tv.) H  ((H||I&"))(,,z2"--+SYYX\\/:< %%#%.||J'=8 JJqM)* 4x89 rcx |jdddd|id}ro|j t ||j d }|d j d }|D]+}|d d k(s |j dj d}-S#t$r |jjdgYwxYw)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.sitesget_sitenameTr2zSite not foundr#r7r7radditionalInfo nameSpaceLocation attributesr)r; ExceptionrrOr(rr<)rrr7sitesite_additional_infoitem site_types r get_site_typezDnacprovision.get_site_types  E.tv.# * H  HHS] #<< +D#'7;;/?#@ , C $ 2 $ 6 : :6 BI C E KK ! !&6 ! D EsB&B98B9ch|jdd|jdjdd}|S)a Prepares the payload for provisioning of the wired devices 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: - wired_params: A dictionary containing all the values indicating management IP address of the device and the hierarchy of the site. 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. rrr)deviceManagementIpAddresssiteNameHierarchy)r'r<)r wired_paramss rget_wired_paramszDnacprovision.get_wired_paramsBs@&*.)>)>q)ABY)Z!%!6!6q!9!=!=k!J rc |jdjd|jdjddg}|ddD]5}|j|dk7s|jj dg 7g|dd <|jdjd D]|}|jd |jd |jd|jd|jd|jdd}|dd j |~|j dddd|jddid}|jddjd|dd<|S)a  Prepares the payload for provisioning of the wireless devices 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: - wireless_params: A list of dictionary containing all the values indicating management IP address of the device, hierarchy of the site, AP Location of the wireless controller and details of the interface 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. rrr)r_managedAPLocationsrj)rfloorz#Managed AP Location must be a floorrYdynamicInterfacesrinterface_ip_addressinterface_netmask_in_c_i_d_rinterface_gatewaylag_or_port_numbervlan_idinterface_name)interfaceIPAddressinterfaceNetmaskInCIDRinterfaceGatewaylagOrPortNumbervlanId interfaceNamer.r/r0rTr2r7hostname deviceName)r'r<rcrrOappendr;)rwireless_paramsap_loc interfaceinterface_dictr7s rget_wireless_paramsz!Dnacprovision.get_wireless_params[s*--a044[A&*&;&;A&>&B&BCY&Z   &a()=> ^F!!F!3w> %%*OZ\%] ^35./..q1556JK KI&/mm4J&K*3--8V*W$-MM2E$F#,==1E#F#-- 2!*/?!@ N A 2 3 : :> J K+4??6*/+T-B-B1-EF]-^_  ,4<< +CA+F+J+J:+V<(rcLi|_|j|jd<|jddk(r|j|jd<nA|jddk(r|j|jd<n|j dd|_d|_|S)a Get all provision related informantion from the playbook Args: 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: prov_paramsr8z4Passed devices are neither wired or wireless deviceszBSuccessfully collected all parameters from playbook for comparisonr)wantrArhrr(r#r$)rs rget_wantzDnacprovision.get_wants" #'#4#4#6 - 99] #w .'+'<'<'>DIIm $ YY} % 3'+'?'?'ADIIm $ HHK L  rc|jjd}|dk(r |jddddd|jdd i }|jd }|d k(r'|jddd d|jd }n|jdddd|jd }nY|dk(r'|jdddd|jd }n-d|j d<|jd|j d<|S|jd}|j |}d|j d<d|j d<|j|j d<||j d<|S#t$ri}Y6wxYw)aF Add to provision database Args: self: An instance of a class used for interacting with Cisco DNA Center. Returns: object: An instance of the class with updated results and status based on the processing of differences. Description: The function processes the differences and, depending on the changes required, it may add, update,or resynchronize devices in Cisco DNA Center. The updated results and status are stored in the class instance for further use. r@r:r.sdaget_provisioned_wired_deviceTz4device_management_ ip_addressrrr3r4r6r5r$rre_provision_wired_devicerprovision_wired_devicer8 provisionz+Passed device is neither wired nor wirelessr#r7taskIdrCchangedzProvision done Successfullydiff)rr<r;r'r^rRrT)rr@status_responser$r7rCprovision_infos rget_diff_mergedzDnacprovision.get_diff_mergedsiimmM2 ' ! %"9$//&"9 ; $$--a01HI #%((2F"24??62 8 $99]3 34??62 5 $99]3 J &.tv.!$ yy/ H"ODKK &*ii &>DKK #K,,x(--g->!% I: E"33 F") J Q %"$ %s+E55 FFc|jjd}|dk7rd|jd<|S |jddddd |jd d i }|jd }|dk7r-d|jd<|jd|jd<|S|jddddd|jd d i }|jd}|j |}d|jd<d|jd<|j|jd<||jd<|S#t $ri}YwxYw)a Delete from provision database Args: self: An instance of a class used for interacting with Cisco DNA Center Returns: self: An instance of the class with updated results and status based on the deletion operation. Description: This function is responsible for removing devices from the Cisco DNA Center PnP GUI and raise Exception if any error occured. r@r:z%APIs are not supported for the devicer#r.rrTz0device_management_ ip_addressrrrr$rz$Passed IP address is not provisionedrr7delete_provisioned_wired_devicez,device_management_ ip_addressrrrzDeletion done Successfullyr)rr<rRr;r'r^rT)rr@rr$r7rC deletion_infos rget_diff_deletedzDnacprovision.get_diff_deletedsniimmM2 ' !!HDKK K !5doof57  ))!,-DE O!$$X. Y !GDKK &*ii &>DKK #K*4??6*6%%a()@A  ,,x(,,W,= !% I9 E"33 F") J 9 ! O !s+D77 EEr )__name__ __module__ __qualname____doc__rr,rArTrcrhrrrr __classcell__)rs@rr r sA!0d D'R"H20d>DL;rr ciddddddddddd d gd d ddd ddddddddddddddddddddddddddddddddddddddd dd!dddd"dd#d$d%d&d'd'd(gd)}t|d*}t|}|jjd&}||jvr-d+|_d,j ||_|j|jj|jD]R}|j|jj|j|jT|jd.i|jy-)/z/ main entry point for module execution dnac_hostTr)rr dnac_port443)rdefault dnac_usernameadminuser)rraliases dnac_password)rno_log dnac_verifyboolTrue dnac_versionz2.2.3.3 dnac_debugFdnac_logdnac_log_levelWARNINGdnac_log_file_pathzdnac.logdnac_log_append config_verifydnac_api_task_timeoutintidnac_task_poll_intervalvalidate_response_schemar"rr)rrrstatemergeddeleted)rchoices) argument_specsupports_check_modeinvalidzState {0} is invalidN)rr r5r<supported_statesr$r%r#check_return_statusr,r' reset_valuesrget_diff_state_apply exit_jsonrR) element_specrdnac_provisionrr"s rmainr0s KdE!B%E!B#eU[T\%]$et%D"Fv#F  #Uy$I  !6e"D E B%u&K)5Z*P&4'H$f%G,e-M.!/L/D0Q4VT x>ST!L$/46F"6*N  ! ! % %g .E N333 )3::5A**,!!#779 11K##%!5572++E24HHJK F-~,,-r__main__) __future__rrrr __metaclass__ __author__ DOCUMENTATIONEXAMPLESRETURNrPrLansible.module_utils.basicr8ansible_collections.cisco.dnac.plugins.module_utils.dnacrrr rrrrrrsi A@  K X 0# H 4 THTn ).X zFr