cisco.dnac.discovery_job – Manage DiscoveryJob objects of Discovery

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.discovery_job.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Returns the list of discovery jobs for the given Discovery ID. The results can be optionally filtered based on IP. Discovery ID can be obtained using the “Get Discoveries by range” API.

  • Returns the list of discovery jobs for the given IP.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
id
string / required
Discovery ID.
ip_address
string
IpAddress query parameter.
Required for state query.
limit
integer
Limit query parameter.
name
string
Name query parameter.
offset
integer
Offset query parameter.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.discovery_job

The official documentation on the cisco.dnac.plugins.module_utils.definitions.discovery_job module.

DiscoveryJob reference

Complete reference of the DiscoveryJob object model.

DiscoveryJob reference

SDK reference.

Examples

- name: get_list_of_discoveries_by_discovery_id
  cisco.dnac.discovery_job:
    state: query  # required
    id: SomeValue  # string, required
    ip_address: SomeValue  # string
    limit: 1  #  integer
    offset: 1  #  integer
  register: nm_get_list_of_discoveries_by_discovery_id

- name: get_discovery_jobs_by_ip
  cisco.dnac.discovery_job:
    state: query  # required
    ip_address: SomeValue  # string, required
    limit: 1  #  integer
    name: SomeValue  # string
    offset: 1  #  integer
  register: nm_get_discovery_jobs_by_ip

Return Values

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

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
discovery.get_discovery_jobs_by_ip


Authors

  • Rafael Campos (@racampos)