cisco.dnac.global_pool_info 模块 – 全局池信息的信息模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.dnac.global_pool_info

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

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

要求

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

  • 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

字典

其他标头。

limit

浮点数

限制查询参数。要检索的全局池数。如果未指定,则默认为 25。

offset

浮点数

偏移量查询参数。偏移量/起始行。从 1 索引。默认值为 1。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 启用针对 JSON 架构验证请求正文的标志。

选择

  • false

  • true ←(默认)

备注

注意

  • 使用的 SDK 方法是 network_settings.NetworkSettings.get_global_pool_v1,

  • 使用的路径是 get /dna/intent/api/v1/global-pool,

  • 应注意,此模块是 global_pool_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Network Settings GetGlobalPoolV1

GetGlobalPoolV1 API 的完整参考。

示例

- name: Get all Global Pool Info
  cisco.dnac.global_pool_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}}"
    offset: 0
    limit: 0
  register: result

返回值

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

描述

dnac_response

字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表

返回: 始终

示例: {"response": [{"availableIpAddressCount": 0, "clientOptions": {}, "configureExternalDhcp": true, "context": [{"contextKey": "字符串", "contextValue": "字符串", "owner": "字符串"}], "createTime": 0, "defaultAssignedIpAddressCount": 0, "dhcpServerIps": ["字符串"], "dnsServerIps": ["字符串"], "gateways": ["字符串"], "hasSubpools": true, "id": "字符串", "ipPoolCidr": "字符串", "ipPoolName": "字符串", "ipPoolType": "字符串", "ipv6": true, "lastUpdateTime": 0, "overlapping": true, "owner": "字符串", "parentUuid": "字符串", "shared": true, "totalAssignableIpAddressCount": 0, "totalIpAddressCount": 0, "unavailableIpAddressCount": 0, "usedIpAddressCount": 0, "usedPercentage": "字符串"}], "version": "字符串"}

作者

  • Rafael Campos (@racampos)