1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: reports_info
short_description: Information module for Reports
description:
- Get all Reports.
- Get Reports by id.
- Get list of scheduled report configurations.
- Get scheduled report configuration by reportId.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
viewGroupId:
description:
- ViewGroupId query parameter. ViewGroupId of viewgroup for report.
type: str
viewId:
description:
- ViewId query parameter. ViewId of view for report.
type: str
reportId:
description:
- ReportId path parameter. ReportId of report.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Reports GetAScheduledReport
description: Complete reference of the GetAScheduledReport API.
link: https://developer.cisco.com/docs/dna-center/#!get-a-scheduled-report
- name: Cisco DNA Center documentation for Reports GetListOfScheduledReports
description: Complete reference of the GetListOfScheduledReports API.
link: https://developer.cisco.com/docs/dna-center/#!get-list-of-scheduled-reports
notes:
- SDK Method used are
reports.Reports.get_a_scheduled_report,
reports.Reports.get_list_of_scheduled_reports,
- Paths used are
get /dna/intent/api/v1/data/reports,
get /dna/intent/api/v1/data/reports/{reportId},
"""
EXAMPLES = r"""
- 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: "{{my_headers | from_json}}"
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: "{{my_headers | from_json}}"
reportId: string
register: result
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
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"
}
"""
|
