cisco.dnac.business_sda_hostonboarding_ssid_ippool_v1 模块 – Business Sda Hostonboarding Ssid Ippool V1 资源模块

注意

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

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

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

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

cisco.dnac 4.0.0 中的新增功能

概要

  • 管理 Business Sda Hostonboarding Ssid Ippool V1 资源的创建和更新操作。

  • 将 SSID 添加到 IP 池映射。

  • 更新 SSID 到 IP 池映射。

注意

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

要求

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

  • 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"

scalableGroupName

字符串

可扩展组名称。

siteNameHierarchy

字符串

站点名称层次结构。

ssidNames

列表 / 元素=字符串

SSID 列表。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

vlanName

字符串

VLAN 名称。

备注

注意

  • 使用的 SDK 方法为 fabric_wireless.FabricWireless.add_ssid_to_ip_pool_mapping_v1、fabric_wireless.FabricWireless.update_ssid_to_ip_pool_mapping_v1,

  • 使用的路径为 post /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool、put /dna/intent/api/v1/business/sda/hostonboarding/ssid-ippool,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center Fabric Wireless AddSSIDToIPPoolMappingV1 文档

AddSSIDToIPPoolMappingV1 API 的完整参考。

Cisco DNA Center Fabric Wireless UpdateSSIDToIPPoolMappingV1 文档

UpdateSSIDToIPPoolMappingV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.business_sda_hostonboarding_ssid_ippool_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
    scalableGroupName: string
    siteNameHierarchy: string
    ssidNames:
    - string
    vlanName: string

- name: Update all
  cisco.dnac.business_sda_hostonboarding_ssid_ippool_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
    scalableGroupName: string
    siteNameHierarchy: string
    ssidNames:
    - string
    vlanName: string

返回值

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

描述

dnac_response

字典

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

返回:始终

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

作者

  • Rafael Campos (@racampos)