cisco.catalystcenter.discoverys_jobs_summarys_info module -- Information module for Discoverys Jobs Summarys

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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_summarys_info.

New in cisco.catalystcenter 2.3.0

Synopsis

  • Get all Discoverys Jobs Summarys. - > API to fetch the summary of all discoveries. The response includes the basic details of all discoveries, latest job status and the number of reachable devices.

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"`

headers

dictionary

Additional headers.

id

list / elements=string

Id query parameter. Optional list of the discovery ids to filter by.

limit

integer

Limit query parameter. The number of records to show for this page.

name

string

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

integer

Offset query parameter. The first record to show for this page; the first record is numbered 1.

order

string

Order query parameter. To fetch the latest discovery job. Use the order query parameter with values such as asc or des. By default, jobs are ordered by descending order to display the most recent entries first.

orderBy

string

OrderBy query parameter. To fetch the latest discovery job. Use the orderBy query parameter with values such as lastUpdatedDate, startTime and endTime. By default, jobs are ordered by lastUpdatedDate display the most recent entries first.

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_summary_of_all_discoveries_with_latest_jobs,

  • Paths used are get /dna/intent/api/v1/discoverys/jobs/summarys,

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

Complete reference of the FetchesTheSummaryOfAllDiscoveriesWithLatestJobs API.

Examples

---
- name: Get all Discoverys Jobs Summarys
  cisco.catalystcenter.discoverys_jobs_summarys_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}}"
    id: [12, 13]
    name: string
    limit: 0
    offset: 1
    orderBy: string
    order: 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": [{"discoveryTypeDetails": {}, "endTime": 0, "id": "string", "jobId": "string", "lastUpdatedDate": 0, "name": "string", "reachableDevices": 0, "startTime": 0, "status": "string"}], "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)