cisco.catalystcenter.discoverys_jobs_info module -- Information module for Discoverys Jobs
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_info.
New in cisco.catalystcenter 6.46.0
Synopsis
Get all Discoverys Jobs.
Get Discoverys Jobs by id. - > API to get all the discovery job details by discovery id. A discovery can have multiple discovery jobs, created against the same discovery id.
This API retrieves the details of a specific discovery job using the given job id and discovery id.
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 |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst 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 Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
DiscoveryId path parameter. The id of the discovery. |
|
Additional headers. |
|
Id path parameter. The id of the discovery. |
|
JobId path parameter. The id of the discovery job. |
|
Limit query parameter. The number of records to show for this page. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
OrderBy query parameter. To fetch the latest discovery job. Use the orderBy query parameter with values such as startTime or endTime. By default, jobs are ordered by startTime in descending order to display the most recent entries first. |
|
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_all_the_discovery_job_details_by_discovery_id, devices.Devices.fetches_the_discovery_job_details_for_the_given_job_id,
Paths used are get /dna/intent/api/v1/discoverys/{discoveryId}/jobs/{jobId}, get /dna/intent/api/v1/discoverys/{id}/jobs,
Supports
check_modeThe 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 FetchesAllTheDiscoveryJobDetailsByDiscoveryId
Complete reference of the FetchesAllTheDiscoveryJobDetailsByDiscoveryId API.
- Cisco DNA Center documentation for Devices FetchesTheDiscoveryJobDetailsForTheGivenJobId
Complete reference of the FetchesTheDiscoveryJobDetailsForTheGivenJobId API.
Examples
---
- name: Get all Discoverys Jobs
cisco.catalystcenter.discoverys_jobs_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}}"
jobId: string
limit: 0
offset: 0
orderBy: string
id: string
register: result
- name: Get Discoverys Jobs by id
cisco.catalystcenter.discoverys_jobs_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}}"
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 |
|---|---|