cisco.dnac.reports_view_group_info 模块 – 报告视图组信息信息模块

注意

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

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

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

要在 playbook 中使用它，请指定： cisco.dnac.reports_view_group_info。

cisco.dnac 3.1.0 中的新增功能

概要 

此模块代表模块 reports_view_group_v1_info 的别名。

注意

此模块具有相应的 action 插件。

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
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"`
headers 字典	附加的 headers。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用针对 JSON 架构的请求正文验证。选项 `false` `true` ← (默认)
viewGroupId 字符串	viewGroupId 路径参数。视图组的 ViewGroupId。

备注 

注意

使用的 SDK 方法是 reports.Reports.get_all_view_groups_v1, reports.Reports.get_views_for_a_given_view_group_v1,
使用的路径是 get /dna/intent/api/v1/data/view-groups, get /dna/intent/api/v1/data/view-groups/{viewGroupId},
需要注意的是，此模块是 reports_view_group_v1_info 的别名。
支持 check_mode
插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅 

另请参阅

Cisco DNA Center 关于 Reports GetAllViewGroupsV1 的文档: GetAllViewGroupsV1 API 的完整参考。
Cisco DNA Center 关于 Reports GetViewsForAGivenViewGroupV1 的文档: GetViewsForAGivenViewGroupV1 API 的完整参考。

示例 

- name: Get all Reports View Group Info
  cisco.dnac.reports_view_group_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}}"
  register: result

- name: Get Reports View Group Info by id
  cisco.dnac.reports_view_group_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
  register: result

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段。

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表。返回：始终示例： `{"viewGroupId": "string", "views": [{"description": "string", "viewId": "string", "viewName": "string"}]}`

作者

Rafael Campos (@racampos)