/ home / cisco / cisco.dnac / 6.13.3 / module / discovery_summary_info

cisco.dnac.discovery_summary_info (6.13.3) — module

Information module for Discovery Summary

| "added in version" 3.1.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:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

Get all Discovery Summary.

Returns the network devices from a discovery job based on given filters. Discovery ID can be obtained using the "Get Discoveries by range" API.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- name: Get all Discovery Summary
  cisco.dnac.discovery_summary_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}}"
    taskId: string
    sortBy: string
    sortOrder: string
    ipAddress: []
    pingStatus: []
    snmpStatus: []
    cliStatus: []
    netconfStatus: []
    httpStatus: []
    id: string
  register: result

Inputs

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

sortBy:
    description:
    - SortBy query parameter.
    type: str

taskId:
    description:
    - TaskId query parameter.
    type: str

headers:
    description: Additional headers.
    type: dict

cliStatus:
    description:
    - CliStatus query parameter.
    elements: str
    type: list

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.
    elements: str
    type: list

sortOrder:
    description:
    - SortOrder query parameter.
    type: str

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

httpStatus:
    description:
    - HttpStatus query parameter.
    elements: str
    type: list

pingStatus:
    description:
    - PingStatus query parameter.
    elements: str
    type: list

snmpStatus:
    description:
    - SnmpStatus query parameter.
    elements: str
    type: list

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

netconfStatus:
    description:
    - NetconfStatus query parameter.
    elements: str
    type: list

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\": 0,\n  \"version\": \"string\"\n}\n"
  type: dict