cisco.dnac.reports_view_group_view_info module – Information module for Reports View Group View
Note
This module is part of the cisco.dnac collection (version 6.24.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.reports_view_group_view_info.
New in cisco.dnac 3.1.0
Synopsis
Get Reports View Group View by id.
Gives complete information of the view that is required to configure a report. Use “Get views for a given view group” API to get the viewIds required as a query param for this API for available views.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Additional headers. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
ViewGroupId path parameter. ViewGroupId of viewgroup. |
|
ViewId path parameter. View id of view. |
Notes
Note
SDK Method used are reports.Reports.get_view_details_for_a_given_view_group_and_view,
Paths used are get /dna/intent/api/v1/data/view-groups/{viewGroupId}/views/{viewId},
Supports
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Reports GetViewDetailsForAGivenViewGroup_View
Complete reference of the GetViewDetailsForAGivenViewGroup_View API.
Examples
- name: Get Reports View Group View by id
cisco.dnac.reports_view_group_view_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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |