.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.discovery_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.discovery module -- Resource module for Discovery ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.19.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.discovery`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Discovery. - Initiates discovery with the given parameters. - Stops all the discoveries and removes them. - Stops the discovery for the given Discovery ID and removes it. Discovery ID can be obtained using the "Get Discoveries by range" API. - Stops or starts an existing discovery. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.discovery_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-attributeinfo: .. rst-class:: ansible-option-title **attributeInfo** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Deprecated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-cdplevel: .. rst-class:: ansible-option-title **cdpLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
CDP level to which neighbor devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-deviceids: .. rst-class:: ansible-option-title **deviceIds** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Ids of the devices discovered in a discovery. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-discoverycondition: .. rst-class:: ansible-option-title **discoveryCondition** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
To indicate the discovery status. Available options Complete or In Progress. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-discoverystatus: .. rst-class:: ansible-option-title **discoveryStatus** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Status of the discovery. Available options are active, inactive, edit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-discoverytype: .. rst-class:: ansible-option-title **discoveryType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the discovery. 'SINGLE', 'RANGE', 'MULTI RANGE', 'CDP', 'LLDP', 'CIDR'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.discovery_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-enablepasswordlist: .. rst-class:: ansible-option-title **enablePasswordList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Enable Password of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-globalcredentialidlist: .. rst-class:: ansible-option-title **globalCredentialIdList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of global credential ids to be used. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential: .. rst-class:: ansible-option-title **httpReadCredential** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Discovery's httpReadCredential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/comments: .. rst-class:: ansible-option-title **comments** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Comments to identify the credential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/credentialtype: .. rst-class:: ansible-option-title **credentialType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential type to identify the application that uses the credential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of the credential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/instancetenantid: .. rst-class:: ansible-option-title **instanceTenantId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential Tenant Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/instanceuuid: .. rst-class:: ansible-option-title **instanceUuid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP(S) password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
HTTP(S) port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/secure: .. rst-class:: ansible-option-title **secure** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for HTTPS. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpreadcredential/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP(S) username. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential: .. rst-class:: ansible-option-title **httpWriteCredential** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Discovery's httpWriteCredential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/comments: .. rst-class:: ansible-option-title **comments** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Comments to identify the credential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/credentialtype: .. rst-class:: ansible-option-title **credentialType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential type to identify the application that uses the credential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of the credential. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/instancetenantid: .. rst-class:: ansible-option-title **instanceTenantId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential Tenant Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/instanceuuid: .. rst-class:: ansible-option-title **instanceUuid** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Credential Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/password: .. rst-class:: ansible-option-title **password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP(S) password. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/port: .. rst-class:: ansible-option-title **port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
HTTP(S) port. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/secure: .. rst-class:: ansible-option-title **secure** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for HTTPS. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-httpwritecredential/username: .. rst-class:: ansible-option-title **username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
HTTP(S) username. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique Discovery Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-ipaddresslist: .. rst-class:: ansible-option-title **ipAddressList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
List of IP address of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-ipfilterlist: .. rst-class:: ansible-option-title **ipFilterList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IP addresses of the devices to be filtered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-isautocdp: .. rst-class:: ansible-option-title **isAutoCdp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to mention if CDP discovery or not. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-lldplevel: .. rst-class:: ansible-option-title **lldpLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
LLDP level to which neighbor devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name for the discovery. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-netconfport: .. rst-class:: ansible-option-title **netconfPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Netconf port on the device. Netconf will need valid sshv2 credentials for it to work. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-numdevices: .. rst-class:: ansible-option-title **numDevices** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of devices discovered in the discovery. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-parentdiscoveryid: .. rst-class:: ansible-option-title **parentDiscoveryId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Parent Discovery Id from which the discovery was initiated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-passwordlist: .. rst-class:: ansible-option-title **passwordList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-preferredmgmtipmethod: .. rst-class:: ansible-option-title **preferredMgmtIPMethod** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Preferred management IP method. Available options are 'None' and 'UseLoopBack'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-protocolorder: .. rst-class:: ansible-option-title **protocolOrder** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Order of protocol (ssh/telnet) in which device connection will be tried. Ex 'telnet' only telnet; 'ssh,telnet' ssh with higher order than telnet. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-retry: .. rst-class:: ansible-option-title **retry** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of times to try establishing connection to device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-retrycount: .. rst-class:: ansible-option-title **retryCount** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of times to try establishing connection to device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmpauthpassphrase: .. rst-class:: ansible-option-title **snmpAuthPassphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Auth passphrase for SNMP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmpauthprotocol: .. rst-class:: ansible-option-title **snmpAuthProtocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP auth protocol. SHA' or 'MD5'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmpmode: .. rst-class:: ansible-option-title **snmpMode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Mode of SNMP. 'AUTHPRIV' or 'AUTHNOPRIV' or 'NOAUTHNOPRIV'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmpprivpassphrase: .. rst-class:: ansible-option-title **snmpPrivPassphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Passphrase for SNMP privacy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmpprivprotocol: .. rst-class:: ansible-option-title **snmpPrivProtocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP privacy protocol. 'AES128'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprocommunity: .. rst-class:: ansible-option-title **snmpROCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP RO community of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprocommunity: .. rst-class:: ansible-option-title **snmpRoCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP RO community of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprocommunitydesc: .. rst-class:: ansible-option-title **snmpROCommunityDesc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description for SNMP RO community. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprocommunitydesc: .. rst-class:: ansible-option-title **snmpRoCommunityDesc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description for SNMP RO community. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprwcommunity: .. rst-class:: ansible-option-title **snmpRWCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP RW community of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprwcommunity: .. rst-class:: ansible-option-title **snmpRwCommunity** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP RW community of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprwcommunitydesc: .. rst-class:: ansible-option-title **snmpRWCommunityDesc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description for SNMP RW community. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmprwcommunitydesc: .. rst-class:: ansible-option-title **snmpRwCommunityDesc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description for SNMP RW community. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmpusername: .. rst-class:: ansible-option-title **snmpUserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SNMP username of the device. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-snmpversion: .. rst-class:: ansible-option-title **snmpVersion** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Version of SNMP. V2 or v3. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-timeout: .. rst-class:: ansible-option-title **timeOut** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time to wait for device response. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time to wait for device response in seconds. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-updatemgmtip: .. rst-class:: ansible-option-title **updateMgmtIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Updates Management IP if multiple IPs are available for a device. If set to true, when a device is rediscovered with a different IP, the management IP is updated. Default value is false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-usernamelist: .. rst-class:: ansible-option-title **userNameList** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username of the devices to be discovered. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are discovery.Discovery.delete\_discovery\_by\_id, discovery.Discovery.start\_discovery, discovery.Discovery.updates\_discovery\_by\_id, - Paths used are post /dna/intent/api/v1/discovery, delete /dna/intent/api/v1/discovery, delete /dna/intent/api/v1/discovery/{id}, put /dna/intent/api/v1/discovery, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK - The parameters starting with dnac\_ are used by the Cisco DNAC Python SDK to establish the connection .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Discovery StartDiscovery `_ Complete reference of the StartDiscovery API. `Cisco DNA Center documentation for Discovery DeleteAllDiscovery `_ Complete reference of the DeleteAllDiscovery API. `Cisco DNA Center documentation for Discovery DeleteDiscoveryById `_ Complete reference of the DeleteDiscoveryById API. `Cisco DNA Center documentation for Discovery UpdatesAnExistingDiscoveryBySpecifiedId `_ Complete reference of the UpdatesAnExistingDiscoveryBySpecifiedId API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Delete all cisco.dnac.discovery: 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}}" state: absent - name: Update all cisco.dnac.discovery: 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}}" state: present attributeInfo: {} cdpLevel: 0 deviceIds: string discoveryCondition: string discoveryStatus: string discoveryType: string enablePasswordList: string globalCredentialIdList: - string httpReadCredential: comments: string credentialType: string description: string id: string instanceTenantId: string instanceUuid: string password: string port: 0 secure: true username: string httpWriteCredential: comments: string credentialType: string description: string id: string instanceTenantId: string instanceUuid: string password: string port: 0 secure: true username: string id: string ipAddressList: string ipFilterList: string isAutoCdp: true lldpLevel: 0 name: string netconfPort: string numDevices: 0 parentDiscoveryId: string passwordList: string preferredMgmtIPMethod: string protocolOrder: string retryCount: 0 snmpAuthPassphrase: string snmpAuthProtocol: string snmpMode: string snmpPrivPassphrase: string snmpPrivProtocol: string snmpRoCommunity: string snmpRoCommunityDesc: string snmpRwCommunity: string snmpRwCommunityDesc: string snmpUserName: string timeOut: 0 updateMgmtIp: true userNameList: string - name: Create cisco.dnac.discovery: 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}}" state: present cdpLevel: 0 discoveryType: string enablePasswordList: - string globalCredentialIdList: - string httpReadCredential: password: string port: 0 secure: true username: string httpWriteCredential: password: string port: 0 secure: true username: string ipAddressList: string ipFilterList: - string lldpLevel: 0 name: string netconfPort: string passwordList: - string preferredMgmtIPMethod: string protocolOrder: string retry: 0 snmpAuthPassphrase: string snmpAuthProtocol: string snmpMode: string snmpPrivPassphrase: string snmpPrivProtocol: string snmpROCommunity: string snmpROCommunityDesc: string snmpRWCommunity: string snmpRWCommunityDesc: string snmpUserName: string snmpVersion: string timeout: 0 userNameList: - string - name: Delete by id cisco.dnac.discovery: 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}}" state: absent id: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.discovery_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors