cisco.dnac.sda_fabrics_vlan_to_ssids_fabric_id_v1 模块 – Sda Fabrics Vlan To Ssids Fabric Id V1 的资源模块

注意

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

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

要安装它，请使用： ansible-galaxy collection install cisco.dnac。 您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。

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

cisco.dnac 6.15.0 中的新增功能

概要

  • 管理资源 Sda Fabrics Vlan To Ssids Fabric Id V1 的更新操作。

  • 添加、更新或删除 VLAN 的 SSID 映射。如果 payload 不包含先前已完成 SSID 映射的 'vlanName'，则将清除 'vlanName' 的所有映射 SSID。 该请求必须包含当前映射到 VLAN 的所有 SSID，如用于请求的同一 fabricId 的 GET 操作的响应所确定。如果 payload 中未包含已映射的 SSID，则此 API 将删除其映射。相反，如果提供了新的 SSID，则会将其添加到映射中。确保添加的任何新 SSID 都是 Fabric SSID。此 API 也可用于添加 VLAN 并将相关的 SSID 与其关联。'vlanName' 必须是“Fabric Wireless Enabled”，并且应该是 API 请求中指定的代表“Fabric ID”的 Fabric 站点的一部分。

注意

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

要求

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

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

fabricId

字符串

FabricId 路径参数。“fabricId”表示特定 Fabric 站点的 Fabric ID。

payload

列表 / 元素=字典

Sda Fabrics Vlan To Ssids Fabric Id 的 payload。

ssidDetails

列表 / 元素=字典

Sda Fabrics Vlan To Ssids Fabric Id 的 ssidDetails。

name

字符串

SSID 的名称。

securityGroupTag

字符串

表示安全组的名称。例如，审计员、BYOD、开发人员等。

vlanName

字符串

Vlan 名称。

validate_response_schema

布尔值

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

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 fabric_wireless.FabricWireless.add_update_or_remove_ssid_mapping_to_a_vlan_v1,

  • 使用的路径是 put /dna/intent/api/v1/sda/fabrics/{fabricId}/vlanToSsids,

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关 Fabric Wireless AddUpdateOrRemoveSSIDMappingToAVLANV1 的 Cisco DNA Center 文档

AddUpdateOrRemoveSSIDMappingToAVLANV1 API 的完整参考。

示例

- name: Update all
  cisco.dnac.sda_fabrics_vlan_to_ssids_fabric_id_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
    fabricId: string
    payload:
    - ssidDetails:
      - name: string
        securityGroupTag: string
      vlanName: string

返回值

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

键

描述

dnac_response

字典

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

已返回: 始终

示例: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

作者

  • Rafael Campos (@racampos)