cisco.dnac.sda_virtual_network_ip_pool_info 模块 – SDA 虚拟网络 IP 池信息模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.sda_virtual_network_ip_pool_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 此模块表示模块 sda_virtual_network_ip_pool_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。

ipPoolName

字符串

在 cisco.dnac 4.0.0 中添加

IpPoolName 查询参数。IpPoolName。注意:如果相同的 IP 池分配给多个虚拟网络,则使用 vlanName 作为此参数的值(例如,IpPoolName=vlan1021)。

siteNameHierarchy

字符串

在 cisco.dnac 4.0.0 中添加

SiteNameHierarchy 查询参数。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

virtualNetworkName

字符串

VirtualNetworkName 查询参数。

注释

注意

  • 使用的 SDK 方法是 sda.Sda.get_ip_pool_from_sda_virtual_network_v1,

  • 使用的路径是 get /dna/intent/api/v1/business/sda/virtualnetwork/ippool,

  • 需要注意的是,此模块是 sda_virtual_network_ip_pool_v1_info 的别名。

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center SDA GetIPPoolFromSDAVirtualNetworkV1 文档

GetIPPoolFromSDAVirtualNetworkV1 API 的完整参考。

示例

- name: Get all Sda Virtual Network Ip Pool Info
  cisco.dnac.sda_virtual_network_ip_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}}"
    siteNameHierarchy: string
    virtualNetworkName: string
    ipPoolName: string
  register: result

返回值

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

描述

dnac_response

字典

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

已返回:始终

示例: {"authenticationPolicyName": "string", "description": "string", "ipPoolName": "string", "isL2FloodingEnabled": true, "isThisCriticalPool": true, "scalableGroupName": "string", "status": "string", "trafficType": "string", "virtualNetworkName": "string"}

作者

  • Rafael Campos (@racampos)