/ home / cisco / cisco.dnac / 6.13.3 / module / reports_view_group_view_info

cisco.dnac.reports_view_group_view_info (6.13.3) — module

Information module for Reports View Group View

| "added in version" 3.1.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==6.13.3

Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 6.13.3

Description

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.

Requirements

dnacentersdk >= 2.6.0
python >= 3.9

Usage examples

Scanned by Steampunk Spotter

- 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

Inputs

    
viewId:
    description:
    - ViewId path parameter. View id of view.
    type: str

headers:
    description: Additional headers.
    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

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 path parameter. ViewGroupId of viewgroup.
    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

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

Outputs

dnac_response:
  description: A dictionary or list with the response returned by the Cisco DNAC Python
    SDK
  returned: always
  sample: "{\n  \"deliveries\": [\n    {\n      \"type\": \"string\",\n      \"default\"\
    : true\n    }\n  ],\n  \"description\": \"string\",\n  \"fieldGroups\": [\n  \
    \  {\n      \"fieldGroupDisplayName\": \"string\",\n      \"fieldGroupName\":\
    \ \"string\",\n      \"fields\": [\n        {\n          \"displayName\": \"string\"\
    ,\n          \"name\": \"string\"\n        }\n      ],\n      \"tableId\": \"\
    string\"\n    }\n  ],\n  \"filters\": [\n    {\n      \"additionalInfo\": {},\n\
    \      \"cacheFilter\": true,\n      \"dataType\": \"string\",\n      \"displayName\"\
    : \"string\",\n      \"filterSource\": {\n        \"dataSource\": {},\n      \
    \  \"displayValuePath\": \"string\",\n        \"rootPath\": \"string\",\n    \
    \    \"valuePath\": \"string\"\n      },\n      \"name\": \"string\",\n      \"\
    required\": true,\n      \"timeOptions\": [\n        {\n          \"info\": \"\
    string\",\n          \"maxValue\": 0,\n          \"minValue\": 0,\n          \"\
    name\": \"string\",\n          \"value\": \"string\"\n        }\n      ],\n  \
    \    \"type\": \"string\"\n    }\n  ],\n  \"formats\": [\n    {\n      \"format\"\
    : \"string\",\n      \"name\": \"string\",\n      \"default\": true,\n      \"\
    template\": {\n        \"jsTemplateId\": \"string\"\n      }\n    }\n  ],\n  \"\
    schedules\": [\n    {\n      \"type\": \"string\",\n      \"default\": true\n\
    \    }\n  ],\n  \"viewId\": \"string\",\n  \"viewInfo\": \"string\",\n  \"viewName\"\
    : \"string\"\n}\n"
  type: dict