.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.reports_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.reports -- Resource module for Reports +++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 3.0.0). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.reports`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create and delete of the resource Reports. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
deliveries
list / elements=dictionary
Reports's deliveries.
name
string
Reports's name.
reportId
string
ReportId path parameter. ReportId of report.
schedule
dictionary
Reports's schedule.
tags
list / elements=string
Reports's tags.
view
dictionary
Reports's view.
fieldGroups
list / elements=string
Reports's fieldGroups.
fieldGroupDisplayName
string
Reports's fieldGroupDisplayName.
fieldGroupName
string
Reports's fieldGroupName.
fields
list / elements=string
Reports's fields.
displayName
string
Reports's displayName.
name
string
Reports's name.
filters
list / elements=string
Reports's filters.
displayName
string
Reports's displayName.
name
string
Reports's name.
type
string
Reports's type.
value
dictionary
Reports's value.
format
dictionary
Reports's format.
formatType
string
Reports's formatType.
name
string
Reports's name.
name
string
Reports's name.
viewId
string
Reports's viewId.
viewGroupId
string
Reports's viewGroupId.
viewGroupVersion
string
Reports's viewGroupVersion.

.. Notes .. Seealso See Also -------- .. seealso:: `Reports reference `_ Complete reference of the Reports object model. .. Examples Examples -------- .. code-block:: yaml+jinja - 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 - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html
Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

Sample:
{ "message": "string", "status": 0 }


.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors