cisco.dnac.reports – Resource module for Reports

Note

This plugin is part of the cisco.dnac collection (version 3.1.1).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.reports.

New in version 1.0.0: of cisco.dnac

Synopsis

• Manage operations create and delete of the resource Reports.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter				Choices/Defaults	Comments
deliveries list / elements=string					Array of available delivery channels.
name string					Report name.
reportId string					ReportId path parameter. ReportId of report.
schedule dictionary					Reports's schedule.
tags list / elements=string					Array of tags for report.
view dictionary					Reports's view.
	fieldGroups list / elements=string				Reports's fieldGroups.
		fieldGroupDisplayName string			Field group label/displayname for user.
		fieldGroupName string			Field group name.
		fields list / elements=string			Reports's fields.
			displayName string		Field label/displayname.
			name string		Field name.
	filters list / elements=string				Reports's filters.
		displayName string			Filter label/displayname.
		name string			Filter name.
		type string			Filter type.
		value dictionary			Value of filter. Data type is based on the filter type. Use the filter definitions from the view to fetch the options for a filter.
	format dictionary				Reports's format.
		formatType string			Format type of report.
		name string			Format name of report.
	name string				View name.
	viewId string				View Id.
viewGroupId string					ViewGroupId of the viewgroup for the report.
viewGroupVersion string					Version of viewgroup for the report.

See Also

See also

Reports reference

Complete reference of the Reports object model.

Examples

- name: Create
  cisco.dnac.reports:
    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}}"
    state: present
    deliveries: []
    name: string
    schedule: {}
    tags:
    - string
    view:
      fieldGroups:
      - fieldGroupDisplayName: string
        fieldGroupName: string
        fields:
        - displayName: string
          name: string
      filters:
      - displayName: string
        name: string
        type: string
        value: {}
      format:
        formatType: string
        name: string
      name: string
      viewId: string
    viewGroupId: string
    viewGroupVersion: string

- name: Delete by id
  cisco.dnac.reports:
    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}}"
    state: absent
    reportId: string

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: { "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" }, "name": "string", "viewId": "string", "description": "string", "viewInfo": "string" }, "viewGroupId": "string", "viewGroupVersion": "string" }

Authors

• Rafael Campos (@racampos)