cisco.catalystcenter.discoverys_jobs_discovered_network_devices_info module -- Information module for Discoverys Jobs Discovered Network Devices

Note

This module is part of the cisco.catalystcenter collection (version 2.3.1).

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

New in cisco.catalystcenter 6.46.0

Synopsis

  • Get all Discoverys Jobs Discovered Network Devices.

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

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

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

discoveryId

string

DiscoveryId path parameter. The id of the discovery.

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 Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are devices.Devices.fetches_the_details_of_all_the_devices_discovered_by_the_given_job_id_and_discovery_id,

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

  • 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

See Also

See also

Cisco DNA Center documentation for Devices FetchesTheDetailsOfAllTheDevicesDiscoveredByTheGivenJobIdAndDiscoveryId

Complete reference of the FetchesTheDetailsOfAllTheDevicesDiscoveredByTheGivenJobIdAndDiscoveryId API.

Examples

---
- name: Get all Discoverys Jobs Discovered Network Devices
  cisco.catalystcenter.discoverys_jobs_discovered_network_devices_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
    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": [{"discoveryStatus": "string", "hostname": "string", "id": "string", "managementIpAddress": "string", "reachabilityFailureReason": "string", "reachabilityStatus": "string", "status": "string", "validationStatuses": {"cli": "string", "http": "string", "netconf": "string", "ping": "string", "snmp": "string"}}], "version": "string"}`

Authors

  • Rafael Campos (@racampos)