VhKRddlmZmZmZeZdZdZdZdZ ddl m Z ddl m Z mZddlZddlZGd d e Zd Zed k(reyy) )absolute_importdivisionprint_functionz4Abinash Mishra, Phan Nguyen, Madhan Sankaranarayanana,F --- module: discovery_intent short_description: A resource module for handling device discovery tasks. description: - Manages device discovery using IP address, address range, CDP, and LLDP, including deletion of discovered devices. - API to discover a device or multiple devices - API to delete a discovery of a device or multiple devices version_added: '6.6.0' extends_documentation_fragment: - cisco.dnac.intent_params author: Abinash Mishra (@abimishr) Phan Nguyen (@phannguy) Madhan Sankaranarayanan (@madhansansel) 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: discovery_name: description: Name of the discovery task type: str required: true discovery_type: description: Determines the method of device discovery. Here are the available options. - SINGLE discovers a single device using a single IP address. - RANGE discovers multiple devices within a single IP address range. - MULTI RANGE discovers devices across multiple IP address ranges. - CDP uses Cisco Discovery Protocol to discover devices in subsequent layers of the given IP address. - LLDP uses Link Layer Discovery Protocol to discover devices in subsequent layers of the specified IP address. - CIDR discovers devices based on subnet filtering using Classless Inter-Domain Routing. type: str required: true choices: ['SINGLE', 'RANGE', 'MULTI RANGE', 'CDP', 'LLDP', 'CIDR'] ip_address_list: description: List of IP addresses to be discovered. For CDP/LLDP/SINGLE based discovery, we should pass a list with single element like - 10.197.156.22. For CIDR based discovery, we should pass a list with single element like - 10.197.156.22/22. For RANGE based discovery, we should pass a list with single element and range like - 10.197.156.1-10.197.156.100. For MULTI RANGE based discovery, we should pass a list with multiple elements like - 10.197.156.1-10.197.156.100 and in next line - 10.197.157.1-10.197.157.100. Maximum of 8 IP address ranges are allowed. type: list elements: str required: true ip_filter_list: description: List of IP adddrsess that needs to get filtered out from the IP addresses passed. type: list elements: str cdp_level: description: Total number of levels that are there in cdp's method of discovery type: int default: 16 lldp_level: description: Total number of levels that are there in lldp's method of discovery type: int default: 16 preferred_mgmt_ip_method: description: Preferred method for the management of the IP (None/UseLoopBack) type: str default: None use_global_credentials: description: - Determines if device discovery should utilize pre-configured global credentials. - Setting to True employs the predefined global credentials for discovery tasks. This is the default setting. - Setting to False requires manually provided, device-specific credentials for discovery, as global credentials will be bypassed. type: bool default: true discovery_specific_credentials: description: Credentials specifically created by the user for performing device discovery. type: dict suboptions: cli_credentials_list: description: List of CLI credentials to be used during device discovery. type: list elements: dict suboptions: username: description: Username for CLI authentication, mandatory when using CLI credentials. type: str password: description: Password for CLI authentication, mandatory when using CLI credential. type: str enable_password: description: Enable password for CLI authentication, mandatory when using CLI credential. type: str http_read_credential: description: HTTP read credential is used for authentication purposes and specifically utilized to grant read-only access to certain resources from the device. type: dict suboptions: username: description: Username for HTTP(S) Read authentication, mandatory when using HTTP credentials. type: str password: description: Password for HTTP(S) Read authentication, mandatory when using HTTP credentials. type: str port: description: Port for HTTP(S) Read authentication, mandatory for using HTTP credentials. type: int secure: description: Flag for HTTP(S) Read authentication, not mandatory when using HTTP credentials. type: bool http_write_credential: description: HTTP write credential is used for authentication purposes and grants Cisco Catalyst Center the ability to alter configurations, update software, or perform other modifications on a network device. type: dict suboptions: username: description: Username for HTTP(S) Write authentication, mandatory when using HTTP credentials. type: str password: description: Password for HTTP(S) Write authentication, mandatory when using HTTP credentials. type: str port: description: Port for HTTP(S) Write authentication, mandatory when using HTTP credentials. type: int secure: description: Flag for HTTP(S) Write authentication, not mandatory when using HTTP credentials. type: bool snmp_v2_read_credential: description: - The SNMP v2 credentials to be created and used for contacting a device via SNMP protocol in read mode. - SNMP v2 also delivers data encryptions, but it uses data types. type: dict suboptions: description: description: Name/Description of the SNMP read credential to be used for creation of snmp_v2_read_credential. type: str community: description: SNMP V2 Read community string enables Cisco Catalyst Center to extract read-only data from device. type: str snmp_v2_write_credential: description: - The SNMP v2 credentials to be created and used for contacting a device via SNMP protocol in read and write mode. - SNMP v2 also delivers data encryptions, but it uses data types. type: dict suboptions: description: description: Name/Description of the SNMP write credential to be used for creation of snmp_v2_write_credential. type: str community: description: SNMP V2 Write community string is used to extract data and alter device configurations. type: str snmp_v3_credential: description: - The SNMP v3 credentials to be created and used for contacting a device via SNMP protocol in read and write mode. - SNMPv3 is the most secure version of SNMP, allowing users to fully encrypt transmissions, keeping us safe from external attackers. type: dict suboptions: username: description: Username of the SNMP v3 protocol to be used. type: str snmp_mode: description: - Mode of SNMP which determines the encryption level of our community string. - AUTHPRIV mode uses both Authentication and Encryption. - AUTHNOPRIV mode uses Authentication but no Encryption. - NOAUTHNOPRIV mode does not use either Authentication or Encryption. type: str choices: ['AUTHPRIV', 'AUTHNOPRIV', 'NOAUTHNOPRIV'] auth_password: description: - Authentication Password of the SNMP v3 protocol to be used. - Must be of length greater than 7 characters. - Not required for NOAUTHNOPRIV snmp_mode. type: str auth_type: description: - Authentication type of the SNMP v3 protocol to be used. - SHA uses Secure Hash Algorithm (SHA) as your authentication protocol. - MD5 uses Message Digest 5 (MD5) as your authentication protocol and is not recommended. - Not required for NOAUTHNOPRIV snmp_mode. type: str choices: ['SHA', 'MD5'] privacy_type: description: - Privacy type/protocol of the SNMP v3 protocol to be used in AUTHPRIV SNMP mode - Not required for AUTHNOPRIV and NOAUTHNOPRIV snmp_mode. type: str choices: ['AES128', 'AES192', 'AES256'] privacy_password: description: - Privacy password of the SNMP v3 protocol to be used in AUTHPRIV SNMP mode - Not required for AUTHNOPRIV and NOAUTHNOPRIV snmp_mode. type: str net_conf_port: description: - To be used when network contains IOS XE-based wireless controllers. - This is used for discovery and the enabling of wireless services on the controllers. - Requires valid SSH credentials to work. - Avoid standard ports like 22, 80, and 8080. type: str global_credentials: description: - Set of various credential types, including CLI, SNMP, HTTP, and NETCONF, that a user has pre-configured in the Device Credentials section of the Cisco Catalyst Center. - If user doesn't pass any global credentials in the playbook, then by default, we will use all the global credentials present in the Cisco Catalyst Center of each type for performing discovery. (Max 5 allowed) type: dict version_added: 6.12.0 suboptions: cli_credentials_list: description: - Accepts a list of global CLI credentials for use in device discovery. - It's recommended to create device credentials with both a unique username and a clear description. type: list elements: dict suboptions: username: description: Username required for CLI authentication and is mandatory when using global CLI credentials. type: str description: description: Name of the CLI credential, mandatory when using global CLI credentials. type: str http_read_credential_list: description: - List of global HTTP Read credentials that will be used in the process of discovering devices. - It's recommended to create device credentials with both a unique username and a clear description for easy identification. type: list elements: dict suboptions: username: description: Username for HTTP Read authentication, mandatory when using global HTTP credentials. type: str description: description: Name of the HTTP Read credential, mandatory when using global HTTP credentials. type: str http_write_credential_list: description: - List of global HTTP Write credentials that will be used in the process of discovering devices. - It's recommended to create device credentials with both a unique username and a clear description for easy identification. type: list elements: dict suboptions: username: description: Username for HTTP Write authentication, mandatory when using global HTTP credentials. type: str description: description: Name of the HTTP Write credential, mandatory when using global HTTP credentials. type: str snmp_v2_read_credential_list: description: - List of Global SNMP V2 Read credentials to be used during device discovery. - It's recommended to create device credentials with a clear description for easy identification. type: list elements: dict suboptions: description: description: Name of the SNMP Read credential, mandatory when using global SNMP credentials. type: str snmp_v2_write_credential_list: description: - List of Global SNMP V2 Write credentials to be used during device discovery. - It's recommended to create device credentials with a clear description for easy identification. type: list elements: dict suboptions: description: description: Name of the SNMP Write credential, mandatory when using global SNMP credentials. type: str snmp_v3_credential_list: description: - List of Global SNMP V3 credentials to be used during device discovery, giving read and write mode. - It's recommended to create device credentials with both a unique username and a clear description for easy identification. type: list elements: dict suboptions: username: description: Username for SNMP V3 authentication, mandatory when using global SNMP credentials. type: str description: description: Name of the SNMP V3 credential, mandatory when using global SNMP credentials. type: str net_conf_port_list: description: - List of Global Net conf ports to be used during device discovery. - It's recommended to create device credentials with unique description. type: list elements: dict suboptions: description: description: Name of the Net Conf Port credential, mandatory when using global Net conf port. type: str start_index: description: Start index for the header in fetching SNMP v2 credentials type: int default: 1 records_to_return: description: Number of records to return for the header in fetching global v2 credentials type: int default: 100 protocol_order: description: Determines the order in which device connections will be attempted. Here are the options - "telnet" Only telnet connections will be tried. - "ssh, telnet" SSH (Secure Shell) will be attempted first, followed by telnet if SSH fails. type: str default: ssh retry: description: Number of times to try establishing connection to device type: int timeout: description: Time to wait for device response in seconds type: int delete_all: description: Parameter to delete all the discoveries at one go type: bool default: false requirements: - dnacentersdk == 2.6.10 - python >= 3.9 notes: - SDK Method used are discovery.Discovery.get_all_global_credentials_v2, discovery.Discovery.start_discovery, task.Task.get_task_by_id, discovery.Discovery.get_discoveries_by_range, discovery.Discovery.get_discovered_network_devices_by_discovery_id', discovery.Discovery.delete_discovery_by_id discovery.Discovery.delete_all_discovery discovery.Discovery.get_count_of_all_discovery_jobs - Paths used are get /dna/intent/api/v2/global-credential post /dna/intent/api/v1/discovery get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/discovery/{startIndex}/{recordsToReturn} get /dna/intent/api/v1/discovery/{id}/network-device delete /dna/intent/api/v1/discovery/{id} delete /dna/intent/api/v1/delete get /dna/intent/api/v1/discovery/count - Removed 'global_cli_len' option in v6.12.0. a= - name: Execute discovery of devices with both global credentials and discovery specific credentials cisco.dnac.discovery_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 dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: true config: - discovery_name: Discovery with both global and job specific credentials discovery_type: RANGE ip_address_list: - 201.1.1.1-201.1.1.100 ip_filter_list: - 201.1.1.2 - 201.1.1.10 discovery_specific_credentials: cli_credentials_list: - username: cisco password: Cisco123 enable_password: Cisco123 http_read_credential: username: cisco password: Cisco123 port: 443 secure: true http_write_credential: username: cisco password: Cisco123 port: 443 secure: true snmp_v2_read_credential: description: snmp_v2-new community: Cisco123 snmp_v2_write_credential: description: snmp_v2-new community: Cisco123 snmp_v3_credential: username: v3Public2 snmp_mode: AUTHPRIV auth_type: SHA auth_password: Lablab123 privacy_type: AES256 privacy_password: Lablab123 net_conf_port: 750 global_credentials: cli_credentials_list: - description: ISE username: cisco - description: CLI1234 username: cli http_read_credential_list: - description: HTTP Read username: HTTP_Read http_write_credential_list: - description: HTTP Write username: HTTP_Write snmp_v3_credential_list: - description: snmpV3 username: snmpV3 snmp_v2_read_credential_list: - description: snmpV2_read snmp_v2_write_credential_list: - description: snmpV2_write net_conf_port_list: - description: Old_one start_index: 1 records_to_return: 100 protocol_order: ssh retry: 5 timeout: 3 - name: Execute discovery of devices with discovery specific credentials only cisco.dnac.discovery_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 dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: true config: - discovery_name: Single with discovery specific credentials only discovery_type: SINGLE ip_address_list: - 204.1.1.10 discovery_specific_credentials: cli_credentials_list: - username: cisco password: Cisco123 enable_password: Cisco123 http_read_credential: username: cisco password: Cisco123 port: 443 secure: true http_write_credential: username: cisco password: Cisco123 port: 443 secure: true snmp_v2_read_credential: description: snmp_v2-new community: Cisco123 snmp_v2_write_credential: description: snmp_v2-new community: Cisco123 snmp_v3_credential: username: v3Public2 snmp_mode: AUTHPRIV auth_type: SHA auth_password: Lablab123 privacy_type: AES256 privacy_password: Lablab123 net_conf_port: 750 use_global_credentials: false start_index: 1 records_to_return: 100 protocol_order: ssh retry: 5 timeout: 3 - name: Execute discovery of devices with global credentials only cisco.dnac.discovery_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 dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: true config: - discovery_name: CDP with global credentials only discovery_type: CDP ip_address_list: - 204.1.1.1 cdp_level: 16 global_credentials: cli_credentials_list: - description: ISE username: cisco - description: CLI1234 username: cli http_read_credential_list: - description: HTTP Read username: HTTP_Read http_write_credential_list: - description: HTTP Write username: HTTP_Write snmp_v3_credential_list: - description: snmpV3 username: snmpV3 snmp_v2_read_credential_list: - description: snmpV2_read snmp_v2_write_credential_list: - description: snmpV2_write net_conf_port_list: - description: Old_one start_index: 1 records_to_return: 100 protocol_order: ssh retry: 5 timeout: 3 - name: Execute discovery of devices with all the global credentials (max 5 allowed) cisco.dnac.discovery_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 dnac_log_level: "{{dnac_log_level}}" state: merged config_verify: true config: - discovery_name: CIDR with all global credentials discovery_type: CIDR ip_address_list: - 204.1.2.0/24 ip_filter_list: - 204.1.2.10 preferred_mgmt_ip_method: None start_index: 1 records_to_return: 100 protocol_order: telnet retry: 10 timeout: 3 use_global_credentials: true - name: Delete disovery by name cisco.dnac.discovery_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 dnac_log_level: "{{dnac_log_level}}" state: deleted config_verify: true config: - discovery_name: Single discovery aL #Case_1: When the device(s) are discovered 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 device details or SNMP mode are not provided 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 a discovery 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_dictsNceZdZfdZddZdZdZddZdZdZ ddZ d Z dd Z dd Z dd Zdd ZddZddZdZdZddZdZdZdZdZdZdZxZS) Discoveryc2t||g|_y)a Initialize an instance of the class. It also initializes an empty list for 'creds_ids_list' attribute. Parameters: - module: The module associated with the class instance. Returns: The method does not return a value. Instead, it initializes the following instance attributes: - self.creds_ids_list: An empty list that will be used to store credentials IDs. N)super__init__creds_ids_list)selfmodule __class__s o/home/dcms/DCMS/lib/python3.12/site-packages/ansible_collections/cisco/dnac/plugins/modules/discovery_intent.pyr zDiscovery.__init__s   c|jsd|_d|_|Sddddddddddddd dd d dd d ddddd dd d dd d dddddd d dd d dd d dddddddd}|dk(rd dd d |d<d dd |d<nT|dk(rO|jdjddur/ddig|_d|_|j |jd|St |j|\}}|rSdjdj||_|j t|jdd|_|S||_djt||_|j t|jd d|_|S)!a 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. 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 validationsuccessintF)typerequireddefaultddict)rrliststr)rrelementsTNonesshbool) cdp_level start_indexrecords_to_returndiscovery_specific_credentialsip_filter_list lldp_leveldiscovery_name netconf_portpreferred_mgmt_ip_methodretrytimeoutglobal_credentialsprotocol_orderuse_global_credentialsmergedip_address_listdiscovery_typedeletedr delete_allz?Sucessfully collected input for deletion of all the discoveriesWARNINGz#Invalid parameters in playbook: {0} ERRORfailedzTSuccessfully validated playbook configuration parameters using 'validate_input': {0}INFO) configmsgstatusgetvalidated_configlogrformatjoinr)rstatediscovery_specvalid_discoveryinvalid_paramss rvalidate_inputzDiscovery.validate_inputs*{{HDH#DKK#(U%')$)u'(**/U-0"27=5.Q'-5+02#(e&(*',$?%*>16E4:)<#7 %59+1u"E',%ER/55UY&Z) . H 9?T=B1DN, -8=4/PN+ , i {{1~!!,/47*6)=(>%\9- +A KK+ ' <CC .)+DH HHS]G ,"DKK /ippqtvErFG TXX'  rc |jdjd}|D];}d|vr|jdd}d|vrt|jddk(rd|jd\}}|j |dur?dj |}|j |d|jj| |j |dur?dj |}|j |d|jj| ttt|jd }ttt|jd }td D]M}||||kDsd j |}|j |d|jj| On?d j |}|j |d|jj| |j |dusd|vsdj |}|j |d|jj| >|j ddy)zs Validates each ip adress paased in the IP_address_list passed by the user before preprocessing it rr3/-FzIP address {0} is not validCRITICALr=.zAIncorrect range passed: {0}. Please pass correct IP address rangezaProvided range '{0}' is incorrect. IP address range should have only upper and lower limit valuesz'All the IP addresses passed are correctr;N) r@r?splitlen is_valid_ipv4rBrAr fail_jsonrmaprrange) rr3ipip1ip2r= ip1_parts ip2_partsparts rvalidate_ip4_address_listz#Discovery.validate_ip4_address_lists+ //2667HI! /BbyXXc]1%byrxx}%*!xx}HC))#.%7;BB3Gj1 --#-6))#.%7;BB3Gj1 --#-6 $Sciin%= >I $Sciin%= >I %a;$T?Yt_<"e"l"lmo"pC HHS*5 KK11c1: ; ~EEFHICHHS*-KK))c)2!!"%.3b=3::2>j) %%#%.9 /: :FCrc|jdjt|jd|jS)a$ Retrieve the list of credentials IDs associated with class instance. Returns: The method returns the list of credentials IDs: - self.creds_ids_list: The list of credentials IDs associated with the class instance. z!Credential Ids list passed is {0}r;)rArBrrrs rget_creds_ids_listzDiscovery.get_creds_ids_list s6 4;;C@S@SM444=||K(0a444=,-168&{389a< H!:FI }}]3 j8Q$,LL$=[D#xx 6$((=:QQVZV^V^_iVjnrnvnvxBoCWC 6{ C J J488TX> Z[?UU`>abkck>l.{;\<<<EF&8%;%;\D#xx 6$((=:QQVZV^V^_iVjnrnvnvxBoCWC 6| D K KDHHUYN [\@VVb?cdmem?n.|<]<<<EF(:'='=>\']$ ':DAO444=||M*2c444=/0148:&}5;<a< H!= FI }}]3$,LL$?]D#xx 6)-- :VV 6} E L LTXXVZ^ \]AWWd@efogo@p.}=D<<<E F);(>(>?^(_% (;TBP444=||N+3d444=01A59;&~6<=a< H!>FI }}]3$,LL$@^D#xx 6)-- :VV 6~ F M MdhhW[n ]^BXXfAghqiqAr.~>I<<<EF#5"8"89R"S "5t<P444=||H%-^444=*+a/35&x067a< H!8 FI }}]3 j8Q$,LL$:XD#xx 6)-- :VV[_[c[cdn[os|tAtABLtM\M 6x @ G GQU WX@&':;12a< H.FDxx .'/||4G'HfG#xx 6'++m:TT 67J K R RSZS^S^_cSd efG]]pFqr{s{F|./BCf<<<EF 9@@AWXZ`a%%rc|jddd|jdjdd}|jd}|jd j t |d i}|jdjd }|r|j | }t|j}t|j}|j|}|D]j}g||<||g||<t||}|dkDrd}|j|D]%} ||j| jd'||d |||<l|ik(rd} |j| d|S)aI Retrieve the global credentials information (version 2). It applies the 'get_all_global_credentials_v2' function and extracts the IDs of the credentials. If no credentials are found, the function fails with a message. Returns: This method does not return a value. However, updates the attributes: - self.creds_ids_list: The list of credentials IDs is extended with the IDs extracted from the response. - self.result: A dictionary that is updated with the credentials IDs. exec discoveryget_all_global_credentials_v2rheadersTfamilyfunctionparams op_modifiesrwzOThe Global credentials response from 'get all global credentials v2' API is {0}DEBUGr/)rwNrdrgz5Not found any global credentials to perform discoveryr7) dnac_applyr@r?rArBrrsetkeys differencerRrv) rrwrxr/global_cred_setresponse_cred_set diff_keyskey total_lenelementr=s r"get_ccc_global_credentials_v2_infoz,Discovery.get_ccc_global_credentials_v2_infos+4??6*4((+// :   << + biijmnvjwx{B C!#!221599:NO %)%C%CX%C%V "499;< 0%00A  RC*, "3 '}$ " HSM*I1} #<<, F&s+227;;t3DE F*@*Ejy*Q "3 ' R "R 'IC HHS) $%%rc|jdjd}|jjt ||j dj t|d|S)a Retrieve the list of devices from the validated configuration. It then updates the result attribute with this list. Returns: - ip_address_list: The list of devices extracted from the 'validated_config' attribute. rr3) devices_infoz&Details of the device list passed: {0}r;)r@r?resultupdaterrArBr)rr3s rget_devices_list_infozDiscovery.get_devices_list_infos]//2667HI 4_=> 9@@_AUVX^_rc|g}|jdjd}|jdj|d|dvr't |dk(r|d}n|j n|dk(rt |dk(r|d}t |jddtd d vr0d }|j|d |jj| t |jddk(r|}nUdj|}|jddn0|j n|dk(rgt |dk(rHt t|djddk(r|d}ndj|d|d}n|j nt |dkDr0d}|j|d |jj| g}|D]\}t t|jddk7r#dj|}|j|L|j|^dj|}|jdjt|dt|S)a Preprocess the devices' information. Extract the IP addresses from the list of devices and perform additional processing based on the 'discovery_type' in the validated configuration. Parameters: - ip_address_list: The list of devices' IP addresses intended for preprocessing. If not provided, an empty list will be used. Returns: - ip_address_list: It returns IP address list for the API to process. The value passed for single, CDP, LLDP, CIDR, Range and Multi Range varies depending on the need. rr4z.Discovery type passed for the discovery is {0}r;)SINGLECDPLLDPrCIDRrJz)Prefix length should be between 20 and 30rMrNrLz{0}/30zCIDR notation is being used for discovery and it requires a prefix length to be specified, such as 1.1.1.1/24. As no prefix length was provided, it will default to 30.r7RANGErKz{0}-{1}z#Maximum of 8 IP ranges are allowed.z{0}-{0},z&Collected IP address/addresses are {0})r@r?rArBrR(preprocess_device_discovery_handle_errorrrQrVrrTrrvrC)rr3r4 cidr_notationr=new_ip_collectedrW ip_collecteds rpreprocess_device_discoveryz%Discovery.preprocess_device_discovery!sa  " O..q1556FG AHHXZ`a 6 6?#q("1!"4==? v %?#q( / 2 }**3/235R=HECHHS*-KK))c)2}**3/0A5&3O&.oom&DOHHRS\^==? w &?#q(s?1-.44S9:a?&5a&8O&/&6&6q7I?[\K]&^O==??#a';j) %%#%.! % 0s2w}}S)*a/#,#3#3B#7L$++L9$++B/  0 "hh'78O 9@@_AUVX^_?##rcb|jdd|jjdgy)z Method for failing discovery based on the length of list of IP Addresses passed for performing discovery. z)IP Address list's length is longer than 1r9)r=rwNrArrTr_s rrz2Discovery.preprocess_device_discovery_handle_erroras, <|S)?a Method to convert values for create_params API when discovery specific paramters are passed as input. Parameters: - new_object_params: The dictionary storing various parameters for calling the start discovery API Returns: - new_object_params: The dictionary storing various parameters for calling the start discovery API in an updated fashion rr'rbhttp_read_credentialhttp_write_credentialsnmp_v2_read_credentialsnmp_v2_write_credentialsnmp_v3_credential net_conf_portz8Device Specific ClI credentials must be passed as a listrNrfpasswordenable_passwordzZusername, password and enable_password must be passed toether for creating CLI credentials userNameList passwordListenablePasswordListzAThe password for the HTTP read credential must be of string type.zAThe username for the HTTP read credential must be of string type.rz>The port for the HTTP read Credential must be of integer type.securez8Secure for HTTP read Credential must be of type boolean.httpReadCredentialzBThe password for the HTTP write credential must be of string type.zBThe username for the HTTP write credential must be of string type.z?The port for the HTTP write Credential must be of integer type.z9Secure for HTTP write Credential must be of type boolean.httpWriteCredentialrezGName/description for the SNMP v2 read credential must be of string type communityz+The community string must be of string typesnmpROCommunityDescsnmpROCommunityv2 snmpVersionzHName/description for the SNMP v2 write credential must be of string typesnmpRWCommunityDescsnmpRWCommunityz3Username of SNMP v3 protocol must be of string type snmp_modezKMode of SNMP is madantory to use SNMPv3 protocol and must be of string typeAUTHPRIV AUTHNOPRIV auth_passwordz-Authorization password must be of string type auth_typez)Authorization type must be of string type privacy_typez#Privacy type must be of string typeprivacy_passwordz'Privacy password must be of string type snmpUserNamesnmpModesnmpAuthPassphrasesnmpAuthProtocolsnmpPrivProtocolsnmpPrivPassphrasev3 netconfPort) r@r?rtrrurRrvrrr#)rnew_object_paramsr'rbrrrrrrr= username_list password_listenable_password_listrzs r%handle_discovery_specific_credentialsz/Discovery.handle_discovery_specific_credentialsssM*.)>)>q)A)E)EFf)g&=AABXY=AABXY > B BCZ ["@"D"DE^"_#A#E#EF`#a ;??@TU6::?K 2D9P444='(1, " " ')$ 4FH||J/HLL4LQYQ]Q]^oQp%,,X\\*-EF%,,X\\*-EF,33HLLAR4STz<<<EF5B!.14A!.1:N!"67 (,,Z8ZH\H`H`akHlnq=rY444=(,,Z8ZH\H`H`akHlnq=rY444=(,,V4DXD\D\]cDdfi9jV444=266x@$GP444=6J 2 3 )--j9jI^IbIbcmInps>tZ444=)--j9jI^IbIbcmInps>tZ444=)--f5*EZE^E^_eEfhk:lW444=377A4HQ444=7L 3 4 "+// >JOfOjOjkxOy{~D_444=+// <*MdMhMhitMuwzB{C444=7N7R7RS`7a 3 43J3N3N{3[ / 0/3 m , #,00?ZPhPlPlmzP{~AFB`444=,00=:NfNjNjkvNwy|C}C444=7O7S7STa7b 3 43K3O3OP[3\ / 0/3 m , &**:6JGYG]G]^hGikn,B,B;,O j )6H6L6L_6] 2 34F4J4J;4W 0 14F4J4J>4Z 0 16H6L6LM_6` 2 3/3 m , /2=/A m ,  rcg}i}|jdjd|d<|jdjd|d<||d<|jdjd|d<|jdjd |d <|jdjd |d <|jdjd |d<|jdjd|d<|jdjd|d<|jdjd|d<|jdjdr|j||jdjd}i}|dur;|j}|j D]}|j |||d<|j djt|d|jdsi|jdsX|jdsG|jds6|jds%|jdsd }|j|!|jd"s%|jd#sd$}|j|!|j d%jt|d&|S)'aF Create a new parameter object based on the validated configuration, credential IDs, and IP address list. Parameters: - credential_ids: The list of credential IDs to include in the parameters. If not provided, an empty list is used. - ip_address_list: The list of IP addresses to include in the parameters. If not provided, None is used. Returns: - new_object_params: A dictionary containing the newly created parameters. rr$cdpLevelr4 discoveryType ipAddressListr( ipFilterListr) lldpLevelr*namer,preferredMgmtIPMethodr0 protocolOrderr-r.r')rr1TglobalCredentialIdListz>All the global credentials used for the discovery task are {0}rrrrrmrorqzEPlease provide atleast one valid SNMP credential to perform DiscoveryrNrrczDPlease provide atleast one valid CLI credential to perform DiscoveryzEThe payload/object created for calling the start discovery API is {0}r;) r@r?rrvaluesextendrArBrru)rr3credential_idsrglobal_cred_flagrxglobal_cred_listr=s r create_paramszDiscovery.create_paramss (,(=(=a(@(D(D[(Q*%-1-B-B1-E-I-IJZ-[/*-</*,0,A,A!,D,H,HIY,Z.))-)>)>q)A)E)El)S+&$($9$9!$<$@$@AQ$R&!595J5J15M5Q5QRl5m12-1-B-B1-E-I-IJZ-[/*%)%:%:1%=%A%A'%J'"'+'<'G%$G%c d}t|} |jddd|d}|j}|jdj t |t |t |j d d |j d s5tjd |j d tj rPdj ||j d}|j|d|jj|y|jdj t |t |d |j d }tjd|j d r;d}|jdd |jjt||S|jdj |tjd)a Monitor the status of a task of deletion of dicovery in the Cisco Catalyst Center. It checks the itask status periodically until the task is 'Discovery deleted successfully'. If the task encounters an error or fails, it immediately fails the module and returns False. Parameters: - task_id: The ID of the task to monitor. Returns: - result: True if the task completed successfully, False otherwise. FrTrrrrrrr;r:rrrrrMrNrzDiscovery deleted successfully.rrrr)rrrwrArBrr?rrrrrTrrrr)rrrrrwr=rs rget_deleted_task_statusz!Discovery.get_deleted_task_statusysg&.tv.) H  ((H HHLSSTWX_T`befnboqtu}vBvBCLvMrNOQW X||I&"))(,,z2"--+SYYX\\/:<j) %%#%. HHV]]^abi^jlopxlyz}C D||J/Hyy:HLLz>Discovery.lookup_discovery_by_range_via_name..s'!F)t'<'">?R"S--a044Y?F /tv."3 H GNNsS[}]_fg U Z(    rcd}d}|j}|sndjt|jdj dt|}|j |d|j j| |j}|j d}|d k(rd}n|d k(rd}ntjd G|s|dured jt|jdj d}|j |d |j j|nndjt|jdj dt|}|j |d |j j||jjt||S)a Continuously retrieve a specific discovery by name from a range of discoveries in the Cisco Catalyst Center until the discovery is complete. Returns: - discovery: The completed discovery with the specified name from the range of discoveries. If the discovery is not found or not completed, the function fails the module and returns None. FzECannot find any discovery task with name {0} -- Discovery result: {1}rr*r;rNTdiscoveryConditionCompleteAbortedrz9Discovery with name {0} is aborted by the user on the GUIrM)discovery_range) rrBrr@r?rArrTrrrrr)rrabortedrr=discovery_conditions r&get_discoveries_by_range_until_successz0Discovery.get_discoveries_by_range_until_successs;;= Y``D))!,001ABCS^UC HHS& ! KK ! !c ! *??AI"+--0D"E "j0$ 1 JJqM$QXXY\]a]r]rst]u]y]y{K^LZMNj) %%#%.]dd--a0445EFGYYj) %%#%. 4 :;rc<t|||jdjd}d}d} |jddd|d }|j}|j d j t|d td |Drd}|j d dnotd|Drd}|j ddnHtd|Drd}|j ddn!|dz }|dk(rntjd|s?dj |}|j |d|jj||j dj |d|jjt||S)a  Retrieve the information of devices discovered by a specific discovery process in the Cisco Catalyst Center. It checks the reachability status of the devices periodically until all devices are reachable or until a maximum of 3 attempts. Parameters: - discovery_id: ID of the discovery process to retrieve devices from. - task_id: ID of the task associated with the discovery process. Returns: - result: True if all devices are reachable, False otherwise. rr)rgrrFTrr.get_discovered_network_devices_by_discovery_idrz\Retrieved device details using the API 'get_discovered_network_devices_by_discovery_id': {0}rc3DK|]}|jddk(ywreachabilityStatusSuccessNr?.0ress r z6Discovery.get_discovery_device_info..'sQ#377/0I=Q z&All devices in the range are reachabler;c3DK|]}|jddk(ywr"r%r&s rr)z6Discovery.get_discovery_device_info..,SCSWW12i?Sr*z'Some devices in the range are reachablec3DK|]}|jddk7ywr"r%r&s rr)z6Discovery.get_discovery_device_info..1r,r*z9All devices are not reachable, but discovery is completedr7rrz6Discovery network device with id {0} has not completedrMrNz2Discovery network device with id {0} got completed)discovery_device_info)rr@r?rrwrArBrallanyrrrrTrr) r discovery_idrrrcountrwdevicesr=s rget_discovery_device_infoz#Discovery.get_discovery_device_infos))!,00;  .tv."I H ''G HHszz{~@G|HIKR SQQQA6JS7SSBFKS7SSTV_` QJEz JJqM;>JQQR^_C HHS* % KK ! !c ! * ELL\Z\bc 4g>? rc|j}|s&|jjt|yt|}||_|jjt||S)a Retrieve an existing discovery by its name from a range of discoveries. Returns: - discovery: The discovery with the specified name from the range of discoveries. If no matching discovery is found, it returns None and updates the 'exist_discovery' entry in the result dictionary to None. )exist_discoveryN)rrrrhave)rrr7s rget_exist_discoveryzDiscovery.get_exist_discoveryEs];;=  KK  tI> ?I.  4 :;rc||jddd|d}|jdjt|d|jj t ||jd j|jjd d |jjd S) a] Delete an existing discovery in the Cisco Catalyst Center by its ID. Parameters: - params: A dictionary containing the parameters for the delete operation, including the ID of the discovery to delete. Returns: - task_id: The ID of the task created for the delete operation. rrdelete_discovery_by_idTrz9Response collected from API 'delete_discovery_by_id': {0}r)delete_discoveryz#Task Id of the deletion task is {0}rr;) rrArBrrrrrwr?)rrrws rdelete_exist_discoveryz Discovery.delete_exist_discoveryYs+4??6*-   LSSTWX`Tabdkl 4:; 6==h>O>O>S>ST\>]^`fg  $$X..rc|j|j}|j|}|j}|r?t |j d}|j |}|j|}|j|}|j|}|j}|j|j d}d|jd<d |jd <|j|jd <||jd <|jjt d |j|jd d|S)ax Retrieve the information of devices discovered by a specific discovery process in the Cisco Catalyst Center, delete existing discoveries if they exist, and create a new discovery. The function also updates various attributes of the class instance. Returns: - self: The instance of the class with updated attributes. rgrgrrr)r1TchangedzDiscovery Created Successfullyr=diffrwrNr;)r]rrr8rr?r<r rr rr4rr@rrA) rdevices_list_infor3r6rdiscovery_task_idcomplete_discoverydiscovery_task_infors rget_diff_mergedzDiscovery.get_diff_mergedqsN &&( 668::;LM224 _0067F $ ; ;6 ; J !%!=!=FW!=!X  11+2-!88AR8S"IIK//=P=T=TUY=Z/[!% I= E"33 F"3 J 4$DEF U#V, rc|jdjdr|jddd}|jddk(rAd}||jd <|j |d |jd|jd<|S|jddd }|jdjd }d |jd<d|jd <|j|jd<n|j }|s[dj |jdjd|jd <|j |jd d|St|jd}|j|}|j|}d |jd<d|jd <|j|jd<||jd<|j |jd d|S)au Delete an existing discovery in the Cisco Catalyst Center by its name, and updates various attributes of the class instance. If no discovery with the specified name is found, the function updates the 'msg' attribute with an appropriate message. Returns: - self: The instance of the class with updated attributes. rr6rrget_count_of_all_discovery_jobsrrrwzHThere are no discoveries present in the Discovery Dashboard for deletionr=r7delete_all_discoveryrTr@z+All of the Discoveries Deleted SuccessfullyrAzDiscovery {0} Not Foundr*r9rgr>r?rzSuccessfully deleted discoveryr;) r@r?rrrAr8rBrr<r )rcount_discoveriesr=delete_all_responserCr6rrDs rget_diff_deletedzDiscovery.get_diff_deleteds   # ' ' 5 7 7":! !$$Z0A5`%( E"i(*.*?*?*B J' "9$//&"9"/# !4 7 7 C G G Q %)DKK "!NDKK "&"7"7DKK #668O"%>%E%E))!,001AB&D E"U+W5 _0067F $ ; ;6 ; J !%!=!=FW!=!X %)DKK "!ADKK "&"7"7DKK &7DKK # U#V, rc|jdjt|jd|jdjt|d|j }|j d}t |}|jddd|d }|j d }|r"|jd j|dn!|jd j|dd|_|S)a Verify the merged status(Creation/Updation) of Discovery 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 Discovery Database. Current State (have): {0}r;Desired State (want): {0}rgr>rrget_discovery_by_idTrr*z.Requested Discovery with name {0} is completedz2Requested Discovery with name {0} is not completedr7r) rArBrr7rr?rrr>)rr<rEr1rrwr*s rverify_diff_mergedzDiscovery.verify_diff_mergeds ,33C NCVL ,33CK@&I"IIK*..t4  +4??6**    $45  HHELL^\^d e HHIPPQ_`bk l  rcV|jdjt|jd|jdjt|d|j ddurJ|j ddd }|d k(r|jd dn|jd d d|_|S|j}|j d}|r"|jdj|d n!|jdj|dd|_|S)a Verify the deletion status of Discovery 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 discovery(s) exists in the Cisco Catalyst Center configuration's Discovery Database. rOr;rPr6TrrrHrIrzAll discoveries are deletedzAll discoveries are not deletedr7rr*z,Requested Discovery with name {0} is presentzr)rr<rKrEr*s rverify_diff_deletedzDiscovery.verify_diff_deleteds  ,33C NCVL ,33CK@&I ::l #t + 7 7":! !A%6?:IF#DKK"EEG$45  HHCJJ>Z\e f HHSZZ[ijlr s  r)N)NN)__name__ __module__ __qualname__r rHr]r`rrrrrrurrrr r rrr4r8r<rFrMrRrT __classcell__)rs@rr r s!$L\#DJ #t&l.&` >$@\'!B7!r-<,\*X1 f-^<|(/0B1f%N&rr c:iddddddddddd d gd d ddd ddddddddddddddddddddddddddddddddddddddddd dd!dd"dd#d$d%d&d'd'd(gd)}t|d*}t|}|jjd}|jjd&}||jvr-d+|_d,j ||_|j|j|-j|jD]Z}|j|j|j|s8|j||j\|jd/i|jy.)0z+ main entry point for module execution dnac_hostTr)rr dnac_port443)rr dnac_usernameadminuser)rraliases dnac_password)rno_log dnac_verifyr#True dnac_versionz2.2.3.3 dnac_debugFdnac_logdnac_log_levelr7dnac_log_file_pathzdnac.logdnac_log_appendvalidate_response_schema config_verifydnac_api_task_timeoutridnac_task_poll_intervalrLr<rr)rrr rDr2r5)rchoices) argument_specsupports_check_modeinvalidzState {0} is invalid)rDN)rr rr?supported_statesr>rBr=check_return_statusrHr@ reset_valuesget_diff_state_applyverify_diff_state_apply exit_jsonr) element_specr ccc_discoveryrlrDr<s rmainr|sCKdE!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&/46Ff%M!((,,_=M  $ $W -E M222( 299%@ ))+  u -AAC00W""$1 **513GGI  8M 1 1% 8 @ T T V W F,}++,r__main__) __future__rrrr __metaclass__ __author__ DOCUMENTATIONEXAMPLESRETURNansible.module_utils.basicr8ansible_collections.cisco.dnac.plugins.module_utils.dnacrrrrr r|rUrsrrrsm A@ D G P Z v# L5 xxv#*-Z zFr