cisco.catalystcenter.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.catalystcenter collection (version 2.11.0).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.discoverys_jobs_discovered_network_devices_count_info.

New in cisco.catalystcenter 2.3.0

Synopsis

  • Get all Discoverys Jobs Discovered Network Devices Count.

  • API to fetch the number of discovered network devices by using the given discoveryId and jobId.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

cli

string

Cli query parameter. CLI status for the IP during the job run. Available values are 'SUCCESS', 'FAILURE', 'NOT_PROVIDED' and 'NOT_VALIDATED.

discoveryId

string

DiscoveryId path parameter. Discovery id.

headers

dictionary

Additional headers.

http

string

Http query parameter. HTTP status for the IP during the job run. Available values are 'SUCCESS', 'FAILURE', 'NOT_PROVIDED' and 'NOT_VALIDATED.

jobId

string

JobId path parameter. The id of the discovery job.

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. Available values are 'SUCCESS', 'FAILURE', 'NOT_PROVIDED' and 'NOT_VALIDATED.

ping

string

Ping query parameter. Ping status for the IP during the job run. Available values are 'SUCCESS', 'FAILURE', 'NOT_PROVIDED' and 'NOT_VALIDATED.

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. Available values are 'SUCCESS', 'FAILURE', 'NOT_PROVIDED' and 'NOT_VALIDATED.

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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 uses the embedded connection manager from Cisco CATALYST SDK

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Devices CountTheNumberOfDiscoveredNetworkDevicesByDiscoveryId

Complete reference of the CountTheNumberOfDiscoveredNetworkDevicesByDiscoveryId API.

Examples

---
- name: Get all Discoverys Jobs Discovered Network Devices Count
  cisco.catalystcenter.discoverys_jobs_discovered_network_devices_count_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    managementIpAddress: string
    reachabilityStatus: string
    ping: string
    cli: string
    snmp: string
    http: string
    netconf: string
    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

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)