cisco.dnac.flexible_report_content_v1_info 模块 – 灵活报表内容 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您正在使用 ansible
包,则可能已安装此集合。它不包含在 ansible-core
中。要检查是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,有关详细信息,请参阅 要求。
要在 playbook 中使用它,请指定:cisco.dnac.flexible_report_content_v1_info
。
cisco.dnac 6.14.0 中的新增功能
概要
通过 ID 获取灵活报表内容 V1。
这用于下载灵活报表。API 返回报表内容。通过将响应数据转换为 Blob 并设置从 content-disposition 响应标头获得的文件格式,将响应保存到文件。
注意
此模块具有相应的 action 插件。
要求
在执行此模块的主机上需要以下要求。
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。 默认值: |
|
ExecutionId 路径参数。执行的 ID。 |
|
附加标头。 |
|
ReportId 路径参数。报表的 ID。 |
|
用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 架构验证请求正文。 选项
|
注释
注意
使用的 SDK 方法是 reports.Reports.download_flexible_report_v1。
使用的路径是 get /dna/data/api/v1/flexible-report/report/content/{reportId}/{executionId}。
支持
check_mode
插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。
另请参阅
另请参阅
- Cisco DNA Center 关于 Reports DownloadFlexibleReportV1 的文档。
DownloadFlexibleReportV1 API 的完整参考。
示例
- name: Get Flexible Report Content V1 by id
cisco.dnac.flexible_report_content_v1_info:
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}}"
headers: "{{my_headers | from_json}}"
reportId: string
executionId: string
register: result
返回值
常见的返回值已记录在 此处,以下是此模块特有的字段。
键 |
描述 |
---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表。 返回:始终 示例: |