cisco.dnac.sda_virtual_network_ip_pool_v1 模块 – SDA 虚拟网络 IP 池 V1 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理 SDA 虚拟网络 IP 池 V1 资源的创建和删除操作。

  • 在 SDA 虚拟网络中添加 IP 池。

  • 从 SDA 虚拟网络中删除 IP 池。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

autoGenerateVlanName

布尔值

如果 vlanName 为空，它将自动生成 vlanName（适用于 L3 和 INFRA_VN）。

选项

  • false

  • true

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"

ipPoolName

字符串

在 cisco.dnac 4.0.0 中添加

IpPoolName 查询参数。

isBridgeModeVm

布尔值

桥接模式虚拟机启用标志（适用于 L3 和 L2，默认值为 False）。

选项

  • false

  • true

isCommonPool

布尔值

通用池启用标志（适用于 L3 和 L2，默认值为 False）。

选项

  • false

  • true

isIpDirectedBroadcast

布尔值

IP 指向广播启用标志（适用于 L3，默认值为 False）。

选项

  • false

  • true

isL2FloodingEnabled

布尔值

在 cisco.dnac 4.0.0 中添加

二层泛洪启用标志（适用于 L3、L2，对于 L2 始终为 true，默认值为 False）。

选项

  • false

  • true

isLayer2Only

布尔值

二层专用启用标志，默认值为 False。

选项

  • false

  • true

isThisCriticalPool

布尔值

在 cisco.dnac 4.0.0 中添加

关键池启用标志（适用于 L3，默认值为 False）。

选项

  • false

  • true

isWirelessPool

布尔值

在 cisco.dnac 4.0.0 中添加

无线池启用标志（适用于 L3 和 L2，默认值为 False）。

选项

  • false

  • true

poolType

字符串

在 cisco.dnac 4.0.0 中添加

池类型（适用于 INFRA_VN）。

scalableGroupName

字符串

在 cisco.dnac 4.0.0 中添加

可扩展组名称（适用于 L3）。

siteNameHierarchy

字符串

在 cisco.dnac 4.0.0 中添加

SiteNameHierarchy 查询参数。

trafficType

字符串

在 cisco.dnac 4.0.0 中添加

流量类型（适用于 L3 和 L2）。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

virtualNetworkName

字符串

VirtualNetworkName 查询参数。

vlanId

字符串

VLAN ID（适用于 L3、L2 和 INFRA_VN）。

vlanName

字符串

在 cisco.dnac 4.0.0 中添加

vlanName 代表分段名称，如果为空，则 API 将自动生成 vlanName。

备注

注意

  • 使用的 SDK 方法为 sda.Sda.add_ip_pool_in_sda_virtual_network_v1、sda.Sda.delete_ip_pool_from_sda_virtual_network_v1，

  • 使用的路径为 post /dna/intent/api/v1/business/sda/virtualnetwork/ippool、delete /dna/intent/api/v1/business/sda/virtualnetwork/ippool，

  • 不支持 check_mode

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

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

参见

另请参见

Cisco DNA Center 文档，关于 SDA AddIPPoolInSDAVirtualNetworkV1

AddIPPoolInSDAVirtualNetworkV1 API 的完整参考。

Cisco DNA Center 文档，关于 SDA DeleteIPPoolFromSDAVirtualNetworkV1

DeleteIPPoolFromSDAVirtualNetworkV1 API 的完整参考。

示例

- name: Delete all
  cisco.dnac.sda_virtual_network_ip_pool_v1:
    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
    ipPoolName: string
    siteNameHierarchy: string
    virtualNetworkName: string

- name: Create
  cisco.dnac.sda_virtual_network_ip_pool_v1:
    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
    autoGenerateVlanName: true
    ipPoolName: string
    isBridgeModeVm: true
    isCommonPool: true
    isIpDirectedBroadcast: true
    isL2FloodingEnabled: true
    isLayer2Only: true
    isThisCriticalPool: true
    isWirelessPool: true
    poolType: string
    scalableGroupName: string
    siteNameHierarchy: string
    trafficType: string
    virtualNetworkName: string
    vlanId: string
    vlanName: string

返回值

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

键

描述

dnac_response

字典

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

返回值：始终返回

示例： {"description": "string", "executionId": "string", "executionStatusUrl": "string", "status": "string", "taskId": "string", "taskStatusUrl": "string"}

作者

  • Rafael Campos (@racampos)