cisco.dnac.discoverys_jobs_discovered_network_devices_count_info module -- Information module for Discoverys Jobs Discovered Network Devices Count

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_jobs_discovered_network_devices_count_info.

New in cisco.dnac 6.46.0

Synopsis

• Get all Discoverys Jobs Discovered Network Devices Count.

• API to get the details of all the devices discovered by the given jobId and discoveryId.

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
cli string	Cli query parameter. CLI status for the IP during the job run.
discoveryId string	DiscoveryId path parameter. The id of the discovery.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"`
headers dictionary	Additional headers.
http string	Http query parameter. HTTP status for the IP during the job run.
jobId string	JobId path parameter. The id of the discovery job.
limit integer	Limit query parameter. The number of records to show for this page.
managementIpAddress string	ManagementIpAddress query parameter. Management IP address of the network device.
netconf string	Netconf query parameter. Netconf status for the IP during the job run.
offset integer	Offset query parameter. The first record to show for this page; the first record is numbered 1.
ping string	Ping query parameter. Ping status for the IP during the job run.
reachabilityStatus string	ReachabilityStatus query parameter. Reachability status of the network device.
snmp string	Snmp query parameter. SNMP status for the IP during the job run.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are devices.Devices.count_the_number_of_discovered_network_devices_by_discovery_id,

• Paths used are get /dna/intent/api/v1/discoverys/{discoveryId}/jobs/{jobId}/discoveredNetworkDevices/count,

• Supports 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

See Also

See also

Cisco DNA Center documentation for Devices CountTheNumberOfDiscoveredNetworkDevicesByDiscoveryId

Complete reference of the CountTheNumberOfDiscoveredNetworkDevicesByDiscoveryId API.

Examples

---
- name: Get all Discoverys Jobs Discovered Network Devices Count
  cisco.dnac.discoverys_jobs_discovered_network_devices_count_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}}"
    managementIpAddress: string
    reachabilityStatus: string
    ping: string
    cli: string
    snmp: string
    http: string
    netconf: string
    limit: 0
    offset: 0
    discoveryId: string
    jobId: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)