.. 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-entry .. role:: ansible-option-default .. 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 5.1.0). You might already have this collection installed if you are using the ``ansible`` package. It is not included in ``ansible-core``. To check whether it is installed, run :code:`ansible-galaxy collection list`. To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.discovery`. .. version_added .. versionadded:: 3.1.0 of cisco.dnac .. 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 Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk == 2.4.5 - 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
Discovery's attributeInfo. .. 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
Discovery's cdpLevel. .. 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
Discovery's deviceIds. .. 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
Discovery's discoveryCondition. .. 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
Discovery's discoveryStatus. .. 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
Discovery's discoveryType. .. 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-default-bold:`no` :ansible-option-default:`← (default)` - :ansible-option-choices-entry:`yes` .. 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:`string` .. 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:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (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.2.3.3"` .. 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
Discovery's enablePasswordList. .. 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
Discovery's globalCredentialIdList. .. 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
Discovery's comments. .. 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
Discovery's credentialType. .. 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
Discovery's description. .. 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
Discovery's 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
Discovery's instanceTenantId. .. 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
Discovery's instanceUuid. .. 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
Discovery'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
Discovery'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
Secure flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. 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
Discovery'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
Discovery's comments. .. 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
Discovery's credentialType. .. 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
Discovery's description. .. 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
Discovery's 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
Discovery's instanceTenantId. .. 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
Discovery's instanceUuid. .. 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
Discovery'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
Discovery'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
Secure flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. 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
Discovery'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
Discovery's 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
Discovery's ipAddressList. .. 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
Discovery's ipFilterList. .. 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
IsAutoCdp flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. 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
Discovery's lldpLevel. .. 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
Discovery's name. .. 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
Discovery's netconfPort. .. 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
Discovery's numDevices. .. 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
Discovery's parentDiscoveryId. .. 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
Discovery's passwordList. .. 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
Discovery's preferredMgmtIPMethod. .. 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
Discovery's protocolOrder. .. 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
Discovery's retryCount. .. 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
Discovery's snmpAuthPassphrase. .. 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
Discovery's snmpAuthProtocol. .. 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
Discovery's snmpMode. .. 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
Discovery's snmpPrivPassphrase. .. 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
Discovery's snmpPrivProtocol. .. 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
Discovery's snmpRoCommunity. .. 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
Discovery's snmpRoCommunityDesc. .. 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
Discovery's snmpRwCommunity. .. 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
Discovery's snmpRwCommunityDesc. .. 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
Discovery's snmpUserName. .. 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
Discovery's timeOut. .. 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
UpdateMgmtIp flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`no` - :ansible-option-choices-entry:`yes` .. 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
Discovery's userNameList. .. 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:`no` - :ansible-option-default-bold:`yes` :ansible-option-default:`← (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 .. 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:` "{\\n \\"response\\": {\\n \\"taskId\\": \\"string\\",\\n \\"url\\": \\"string\\"\\n },\\n \\"version\\": \\"string\\"\\n}\\n" .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors