Try SpotterResource module for Reports
| "added in version" 3.1.0 of cisco.dnac"
Authors: Rafael Campos (@racampos)
This plugin has a corresponding action plugin.
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections:
- name: cisco.dnac
version: 6.13.3Manage operations create and delete of the resource Reports.
Create/Schedule a report configuration. Use "Get view details for a given view group & view" API to get the metadata required to configure a report.
Delete a scheduled report configuration. Deletes the report executions also.
- name: Create
cisco.dnac.reports:
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}}"
state: present
deliveries:
- {}
name: string
schedule: {}
tags:
- string
view:
fieldGroups:
- fieldGroupDisplayName: string
fieldGroupName: string
fields:
- displayName: string
name: string
filters:
- displayName: string
name: string
type: string
value: {}
format:
formatType: string
name: string
name: string
viewId: string
viewGroupId: string
viewGroupVersion: string
- name: Delete by id
cisco.dnac.reports:
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}}"
state: absent
reportId: string
name:
description: Report name.
type: str
tags:
description: Array of tags for report.
elements: str
type: list
view:
description: Reports's view.
suboptions:
fieldGroups:
description: Reports's fieldGroups.
elements: dict
suboptions:
fieldGroupDisplayName:
description: Field group label/displayname for user.
type: str
fieldGroupName:
description: Field group name.
type: str
fields:
description: Reports's fields.
elements: dict
suboptions:
displayName:
description: Field label/displayname.
type: str
name:
description: Field name.
type: str
type: list
type: list
filters:
description: Reports's filters.
elements: dict
suboptions:
displayName:
description: Filter label/displayname.
type: str
name:
description: Filter name.
type: str
type:
description: Filter type.
type: str
value:
description: Value of filter. Data type is based on the filter type. Use the
filter definitions from the view to fetch the options for a filter.
type: dict
type: list
format:
description: Reports's format.
suboptions:
formatType:
description: Format type of report.
type: str
name:
description: Format name of report.
type: str
type: dict
name:
description: View name.
type: str
viewId:
description: View Id.
type: str
type: dict
reportId:
description: ReportId path parameter. ReportId of report.
type: str
schedule:
description: Reports's schedule.
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
deliveries:
description: Array of available delivery channels.
elements: dict
type: list
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
viewGroupId:
description: ViewGroupId of the viewgroup for the report.
type: str
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
viewGroupVersion:
description: Version of viewgroup for the report.
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
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python
SDK
returned: always
sample: "{\n \"tags\": [\n \"string\"\n ],\n \"dataCategory\": \"string\"\
,\n \"deliveries\": [\n {}\n ],\n \"executionCount\": 0,\n \"executions\"\
: [\n {\n \"endTime\": 0,\n \"errors\": [\n \"string\"\n \
\ ],\n \"executionId\": \"string\",\n \"processStatus\": \"string\"\
,\n \"requestStatus\": \"string\",\n \"startTime\": 0,\n \"warnings\"\
: [\n \"string\"\n ]\n }\n ],\n \"name\": \"string\",\n \"reportId\"\
: \"string\",\n \"reportWasExecuted\": true,\n \"schedule\": {},\n \"view\"\
: {\n \"fieldGroups\": [\n {\n \"fieldGroupDisplayName\": \"string\"\
,\n \"fieldGroupName\": \"string\",\n \"fields\": [\n {\n\
\ \"displayName\": \"string\",\n \"name\": \"string\"\n\
\ }\n ]\n }\n ],\n \"filters\": [\n {\n \
\ \"displayName\": \"string\",\n \"name\": \"string\",\n \"type\"\
: \"string\",\n \"value\": {}\n }\n ],\n \"format\": {\n \
\ \"formatType\": \"string\",\n \"name\": \"string\"\n },\n \"name\"\
: \"string\",\n \"viewId\": \"string\",\n \"description\": \"string\",\n\
\ \"viewInfo\": \"string\"\n },\n \"viewGroupId\": \"string\",\n \"viewGroupVersion\"\
: \"string\"\n}\n"
type: dict