cisco.dnac.reports 模块 – 报表的资源模块

注意

此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。 它不包含在 ansible-core 中。 要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install cisco.dnac。 您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定： cisco.dnac.reports。

cisco.dnac 3.1.0 中的新增功能

概要

• 此模块表示模块 reports_v1 的别名

注意

此模块具有相应的 操作插件。

要求

执行此模块的主机需要满足以下要求。

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
dataCategory 字符串	报表的视图组类别。
deliveries 列表 / 元素=字典	可用交付渠道的数组。
dnac_debug 布尔值	用于 Cisco DNA Center SDK 启用调试的标志。 选项 false ← （默认） true
dnac_host 字符串 / 必填	Cisco DNA Center 主机名。
dnac_password 字符串	用于身份验证的 Cisco DNA Center 密码。
dnac_port 整数	Cisco DNA Center 端口。 默认值： 443
dnac_username 别名：user 字符串	用于身份验证的 Cisco DNA Center 用户名。 默认值： "admin"
dnac_verify 布尔值	用于启用或禁用 SSL 证书验证的标志。 选项 false true ← （默认）
dnac_version 字符串	通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： "2.3.7.6"
name 字符串	报表名称。
reportId 字符串	ReportId 路径参数。报表的 ReportId。
schedule 字典	报表的计划。
tags 列表 / 元素=字符串	报表的标签数组。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求主体的标志。 选项 false true ← （默认）
view 字典	报表的视图。
fieldGroups 列表 / 元素=字典	报表的 fieldGroups。
fieldGroupDisplayName 字符串	用户的字段组标签/显示名称。
fieldGroupName 字符串	字段组名称。
fields 列表 / 元素=字典	报表的字段。
displayName 字符串	字段标签/显示名称。
name 字符串	字段名称。
filters 列表 / 元素=字典	报表的过滤器。
displayName 字符串	过滤器标签/显示名称。
name 字符串	过滤器名称。
type 字符串	过滤器类型。
value 字典	过滤器值。 数据类型基于过滤器类型。 使用视图中的过滤器定义来获取过滤器的选项。
format 字典	报表的格式。
formatType 字符串	报表的格式类型。
name 字符串	报表的格式名称。
name 字符串	视图名称。
viewId 字符串	视图 ID。
viewGroupId 字符串	报表的视图组的 ViewGroupId。
viewGroupVersion 字符串	报表的视图组版本。

注释

注意

• 使用的 SDK 方法是 reports.Reports.create_or_schedule_a_report_v1、reports.Reports.delete_a_scheduled_report_v1，

• 使用的路径是 post /dna/intent/api/v1/data/reports、delete /dna/intent/api/v1/data/reports/{reportId}，

• 应该注意的是，此模块是 reports_v1 的别名

• 不支持 check_mode

• 该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

• 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

有关报表 CreateOrScheduleAReportV1 的 Cisco DNA Center 文档

CreateOrScheduleAReportV1 API 的完整参考。

有关报表 DeleteAScheduledReportV1 的 Cisco DNA Center 文档

DeleteAScheduledReportV1 API 的完整参考。

示例

- 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
    dataCategory: string
    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

返回值

通用返回值记录在此处 此处，以下是此模块独有的字段

键

描述

dnac_response 字典

一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应 已返回： 始终 示例: {"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": {}, "tags": ["string"], "view": {"description": "string", "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", "viewInfo": "string"}, "viewGroupId": "string", "viewGroupVersion": "string"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 存储库 (源代码)