cisco.dnac.global_pool 模块 – 全局池资源模块

注意

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

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

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

要在剧本中使用它，请指定：cisco.dnac.global_pool。

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块代表模块 global_pool_v1 的别名。

注意

此模块具有相应的 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"

id

字符串

Id 路径参数。全局池 ID。

settings

字典

全局池的设置。

ippool

列表 / 元素=字典

全局池的 ippool。

dhcpServerIps

列表 / 元素=字符串

DHCP 服务器 IP。

dnsServerIps

列表 / 元素=字符串

DNS 服务器 IP。

gateway

字符串

网关。

id

字符串

Id。

ipPoolName

字符串

IP 池名称。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 network_settings.NetworkSettings.create_global_pool_v1、network_settings.NetworkSettings.delete_global_ip_pool_v1、network_settings.NetworkSettings.update_global_pool_v1。

  • 使用的路径是 post /dna/intent/api/v1/global-pool、delete /dna/intent/api/v1/global-pool/{id}、put /dna/intent/api/v1/global-pool。

  • 需要注意的是，此模块是 global_pool_v1 的别名。

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 网络设置 CreateGlobalPoolV1 文档

CreateGlobalPoolV1 API 的完整参考。

Cisco DNA Center 网络设置 DeleteGlobalIPPoolV1 文档

DeleteGlobalIPPoolV1 API 的完整参考。

Cisco DNA Center 网络设置 UpdateGlobalPoolV1 文档

UpdateGlobalPoolV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.global_pool:
    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
    settings:
      ippool:
      - dhcpServerIps:
        - string
        dnsServerIps:
        - string
        gateway: string
        id: string
        ipPoolName: string

- name: Create
  cisco.dnac.global_pool:
    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
    settings:
      ippool:
      - IpAddressSpace: string
        dhcpServerIps:
        - string
        dnsServerIps:
        - string
        gateway: string
        ipPoolCidr: string
        ipPoolName: string
        type: string

- name: Delete by id
  cisco.dnac.global_pool:
    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
    id: string

返回值

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

键

描述

dnac_response

字典

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

返回：始终

示例： {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

作者

  • Rafael Campos (@racampos)