cisco.dnac.reports_info (6.13.3) — module

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 all Reports.

Get Reports by id.

Get list of scheduled report configurations.

Get scheduled report configuration by reportId.

Requirements

• dnacentersdk >= 2.6.0
• python >= 3.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
viewId:
    description:
    - ViewId query parameter. ViewId of view for report.
    type: str

headers:
    description: Additional headers.
    type: dict

reportId:
    description:
    - ReportId path parameter. ReportId of report.
    type: str

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

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  \"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      \"default\"\
    : true\n    },\n    \"name\": \"string\",\n    \"viewId\": \"string\",\n    \"\
    description\": \"string\",\n    \"viewInfo\": \"string\"\n  },\n  \"viewGroupId\"\
    : \"string\",\n  \"viewGroupVersion\": \"string\"\n}\n"
  type: dict

See also

• Cisco DNA Center documentation for Reports GetAScheduledReport: Complete reference of the GetAScheduledReport API. link
• Cisco DNA Center documentation for Reports GetListOfScheduledReports: Complete reference of the GetListOfScheduledReports API. link