cisco.dnac.reports_v1 模块 – 报告 V1 资源模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装它，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。
要在剧本中使用它，请指定：cisco.dnac.reports_v1。
cisco.dnac 3.1.0 中的新增功能
概要
管理报告 V1 资源的创建和删除操作。
创建/安排报告配置。使用“获取给定视图组和视图的视图详细信息”API 获取配置报告所需的元数据。
删除已安排的报告配置。也删除报告执行。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
报告的视图组类别。 |
|
可用交付渠道的数组。 |
|
用于 Cisco DNA Center SDK 以启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
报告名称。 |
|
ReportId 路径参数。报告的 ReportId。 |
|
报告的计划。 |
|
报告的标签数组。 |
|
用于 Cisco DNA Center SDK 以启用根据 JSON 模式验证请求正文的标志。 选项
|
|
报告的视图。 |
|
报告的 fieldGroups。 |
|
用户的字段组标签/显示名称。 |
|
字段组名称。 |
|
报告的字段。 |
|
字段标签/显示名称。 |
|
字段名称。 |
|
报告的过滤器。 |
|
过滤器标签/显示名称。 |
|
过滤器名称。 |
|
过滤器类型。 |
|
过滤器的值。数据类型基于过滤器类型。使用视图中的过滤器定义来获取过滤器的选项。 |
|
报告的格式。 |
|
报告的格式类型。 |
|
报告的格式名称。 |
|
视图名称。 |
|
视图 ID。 |
|
报告的视图组的 ViewGroupId。 |
|
报告的视图组的版本。 |
注释
注意
使用的 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}，
不支持
check_mode该插件运行在控制节点上，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
参见
另见
- Cisco DNA Center 文档，关于 Reports CreateOrScheduleAReportV1。
CreateOrScheduleAReportV1 API 的完整参考。
- Cisco DNA Center 文档，关于 Reports DeleteAScheduledReportV1。
DeleteAScheduledReportV1 API 的完整参考。
示例
- name: Create
cisco.dnac.reports_v1:
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_v1:
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
返回值
常见的返回值已在 此处 记录，以下是此模块独有的字段：
键 |
描述 |
|---|---|
Cisco DNAC Python SDK 返回的响应的字典或列表。 返回值：始终返回 示例： |