.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.reports_workflow_manager_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.reports_workflow_manager module -- Resource module for managing Reports in Cisco Catalyst Center. ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.46.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.reports_workflow_manager`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.41.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module manages Report configurations in Cisco Catalyst Center. - It allows you to create and schedule customized reports across wired and wireless network entities. - Supports configuration of report name, scheduling, entity selection, filters, field groups, and output format options. - Enables scheduling with immediate, later, or recurring execution patterns. - Provides delivery methods including local download, email notification, and webhook integration. - Reports help monitor network and client health, device behavior, compliance status, and utilization trends. - Applicable from Cisco Catalyst Center version 2.3.7.9 and later. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.reports_workflow_manager_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.8.6 - python \>= 3.9 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config: .. rst-class:: ansible-option-title **config** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
A list of configuration settings for generating reports in Cisco Catalyst Center. Each configuration defines report metadata, scheduling, delivery options, view selections, format, and applicable filters. Supports creating, scheduling, and downloading customized network reports across various data categories. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report: .. rst-class:: ansible-option-title **generate_report** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
List of report configurations to be created or scheduled. Each entry represents a single report with its complete configuration. Reports are processed sequentially, not in parallel, which ensures data consistency. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries: .. rst-class:: ansible-option-title **deliveries** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Specifies how the generated report should be delivered. Must be a list containing exactly one delivery configuration. Supports three delivery methods DOWNLOAD, NOTIFICATION (email), and WEBHOOK. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries/delivery_type: .. rst-class:: ansible-option-title **delivery_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Delivery type for the report. \ :literal:`DOWNLOAD`\ saves report to local file system. \ :literal:`NOTIFICATION`\ sends report via email notification. \ :literal:`WEBHOOK`\ triggers a configured webhook endpoint. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"DOWNLOAD"` - :ansible-option-choices-entry:`"NOTIFICATION"` - :ansible-option-choices-entry:`"WEBHOOK"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries/email_attach: .. rst-class:: ansible-option-title **email_attach** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether the report should be attached in the notification email. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries/file_path: .. rst-class:: ansible-option-title **file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Local file system path where the report should be downloaded. Required only when delivery\_type is \ :literal:`DOWNLOAD`\ . Must be a valid directory path where the user has write permissions. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries/notification_endpoints: .. rst-class:: ansible-option-title **notification_endpoints** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Required when delivery\_type is \ :literal:`NOTIFICATION`\ . Must be a list containing exactly one email endpoint configuration. Specifies email recipients and notification preferences. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries/notification_endpoints/email_addresses: .. rst-class:: ansible-option-title **email_addresses** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of email recipients for the notification. Required when delivery\_type is \ :literal:`NOTIFICATION`\ . Each email address must be in valid email format. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries/notify: .. rst-class:: ansible-option-title **notify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of report execution statuses that will trigger a notification. If not specified, notifications are sent for all statuses. \ :literal:`IN\_QUEUE`\ notifies when report is queued for execution. \ :literal:`IN\_PROGRESS`\ notifies when report execution starts. \ :literal:`COMPLETED`\ notifies when report execution finishes. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"IN\_QUEUE"` - :ansible-option-choices-entry:`"IN\_PROGRESS"` - :ansible-option-choices-entry:`"COMPLETED"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/deliveries/webhook_name: .. rst-class:: ansible-option-title **webhook_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the webhook to be triggered for the report. Required when delivery\_type is \ :literal:`WEBHOOK`\ . Must reference an existing webhook configured in Catalyst Center. The webhook will be called when the report is generated. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of the report to be generated. Must be unique within the Catalyst Center instance. If not provided, it will be automatically generated using the format "\ - \ - \". Example auto-generated name "Network - DeviceView - Jul 20 2025 08:26 PM". .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/new_report: .. rst-class:: ansible-option-title **new_report** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Specifies whether to create a new report when a report with the same name already exists. If set to \ :literal:`True`\ and a report with the same name is found, a new report is created with a unique timestamp suffix appended to its name. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule: .. rst-class:: ansible-option-title **schedule** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Defines when the report should be executed (immediately, later, or on a recurring basis). Controls the timing and frequency of report generation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/date_time: .. rst-class:: ansible-option-title **date_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Scheduled time for report execution. Required if schedule\_type is \ :literal:`SCHEDULE\_LATER`\ or \ :literal:`SCHEDULE\_RECURRENCE`\ . Must be in 'YYYY-MM-DD HH:MM AM/PM' format. Example "2025-09-02 07:30 PM". Only future dates are allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/recurrence: .. rst-class:: ansible-option-title **recurrence** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Recurrence settings for scheduled reports. Required only when schedule\_type is \ :literal:`SCHEDULE\_RECURRENCE`\ . Defines the pattern and frequency of recurring executions. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/recurrence/day_of_month: .. rst-class:: ansible-option-title **day_of_month** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specific day of the month to run the report. Only applicable for \ :literal:`MONTHLY`\ recurrence\_type when last\_day\_of\_month is false. Must be an integer between 1 and 31. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/recurrence/days: .. rst-class:: ansible-option-title **days** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of days for weekly recurrence. Required for \ :literal:`WEEKLY`\ recurrence\_type. Can specify individual days or use \ :literal:`DAILY`\ for all seven days. Must include all 7 days for daily execution or DAILY. ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"] or ["DAILY"]. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/recurrence/last_day_of_month: .. rst-class:: ansible-option-title **last_day_of_month** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether to run on the last day of the month. Only applicable for \ :literal:`MONTHLY`\ recurrence\_type. When true, ignores day\_of\_month setting. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/recurrence/recurrence_type: .. rst-class:: ansible-option-title **recurrence_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of recurrence pattern. \ :literal:`WEEKLY`\ for daily execution via weekly pattern with all 7 days. \ :literal:`MONTHLY`\ for monthly execution on specific day or last day. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"WEEKLY"` - :ansible-option-choices-entry:`"MONTHLY"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/schedule_type: .. rst-class:: ansible-option-title **schedule_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The scheduling type for the report execution. \ :literal:`SCHEDULE\_NOW`\ executes immediately, \ :literal:`SCHEDULE\_LATER`\ executes at a specific time, \ :literal:`SCHEDULE\_RECURRENCE`\ executes repeatedly. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"SCHEDULE\_NOW"` - :ansible-option-choices-entry:`"SCHEDULE\_LATER"` - :ansible-option-choices-entry:`"SCHEDULE\_RECURRENCE"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/start_date: .. rst-class:: ansible-option-title **start_date** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Epoch start date in milliseconds for recurring schedules. Automatically generated from date\_time during processing. Used internally by the API to determine recurrence start point. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/time: .. rst-class:: ansible-option-title **time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Epoch time in milliseconds for scheduled execution. Automatically generated from date\_time during processing. Used internally by the API for recurring schedules. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/schedule/time_zone: .. rst-class:: ansible-option-title **time_zone** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Time zone identifier for the schedule. Uses standard time zone identifiers like \ :literal:`Asia/Calcutta`\ , \ :literal:`America/New\_York`\ , etc. For a complete list of supported time zones, please refer to the time\_zone field in the Inventory Workflow Manager documentation https://galaxy.ansible.com/ui/repo/published/cisco/dnac/content/module/inventory\_workflow\_manager. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/tags: .. rst-class:: ansible-option-title **tags** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Optional list of tags to filter reports. Tags help categorize and organize reports for easier management. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view: .. rst-class:: ansible-option-title **view** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Contains view details such as view selection, field groups, filters, and output format for the report. Defines what data to include and how to present it in the final report. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/field_groups: .. rst-class:: ansible-option-title **field_groups** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Groups of fields to include in the report, as defined in the selected view. Can be empty list to include all available fields for the view. Field group availability depends on the selected view\_name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/field_groups/field_group_display_name: .. rst-class:: ansible-option-title **field_group_display_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The display name shown in the UI for the field group. Optional but recommended for readability. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/field_groups/field_group_name: .. rst-class:: ansible-option-title **field_group_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The internal name of the field group as defined in the view metadata. Must match exactly with the available field\_groups for the selected view. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/field_groups/fields: .. rst-class:: ansible-option-title **fields** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of specific fields to include within the field group. Can be empty list to include all fields in the group. Field availability depends on the selected field group. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/field_groups/fields/display_name: .. rst-class:: ansible-option-title **display_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Optional UI-friendly display label for the field. Used only for readability; API uses \`name\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/field_groups/fields/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Field identifier as defined in the view metadata. Must match exactly with available fields in the group. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/filters: .. rst-class:: ansible-option-title **filters** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Filters to be applied to narrow down the report data. Optional parameter to refine report content based on specific criteria. Filter availability depends on the selected view\_name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/filters/display_name: .. rst-class:: ansible-option-title **display_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Human-readable name of the filter shown in the UI. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/filters/filter_type: .. rst-class:: ansible-option-title **filter_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the filter determining how values are selected. \ :literal:`MULTI\_SELECT`\ allows multiple discrete values. \ :literal:`MULTI\_SELECT\_TREE`\ allows hierarchical multi-selection. \ :literal:`SINGLE\_SELECT\_ARRAY`\ allows single value from array. \ :literal:`TIME\_RANGE`\ allows date/time range specification. \ :literal:`REGULAR`\ allows exact match filtering with single values for specific field types. Used primarily for Port Reclaim View filters like hostname and family. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"MULTI\_SELECT"` - :ansible-option-choices-entry:`"MULTI\_SELECT\_TREE"` - :ansible-option-choices-entry:`"SINGLE\_SELECT\_ARRAY"` - :ansible-option-choices-entry:`"TIME\_RANGE"` - :ansible-option-choices-entry:`"REGULAR"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/filters/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the filter as defined in the view metadata. Common filters include Location, Time Range, Device Type, etc. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/filters/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Value(s) to apply in the filter based on filter\_type. For \ :literal:`TIME\_RANGE`\ , this is a dict with time\_range\_option, start\_date\_time, end\_date\_time, and time\_zone. For other types, this is a list of dicts with \ :literal:`value`\ and \ :literal:`display\_value`\ keys. Location filters are automatically resolved to site hierarchy IDs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/filters/value/display_value: .. rst-class:: ansible-option-title **display_value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Human-readable value (e.g., "Switches" or "Global/India") .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/filters/value/value: .. rst-class:: ansible-option-title **value** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
API-compatible internal value (e.g., DeviceFamily = SWITCHES) .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/format: .. rst-class:: ansible-option-title **format** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Specifies the output format of the report. Determines how the report data will be structured and presented. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/format/format_type: .. rst-class:: ansible-option-title **format_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Type of format to be used for the report output. \ :literal:`CSV`\ for comma-separated values \ :literal:`PDF`\ for document format \ :literal:`JSON`\ for structured data \ :literal:`TDE`\ for Tableau data extract. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"CSV"` - :ansible-option-choices-entry:`"PDF"` - :ansible-option-choices-entry:`"JSON"` - :ansible-option-choices-entry:`"TDE"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view/view_name: .. rst-class:: ansible-option-title **view_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The view name from which \ :literal:`viewId`\ is derived via API calls. Must match exactly with available views in the specified view group. Determines the specific data subset and available fields for the report. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Network Device Compliance"` - :ansible-option-choices-entry:`"Network Device Availability"` - :ansible-option-choices-entry:`"Channel Change Count"` - :ansible-option-choices-entry:`"Transmit Power Change Count"` - :ansible-option-choices-entry:`"VLAN"` - :ansible-option-choices-entry:`"Port Capacity"` - :ansible-option-choices-entry:`"Energy Management"` - :ansible-option-choices-entry:`"PoE"` - :ansible-option-choices-entry:`"Device CPU and Memory Utilization"` - :ansible-option-choices-entry:`"Network Interface Utilization"` - :ansible-option-choices-entry:`"Executive Summary"` - :ansible-option-choices-entry:`"All Data"` - :ansible-option-choices-entry:`"Port Reclaim View"` - :ansible-option-choices-entry:`"All Data Version 2.0"` - :ansible-option-choices-entry:`"All Data"` - :ansible-option-choices-entry:`"All Data Version 2.0"` - :ansible-option-choices-entry:`"AP"` - :ansible-option-choices-entry:`"AP Radio"` - :ansible-option-choices-entry:`"AP - Usage and Client Breakdown"` - :ansible-option-choices-entry:`"Worst Interferers"` - :ansible-option-choices-entry:`"AP RRM Events"` - :ansible-option-choices-entry:`"AP Performance Report"` - :ansible-option-choices-entry:`"Long Term AP Detail"` - :ansible-option-choices-entry:`"Long Term AP Radio"` - :ansible-option-choices-entry:`"Long Term AP Usage and Client Breakdown"` - :ansible-option-choices-entry:`"Long Term Client Detail"` - :ansible-option-choices-entry:`"Long Term Client Session"` - :ansible-option-choices-entry:`"Long Term Network Device Availability"` - :ansible-option-choices-entry:`"Security Group to Security Group"` - :ansible-option-choices-entry:`"Security Group to ISE Endpoint Profile Group"` - :ansible-option-choices-entry:`"Security Group to Host Group"` - :ansible-option-choices-entry:`"ISE Endpoint Profile Group to Security Group"` - :ansible-option-choices-entry:`"ISE Endpoint Profile Group to ISE Endpoint Profile Group"` - :ansible-option-choices-entry:`"ISE Endpoint Profile Group to Host Group"` - :ansible-option-choices-entry:`"Host Group to Security Group"` - :ansible-option-choices-entry:`"Host Group to ISE Endpoint Profile Group"` - :ansible-option-choices-entry:`"Host Group to Host Group"` - :ansible-option-choices-entry:`"Device Lifecycle Information"` - :ansible-option-choices-entry:`"Security Group to Security Groups"` - :ansible-option-choices-entry:`"Security Group to ISE Endpoint Profile Groups"` - :ansible-option-choices-entry:`"Security Group to Host Groups"` - :ansible-option-choices-entry:`"ISE Endpoint Profile Group to Security Groups"` - :ansible-option-choices-entry:`"ISE Endpoint Profile Group to ISE Endpoint Profile Groups"` - :ansible-option-choices-entry:`"ISE Endpoint Profile Group to Host Groups"` - :ansible-option-choices-entry:`"Host Group to Security Groups"` - :ansible-option-choices-entry:`"Host Group to ISE Endpoint Profile Group"` - :ansible-option-choices-entry:`"Host Group to Host Group"` - :ansible-option-choices-entry:`"EoX Data"` - :ansible-option-choices-entry:`"Threat Detail"` - :ansible-option-choices-entry:`"New Threat"` - :ansible-option-choices-entry:`"Rogue Additional Detail"` - :ansible-option-choices-entry:`"Non Compliant Devices"` - :ansible-option-choices-entry:`"Non Compliance Summary"` - :ansible-option-choices-entry:`"AireOS Controllers Licenses"` - :ansible-option-choices-entry:`"License Usage Upload Details"` - :ansible-option-choices-entry:`"License Historical Usage"` - :ansible-option-choices-entry:`"Endpoint Profiling"` - :ansible-option-choices-entry:`"Audit Log"` - :ansible-option-choices-entry:`"Configuration Archive"` - :ansible-option-choices-entry:`"Client Summary"` - :ansible-option-choices-entry:`"Top N Summary"` - :ansible-option-choices-entry:`"Client Detail"` - :ansible-option-choices-entry:`"Client Trend"` - :ansible-option-choices-entry:`"Client Session"` - :ansible-option-choices-entry:`"Busiest Client"` - :ansible-option-choices-entry:`"Unique Clients and Users Summary"` - :ansible-option-choices-entry:`"Security Advisories Data"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view_group_name: .. rst-class:: ansible-option-title **view_group_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The name of the view group as defined in Catalyst Center. For example, \ :literal:`Inventory`\ Used to identify the viewGroupId via API calls. Determines the category of data included in the report. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"Compliance"` - :ansible-option-choices-entry:`"Executive Summary"` - :ansible-option-choices-entry:`"Inventory"` - :ansible-option-choices-entry:`"SWIM"` - :ansible-option-choices-entry:`"Access Point"` - :ansible-option-choices-entry:`"Long Term"` - :ansible-option-choices-entry:`"Network Devices"` - :ansible-option-choices-entry:`"Group Pair Communication Analytics"` - :ansible-option-choices-entry:`"Telemetry"` - :ansible-option-choices-entry:`"Group Communication Summary"` - :ansible-option-choices-entry:`"EoX"` - :ansible-option-choices-entry:`"Rogue and aWIPS"` - :ansible-option-choices-entry:`"Licensing"` - :ansible-option-choices-entry:`"AI Endpoint Analytics"` - :ansible-option-choices-entry:`"Audit Log"` - :ansible-option-choices-entry:`"Configuration Archive"` - :ansible-option-choices-entry:`"Client"` - :ansible-option-choices-entry:`"Security Advisories"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config/generate_report/view_group_version: .. rst-class:: ansible-option-title **view_group_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The version of the view group to be used for the report. Defaults to \ :literal:`2.0.0`\ if not specified. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-config_verify: .. rst-class:: ansible-option-title **config_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Set to \ :literal:`True`\ to enable configuration verification on Cisco Catalyst Center after applying the playbook config. This will ensure that the system validates the configuration state after the change is applied. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_api_task_timeout: .. rst-class:: ansible-option-title **dnac_api_task_timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Defines the timeout in seconds for API calls to retrieve task details. If the task details are not received within this period, the process will end, and a timeout notification will be logged. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`1200` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The hostname of the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_log: .. rst-class:: ansible-option-title **dnac_log** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable/disable playbook execution logging. When true and dnac\_log\_file\_path is provided, - Create the log file at the execution location with the specified name. When true and dnac\_log\_file\_path is not provided, - Create the log file at the execution location with the name 'dnac.log'. When false, - Logging is disabled. If the log file doesn't exist, - It is created in append or write mode based on the "dnac\_log\_append" flag. If the log file exists, - It is overwritten or appended based on the "dnac\_log\_append" flag. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_log_append: .. rst-class:: ansible-option-title **dnac_log_append** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_log_file_path: .. rst-class:: ansible-option-title **dnac_log_file_path** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Governs logging. Logs are recorded if dnac\_log is True. If path is not specified, - When 'dnac\_log\_append' is True, 'dnac.log' is generated in the current Ansible directory; logs are appended. - When 'dnac\_log\_append' is False, 'dnac.log' is generated; logs are overwritten. If path is specified, - When 'dnac\_log\_append' is True, the file opens in append mode. - When 'dnac\_log\_append' is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"dnac.log"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_log_level: .. rst-class:: ansible-option-title **dnac_log_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"WARNING"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The password for authentication at the Cisco Catalyst Center. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the port number associated with the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"443"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_task_poll_interval: .. rst-class:: ansible-option-title **dnac_task_poll_interval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Specifies the interval in seconds between successive calls to the API to retrieve task details. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`2` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The username for authentication at the Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the version of the Cisco Catalyst Center that the SDK should use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.2.3.3"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Specifies the desired state for the configuration. If \ :literal:`merged`\ , the module will create or schedule new reports. If \ :literal:`deleted`\ , the module will remove existing scheduled reports. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"merged"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"deleted"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Methods used are reports.Reports.get\_all\_view\_groups reports.Reports.get\_views\_for\_a\_given\_view\_group reports.Reports.get\_view\_details\_for\_a\_given\_view\_group\_and\_view reports.Reports.create\_or\_schedule\_a\_report reports.Reports.delete\_a\_scheduled\_report reports.Reports.download\_report\_content reports.Reports.get\_execution\_id\_by\_report\_id - Paths used are GET /dna/intent/api/v1/data/view-groups GET /dna/intent/api/v1/data/view-groups/{viewGroupId} GET /dna/intent/api/v1/data/view-groups/{viewGroupId}/views/{viewId} POST /dna/intent/api/v1/data/reports DELETE /dna/intent/api/v1/data/reports/{reportId} GET /dna/intent/api/v1/data/reports/{reportId}/executions/{executionId} - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK - The parameters starting with dnac\_ are used by the Cisco Catalyst Center Python SDK to establish the connection .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create/Schedule a Sample Inventory Report and Download It cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log_level: DEBUG dnac_log: true state: merged config_verify: true config: - generate_report: - name: "Sample Inventory report" view_group_name: "Inventory" view_group_version: "2.0.0" view: view_name: "All Data" format: format_type: "CSV" field_groups: - field_group_name: "inventoryAllData" field_group_display_name: "All Data" fields: - name: "type" display_name: "Device Type" - name: "hostname" display_name: "Device Name" - name: "ipAddress" display_name: "IP Address" filters: - name: "Location" filter_type: "MULTI_SELECT_TREE" value: [] - name: "DeviceFamily" filter_type: "MULTI_SELECT" value: [] - name: "DeviceType" filter_type: "MULTI_SELECT" value: [] - name: "SoftwareVersion" filter_type: "MULTI_SELECT" value: [] schedule: schedule_type: "SCHEDULE_NOW" time_zone: "Asia/Calcutta" deliveries: - delivery_type: "DOWNLOAD" file_path: "/Users/xyz/Desktop" - name: Create/Schedule a compliance report with immediate execution cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log_level: DEBUG dnac_log: true state: merged config_verify: true config: - generate_report: - name: "compliance_report" view_group_name: "Compliance" deliveries: - delivery_type: "DOWNLOAD" file_path: "/Users/xyz/Desktop" schedule: schedule_type: "SCHEDULE_NOW" time_zone: "Asia/Calcutta" view: view_name: "Network Device Compliance" field_groups: - field_group_name: "Compliance" field_group_display_name: "Compliance" fields: - name: "deviceName" display_name: "Device Name" format: format_type: "CSV" filters: [] tags: ["network", "compliance"] - name: Create/Schedule an access point report with location filter cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log_level: DEBUG dnac_log: true state: merged config_verify: true config: - generate_report: - name: "Access_point_report1" view_group_name: "Access Point" deliveries: - delivery_type: "DOWNLOAD" file_path: "/Users/xyz/Desktop" schedule: schedule_type: "SCHEDULE_NOW" time_zone: "Asia/Calcutta" view: view_name: "AP" field_groups: [] format: format_type: "JSON" filters: - name: "Location" display_name: "Location" filter_type: "MULTI_SELECT_TREE" value: - value: "Global/India" display_value: "Global/India" - name: Schedule a report for later execution cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log: true state: merged config_verify: true config: - generate_report: - name: "scheduled_inventory_report" view_group_name: "Inventory" tags: ["inventory", "scheduled"] deliveries: - delivery_type: "NOTIFICATION" notification_endpoints: - email_addresses: - "admin@company.com" - "reports@company.com" email_attach: true notify: ["COMPLETED"] schedule: schedule_type: "SCHEDULE_LATER" date_time: "2025-12-25 09:00 AM" time_zone: "America/New_York" view: view_name: "All Data" field_groups: [] format: format_type: "PDF" filters: [] - name: Create recurring weekly report with webhook delivery cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log: true state: merged config_verify: true config: - generate_report: - name: "weekly_device_report" view_group_name: "Network Devices" tags: ["weekly", "devices"] deliveries: - delivery_type: "WEBHOOK" webhook_name: "report_webhook" schedule: schedule_type: "SCHEDULE_RECURRENCE" date_time: "2025-09-15 08:00 AM" time_zone: "UTC" recurrence: recurrence_type: "WEEKLY" days: ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"] view: view_name: "Network Device Availability" field_groups: - field_group_name: "deviceInfo" field_group_display_name: "Device Information" fields: - name: "hostname" display_name: "host name" format: format_type: "CSV" filters: - name: "Location" filter_type: "MULTI_SELECT_TREE" value: - value: "Global/US/California" display_value: "Global/US/California" - name: Create monthly report with time range filter cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log: true state: merged config_verify: true config: - generate_report: - name: "monthly_client_report" view_group_name: "Client" tags: ["monthly", "clients"] deliveries: - delivery_type: "DOWNLOAD" file_path: "/home/reports/monthly" schedule: schedule_type: "SCHEDULE_RECURRENCE" date_time: "2025-09-01 06:00 AM" time_zone: "Asia/Calcutta" recurrence: recurrence_type: "MONTHLY" last_day_of_month: true view: view_name: "Client Detail" field_groups: [] format: format_type: "JSON" filters: - name: "Time Range" filter_type: "TIME_RANGE" value: time_range_option: "LAST_30_DAYS" - name: Create monthly report with time range CUSTOM filter cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log: true state: merged config_verify: true config: - generate_report: - name: "monthly_client_report" new_report: false view_group_name: "Client" tags: ["monthly", "clients"] deliveries: - delivery_type: "DOWNLOAD" file_path: "/home/reports/monthly" schedule: schedule_type: "SCHEDULE_RECURRENCE" date_time: "2025-09-01 06:00 AM" time_zone: "Asia/Calcutta" recurrence: recurrence_type: "MONTHLY" last_day_of_month: true view: view_name: "Client Detail" field_groups: [] format: format_type: "JSON" filters: - name: "Time Range" filter_type: "TIME_RANGE" value: time_range_option: "CUSTOM" start_date_time: "2025-10-09 07:30 PM" end_date_time: "2025-10-31 11:59 PM" time_zone: "Asia/Calcutta" - name: Delete a report from Catalyst Center cisco.dnac.reports_workflow_manager: dnac_host: "{{ dnac_host }}" dnac_port: "{{ dnac_port }}" dnac_username: "{{ dnac_username }}" dnac_password: "{{ dnac_password }}" dnac_verify: "{{ dnac_verify }}" dnac_version: "{{ dnac_version }}" dnac_debug: "{{ dnac_debug }}" dnac_log: true state: deleted config_verify: true config: - generate_report: - name: "compliance_report" # The name of the report to be deleted is required view_group_name: "Compliance" # Required for identification view: view_name: "Network Device Compliance" # Required for identification .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_create_or_schedule_a_report: .. rst-class:: ansible-option-title **response_create_or_schedule_a_report** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned after successfully creating or scheduling a report in Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when state is merged and report creation succeeds .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": [{"create\_report": {"msg": "Successfully created or scheduled report 'compliance\_report'.", "response": {"report\_id": "1234567890abcdef12345678", "report\_name": "compliance\_report", "view\_group\_id": "network-device-compliance", "view\_group\_name": "Compliance", "view\_id": "compliance-view-id", "view\_name": "Network Device Compliance"}}}]}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_delete_a_scheduled_report: .. rst-class:: ansible-option-title **response_delete_a_scheduled_report** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned after successfully deleting a scheduled report from Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when state is deleted and report deletion succeeds .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": [{"delete\_report": {"msg": "Report 'compliance\_report' has been successfully deleted.", "response": {"report\_id": "1234567890abcdef12345678", "report\_name": "compliance\_report"}}}]}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_download_report_content: .. rst-class:: ansible-option-title **response_download_report_content** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned after successfully downloading report content to the specified local file path. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when delivery\_type is DOWNLOAD and download succeeds .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": [{"download\_report": {"msg": "Successfully downloaded report 'compliance\_report' to '/Users/xyz/Desktop'.", "response": {"file\_path": "/Users/xyz/Desktop", "report\_id": "1234567890abcdef12345678", "report\_name": "compliance\_report"}}}]}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_error: .. rst-class:: ansible-option-title **response_error** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned when an error occurs during report operations. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when an error occurs during execution .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"changed": false, "failed": true, "msg": "Failed to create report: Invalid view\_group\_name 'InvalidGroup'.", "response": []}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_existing_report: .. rst-class:: ansible-option-title **response_existing_report** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned when a report with the same name already exists in Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when state is merged and report already exists .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"changed": false, "msg": "No changes required - report already exists.", "response": [{"create\_report": {"msg": "Report 'compliance\_report' already exists.", "response": {"report\_id": "existing1234567890abcdef", "report\_name": "compliance\_report", "view\_group\_id": "network-device-compliance", "view\_group\_name": "Compliance", "view\_id": "compliance-view-id", "view\_name": "Network Device Compliance"}}}]}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_multiple_reports: .. rst-class:: ansible-option-title **response_multiple_reports** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned when processing multiple reports in a single playbook execution. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when config contains multiple report configurations .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"changed": true, "msg": "Multiple report operations completed successfully.", "response": [{"create\_report": {"msg": "Successfully created or scheduled report 'compliance\_report'.", "response": {"reportId": "report1-id", "viewGroupId": "compliance", "viewsId": "compliance-view"}}}, {"download\_report": {"msg": "Successfully downloaded report 'compliance\_report' to '/Users/xyz/Desktop'.", "response": {"filePath": "/Users/xyz/Desktop", "reportId": "report1-id", "reportName": "compliance\_report"}}}, {"create\_report": {"msg": "Successfully created or scheduled report 'inventory\_report'.", "response": {"reportId": "report2-id", "viewGroupId": "inventory", "viewsId": "inventory-view"}}}]}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_report_not_found: .. rst-class:: ansible-option-title **response_report_not_found** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned when attempting to delete a report that does not exist in Cisco Catalyst Center. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when state is deleted and report does not exist .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"changed": false, "msg": "No changes required - report does not exist.", "response": [{"delete\_report": {"msg": "Report 'nonexistent\_report' does not exist.", "response": {}}}]}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.reports_workflow_manager_module__return-response_verification_success: .. rst-class:: ansible-option-title **response_verification_success** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Response returned after successful verification of report operations when config\_verify is enabled. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` when config\_verify is true and verification succeeds .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"changed": true, "msg": "Report operations completed and verified successfully.", "response": [{"create\_report": {"Validation": "Success", "msg": "Successfully created or scheduled report 'compliance\_report'.", "response": {"reportId": "1234567890abcdef12345678", "viewGroupId": "network-device-compliance", "viewsId": "compliance-view-id"}}}]}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Megha Kandari (@kandarimegha) - Madhan Sankaranarayanan (@madhansansel) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors