cisco.dnac.discovery_summary_info – Information module for Discovery Summary

Note

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

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Get all Discovery Summary.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.3.1

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
cliStatus list / elements=string		CliStatus query parameter.
dnac_debug boolean	Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required		The Cisco DNA Center hostname.
dnac_password string		The Cisco DNA Center password to authenticate.
dnac_port string	Default: 443	The Cisco DNA Center port.
dnac_username string	Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string	Default: "2.2.2.3"	Informs the SDK which version of Cisco DNA Center to use.
headers dictionary		Additional headers.
httpStatus list / elements=string		HttpStatus query parameter.
id string		Id path parameter. Discovery ID.
ipAddress list / elements=string		IpAddress query parameter.
netconfStatus list / elements=string		NetconfStatus query parameter.
pingStatus list / elements=string		PingStatus query parameter.
snmpStatus list / elements=string		SnmpStatus query parameter.
sortBy string		SortBy query parameter.
sortOrder string		SortOrder query parameter.
taskId string		TaskId query parameter.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• Supports check_mode

See Also

See also

Discovery Summary reference

Complete reference of the Discovery Summary object model.

Examples

- 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:
      custom: value
    taskId: string
    sortBy: string
    sortOrder: string
    ipAddress: []
    pingStatus: []
    snmpStatus: []
    cliStatus: []
    netconfStatus: []
    httpStatus: []
    id: string
  register: result

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 or list with the response returned by the Cisco DNAC Python SDK Sample: { "response": 0, "version": "string" }

Authors

• Rafael Campos (@racampos)