cisco.dnac.discovery_job_info (6.13.3) — module

Install collection

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

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Discovery Job.

Get Discovery Job by id.

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

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get all Discovery Job
  cisco.dnac.discovery_job_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
    ipAddress: string
    name: string
  register: result

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get Discovery Job by id
  cisco.dnac.discovery_job_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    offset: 0
    limit: 0
    ipAddress: string
    id: string
  register: result

Inputs

    
id:
    description:
    - Id path parameter. Discovery ID.
    type: str

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

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

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

headers:
    description: Additional headers.
    type: dict

dnac_host:
    description:
    - The Cisco DNA Center hostname.
    required: true
    type: str

dnac_port:
    default: 443
    description:
    - The Cisco DNA Center port.
    type: int

ipAddress:
    description:
    - IpAddress query parameter.
    type: str

dnac_debug:
    default: false
    description:
    - Flag for Cisco DNA Center SDK to enable debugging.
    type: bool

dnac_verify:
    default: true
    description:
    - Flag to enable or disable SSL certificate verification.
    type: bool

dnac_version:
    default: 2.3.5.3
    description:
    - Informs the SDK which version of Cisco DNA Center to use.
    type: str

dnac_password:
    description:
    - The Cisco DNA Center password to authenticate.
    type: str

dnac_username:
    aliases:
    - user
    default: admin
    description:
    - The Cisco DNA Center username to authenticate.
    type: str

validate_response_schema:
    default: true
    description:
    - Flag for Cisco DNA Center SDK to enable the validation of request bodies against
      a JSON schema.
    type: bool

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"response\": [\n    {\n      \"attributeInfo\": {},\n      \"cliStatus\"\
    : \"string\",\n      \"discoveryStatus\": \"string\",\n      \"endTime\": \"string\"\
    ,\n      \"httpStatus\": \"string\",\n      \"id\": \"string\",\n      \"inventoryCollectionStatus\"\
    : \"string\",\n      \"inventoryReachabilityStatus\": \"string\",\n      \"ipAddress\"\
    : \"string\",\n      \"jobStatus\": \"string\",\n      \"name\": \"string\",\n\
    \      \"netconfStatus\": \"string\",\n      \"pingStatus\": \"string\",\n   \
    \   \"snmpStatus\": \"string\",\n      \"startTime\": \"string\",\n      \"taskId\"\
    : \"string\"\n    }\n  ],\n  \"version\": \"string\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for Discovery GetDiscoveryJobsByIP: Complete reference of the GetDiscoveryJobsByIP API. link
• Cisco DNA Center documentation for Discovery GetListOfDiscoveriesByDiscoveryId: Complete reference of the GetListOfDiscoveriesByDiscoveryId API. link