cisco.dnac.reports_info – Information module for Reports

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.reports_info.

New in version 3.1.0: of cisco.dnac

Synopsis

• Get all Reports.

• Get Reports by id.

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
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.
reportId string		ReportId path parameter. ReportId of report.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.
viewGroupId string		ViewGroupId query parameter. ViewGroupId of viewgroup for report.
viewId string		ViewId query parameter. ViewId of view for report.

Notes

Note

• Supports check_mode

See Also

See also

Reports reference

Complete reference of the Reports object model.

Examples

- name: Get all Reports
  cisco.dnac.reports_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
    viewGroupId: string
    viewId: string
  register: result

- name: Get Reports by id
  cisco.dnac.reports_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
    reportId: 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: { "tags": [ "string" ], "dataCategory": "string", "deliveries": [], "executionCount": 0, "executions": [ { "endTime": 0, "errors": [ "string" ], "executionId": "string", "processStatus": "string", "requestStatus": "string", "startTime": 0, "warnings": [ "string" ] } ], "name": "string", "reportId": "string", "reportWasExecuted": true, "schedule": {}, "view": { "fieldGroups": [ { "fieldGroupDisplayName": "string", "fieldGroupName": "string", "fields": [ { "displayName": "string", "name": "string" } ] } ], "filters": [ { "displayName": "string", "name": "string", "type": "string", "value": {} } ], "format": { "formatType": "string", "name": "string", "default": true }, "name": "string", "viewId": "string", "description": "string", "viewInfo": "string" }, "viewGroupId": "string", "viewGroupVersion": "string" }

Authors

• Rafael Campos (@racampos)