cisco.dnac.discovery_job (2.0.7) — module

Manage DiscoveryJob objects of Discovery

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

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.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
id:
    description:
    - Discovery ID.
    required: true
    type: str

name:
    description:
    - Name query parameter.
    type: str

limit:
    description:
    - Limit query parameter.
    type: int

offset:
    description:
    - Offset query parameter.
    type: int

ip_address:
    description:
    - IpAddress query parameter.
    - Required for state query.
    type: str

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: discovery.get_discovery_jobs_by_ip
  type: str

See also