cisco.dnac.reports_view_group_view_info – Information module for Reports View Group View

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

New in version 3.1.0: of cisco.dnac

Synopsis

  • Get Reports View Group View 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.
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 path parameter. ViewGroupId of viewgroup.
viewId
string
ViewId path parameter. View id of view.

Notes

Note

  • Supports check_mode

See Also

See also

Reports View Group View reference

Complete reference of the Reports View Group View object model.

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:
      custom: value
    viewGroupId: string
    viewId: 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:
{ "deliveries": [ { "type": "string", "default": true } ], "description": "string", "fieldGroups": [ { "fieldGroupDisplayName": "string", "fieldGroupName": "string", "fields": [ { "displayName": "string", "name": "string" } ], "tableId": "string" } ], "filters": [ { "additionalInfo": {}, "cacheFilter": true, "dataType": "string", "displayName": "string", "filterSource": { "dataSource": {}, "displayValuePath": "string", "rootPath": "string", "valuePath": "string" }, "name": "string", "required": true, "timeOptions": [ { "info": "string", "maxValue": 0, "minValue": 0, "name": "string", "value": "string" } ], "type": "string" } ], "formats": [ { "format": "string", "name": "string", "default": true, "template": { "jsTemplateId": "string" } } ], "schedules": [ { "type": "string", "default": true } ], "viewId": "string", "viewInfo": "string", "viewName": "string" }


Authors

  • Rafael Campos (@racampos)