cisco.dnac.discoverys_info module -- Information module for Discoverys
Note
This module is part of the cisco.dnac collection (version 6.46.0).
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.discoverys_info.
New in cisco.dnac 6.46.0
Synopsis
Get all Discoverys.
Get Discoverys by id.
API to fetch the discovery details using basic filters.
API to get discovery details for the given discovery id.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.11.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices: |
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: :ansible-option-default:`443` |
|
The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Additional headers. |
|
Id query parameter. Optional list of the discovery ids to filter by. |
|
Limit query parameter. The number of records to show for this page. |
|
Name query parameter. Optional name of the discovery to filter by. This supports partial search. For example, searching for "Disc" will match "Discovery1", "Discovery2", etc. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are devices.Devices.fetches_all_discovery_details, devices.Devices.fetches_discovery_details_by_id,
Paths used are get /dna/intent/api/v1/discoverys, get /dna/intent/api/v1/discoverys/{id},
Supports
check_modeThe 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
See Also
See also
- Cisco DNA Center documentation for Devices FetchesAllDiscoveryDetails
Complete reference of the FetchesAllDiscoveryDetails API.
- Cisco DNA Center documentation for Devices FetchesDiscoveryDetailsById
Complete reference of the FetchesDiscoveryDetailsById API.
Examples
---
- name: Get all Discoverys
cisco.dnac.discoverys_info:
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}}"
headers: "{{my_headers | from_json}}"
id: string
limit: 0
name: string
offset: 0
register: result
- name: Get Discoverys by id
cisco.dnac.discoverys_info:
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}}"
headers: "{{my_headers | from_json}}"
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|