cisco.dnac.wireless_enterprise_ssid_v1 模块 – 无线企业 Ssid V1 的资源模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

  • 管理资源无线企业 Ssid V1 的创建、更新和删除操作。

  • 创建企业 SSID。

  • 删除给定的企业 SSID。

  • 更新企业 SSID。

注意

此模块有一个对应的 操作插件。

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

aaaOverride

布尔值

Aaa 覆盖。

选项

  • false

  • true

authKeyMgmt

列表 / 元素=字符串

获取应设置为 true 的 AKM 的字符串输入。可能的 AKM 值：dot1x、dot1x_ft、dot1x_sha、psk、psk_ft、psk_sha、owe、sae、sae_ft。

basicServiceSetClientIdleTimeout

整数

基本服务集客户端空闲超时。

clientExclusionTimeout

整数

客户端排除超时。

clientRateLimit

浮点数

客户端速率限制（以每秒比特为单位）。

coverageHoleDetectionEnable

布尔值

启用覆盖空洞检测。

选项

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

enableBasicServiceSetMaxIdle

布尔值

启用基本服务集最大空闲时间。

选项

  • false

  • true

enableBroadcastSSID

布尔值

启用广播 SSID。

选项

  • false

  • true

enableClientExclusion

布尔值

启用客户端排除。

选项

  • false

  • true

enableDirectedMulticastService

布尔值

启用定向多播服务。

选项

  • false

  • true

enableFastLane

布尔值

启用 FastLane。

选项

  • false

  • true

enableMACFiltering

布尔值

启用 MAC 过滤。

选项

  • false

  • true

enableNeighborList

布尔值

启用邻居列表。

选项

  • false

  • true

enableSessionTimeOut

布尔值

启用会话超时。

选项

  • false

  • true

fastTransition

字符串

快速转换。

ghz24Policy

字符串

Ghz24 策略。

ghz6PolicyClientSteering

布尔值

Ghz6 策略客户端引导。

选项

  • false

  • true

mfpClientProtection

字符串

管理帧保护客户端。

multiPSKSettings

列表 / 元素=字典

无线企业 Ssid 的 multiPSKSettings。

passphrase

字符串

密码。

passphraseType

字符串

密码类型。

priority

整数

优先级。

name

字符串

SSID 名称。

nasOptions

列表 / 元素=字符串

Nas 选项。

passphrase

字符串

密码。

policyProfileName

字符串

策略配置文件名称。

profileName

字符串

配置文件名称。

protectedManagementFrame

字符串

（适用于安全类型 WPA3_PERSONAL、WPA3_ENTERPRISE、OPEN_SECURED）并且（可选，适用于安全类型 WPA2_WPA3_PERSONAL 和 WPA2_WPA3_ENTERPRISE）。

radioPolicy

字符串

无线电策略枚举。

rsnCipherSuiteCcmp256

布尔值

Rsn 密码套件 Ccmp256。

选项

  • false

  • true

rsnCipherSuiteGcmp128

布尔值

Rsn 密码套件 Gcmp 128。

选项

  • false

  • true

rsnCipherSuiteGcmp256

布尔值

Rsn 密码套件 Gcmp256。

选项

  • false

  • true

securityLevel

字符串

安全级别。

sessionTimeOut

整数

会话超时。

ssidName

字符串

SsidName 路径参数。输入要删除的 SSID 名称。

trafficType

字符串

流量类型枚举（voicedata 或 data）。

validate_response_schema

布尔值

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

选项

  • false

  • true ←（默认）

注释

注意

  • 使用的 SDK 方法是 wireless.Wireless.create_enterprise_ssid_v1、wireless.Wireless.delete_enterprise_ssid_v1、wireless.Wireless.update_enterprise_ssid_v1，

  • 使用的路径是 post /dna/intent/api/v1/enterprise-ssid、delete /dna/intent/api/v1/enterprise-ssid/{ssidName}、put /dna/intent/api/v1/enterprise-ssid，

  • 不支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于 Wireless CreateEnterpriseSSIDV1 的文档

CreateEnterpriseSSIDV1 API 的完整参考。

Cisco DNA Center 关于 Wireless DeleteEnterpriseSSIDV1 的文档

DeleteEnterpriseSSIDV1 API 的完整参考。

Cisco DNA Center 关于 Wireless UpdateEnterpriseSSIDV1 的文档

UpdateEnterpriseSSIDV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.wireless_enterprise_ssid_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
    aaaOverride: true
    authKeyMgmt:
    - string
    basicServiceSetClientIdleTimeout: 0
    clientExclusionTimeout: 0
    clientRateLimit: 0
    coverageHoleDetectionEnable: true
    enableBasicServiceSetMaxIdle: true
    enableBroadcastSSID: true
    enableClientExclusion: true
    enableDirectedMulticastService: true
    enableFastLane: true
    enableMACFiltering: true
    enableNeighborList: true
    enableSessionTimeOut: true
    fastTransition: string
    ghz24Policy: string
    ghz6PolicyClientSteering: true
    mfpClientProtection: string
    multiPSKSettings:
    - passphrase: string
      passphraseType: string
      priority: 0
    name: string
    nasOptions:
    - string
    passphrase: string
    policyProfileName: string
    profileName: string
    protectedManagementFrame: string
    radioPolicy: string
    rsnCipherSuiteCcmp256: true
    rsnCipherSuiteGcmp128: true
    rsnCipherSuiteGcmp256: true
    securityLevel: string
    sessionTimeOut: 0
    trafficType: string

- name: Update all
  cisco.dnac.wireless_enterprise_ssid_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
    aaaOverride: true
    authKeyMgmt:
    - string
    basicServiceSetClientIdleTimeout: 0
    clientExclusionTimeout: 0
    clientRateLimit: 0
    coverageHoleDetectionEnable: true
    enableBasicServiceSetMaxIdle: true
    enableBroadcastSSID: true
    enableClientExclusion: true
    enableDirectedMulticastService: true
    enableFastLane: true
    enableMACFiltering: true
    enableNeighborList: true
    enableSessionTimeOut: true
    fastTransition: string
    ghz24Policy: string
    ghz6PolicyClientSteering: true
    mfpClientProtection: string
    multiPSKSettings:
    - passphrase: string
      passphraseType: string
      priority: 0
    name: string
    nasOptions:
    - string
    passphrase: string
    policyProfileName: string
    profileName: string
    protectedManagementFrame: string
    radioPolicy: string
    rsnCipherSuiteCcmp256: true
    rsnCipherSuiteGcmp128: true
    rsnCipherSuiteGcmp256: true
    securityLevel: string
    sessionTimeOut: 0
    trafficType: string

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

返回值

常见的返回值已在此处文档中说明，以下是此模块独有的字段

键

描述

dnac_response

字典

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

返回： 始终

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

作者

  • Rafael Campos (@racampos)