cisco.dnac.reports_info 模块 – 报表信息信息模块
注意
此模块是 cisco.dnac 集合(版本 6.25.0)的一部分。
如果您使用的是 ansible
包,则可能已经安装了此集合。它不包含在 ansible-core
中。要检查它是否已安装,请运行 ansible-galaxy collection list
。
要安装它,请使用:ansible-galaxy collection install cisco.dnac
。您需要其他要求才能使用此模块,请参阅 要求 了解详细信息。
要在 playbook 中使用它,请指定:cisco.dnac.reports_info
。
cisco.dnac 3.1.0 中的新功能
概要
此模块表示模块 reports_v1_info 的别名
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
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 模式验证请求正文。 选项
|
|
ViewGroupId 查询参数。报表的 viewgroup 的 ViewGroupId。 |
|
ViewId 查询参数。报表的视图的 ViewId。 |
注释
注意
使用的 SDK 方法是 reports.Reports.get_a_scheduled_report_v1、reports.Reports.get_list_of_scheduled_reports_v1,
使用的路径是 get /dna/intent/api/v1/data/reports、get /dna/intent/api/v1/data/reports/{reportId},
应该注意的是,此模块是 reports_v1_info 的别名
支持
check_mode
该插件在控制节点上运行,并且不使用任何 ansible 连接插件,而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关报表 GetAScheduledReportV1 的 Cisco DNA Center 文档
GetAScheduledReportV1 API 的完整参考。
- 有关报表 GetListOfScheduledReportsV1 的 Cisco DNA Center 文档
GetListOfScheduledReportsV1 API 的完整参考。
示例
- name: Get all Reports Info
cisco.dnac.reports_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}}"
viewGroupId: string
viewId: string
register: result
- name: Get Reports Info by id
cisco.dnac.reports_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
register: result
返回值
常见的返回值记录在此处,以下是此模块独有的字段
键 |
描述 |
---|---|
带有 Cisco DNAC Python SDK 返回的响应的字典或列表 返回: 始终 示例: |