cisco.dnac.reports – Resource module for Reports
Note
This plugin is part of the cisco.dnac collection (version 4.1.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
To use it in a playbook, specify: cisco.dnac.reports.
New in version 3.1.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 >= 2.4.0
python >= 3.5
Parameters
Notes
Note
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
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: