cisco.dnac.sites_wireless_settings_ssids_v1 模块 – Sites 无线设置 SSID V1 资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要 

管理 Sites 无线设置 SSID V1 资源的创建、更新和删除操作。
此 API 允许用户在全局站点创建 SSID 服务集标识符。
如果 SSID 未映射到任何无线配置文件，则此 API 允许用户在全局级别删除 SSID 服务集标识符。
此 API 允许用户更新给定站点上的 SSID 服务集标识符。

注意

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

要求 

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

dnacentersdk >= 2.4.9
python >= 3.5

参数 

参数	注释
aaaOverride 布尔值	设置为 true 时激活 AAA 覆盖功能。选项 `false` `true`
acctServers 列表 / 元素=字符串	计费服务器 IP 地址列表。
aclName 字符串	预认证访问控制列表 (ACL) 名称。
authServer 字符串	身份验证服务器，对于 wlanType=Guest 和 l3AuthType=web_auth 的访客 SSID 来说是必须的。
authServers 列表 / 元素=字符串	身份验证/授权服务器 IP 地址列表。
authType 字符串	L2 身份验证类型（如果 authType 不是 open，则必须启用至少一个 RSN 密码套件和相应的有效 AKM）。
basicServiceSetClientIdleTimeout 整数	这是连接到基本服务集的客户端在被视为空闲并超时之前的不活动持续时间（以秒为单位）。
basicServiceSetMaxIdleEnable 布尔值	激活基本服务集的最大空闲功能。选项 `false` `true`
cckmTsfTolerance 整数	CCKM 时间戳容差（以毫秒为单位）。
clientExclusionEnable 布尔值	激活允许排除客户端的功能。选项 `false` `true`
clientExclusionTimeout 整数	这是客户端在指定次数的尝试失败后被排除或阻止访问网络的时间长度（以秒为单位）。
clientRateLimit 整数	这是客户端允许达到的最大数据传输速率（以每秒比特为单位）。
coverageHoleDetectionEnable 布尔值	设置为 true 时激活覆盖范围漏洞检测功能。选项 `false` `true`
directedMulticastServiceEnable 布尔值	设置为 true 时，定向组播服务功能开始运行。选项 `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"`
egressQos 字符串	出站 QoS。
externalAuthIpAddress 字符串	外部 WebAuth URL（对于 wlanType = Guest、l3AuthType = web_auth 和 authServer = auth_external 的访客 SSID 来说是必须的）。
fastTransition 字符串	快速切换。
fastTransitionOverTheDistributedSystemEnable 布尔值	设置为 true 时启用分布式系统上的快速切换。选项 `false` `true`
ghz24Policy 字符串	2.4 GHz 频段策略值。仅当在 ssidRadioType 中启用 2.4 无线电频段时才允许。
ghz6PolicyClientSteering 布尔值	如果启用了 6 GHz 策略客户端转向，则为 True，否则为 False。选项 `false` `true`
id 字符串	ID 路径参数。SSID ID。包含特殊字符的输入应进行编码。
ingressQos 字符串	入站 QoS。
isApBeaconProtectionEnabled 布尔值	设置为 true 时，将激活接入点 (AP) 信标保护功能，增强网络安全性。选项 `false` `true`
isAuthKey8021x 布尔值	设置为 true 时，表示正在使用 802.1X 认证密钥。选项 `false` `true`
isAuthKey8021x_SHA256 布尔值	设置为 true 时，将启用使用 SHA256 算法的 802.1X 认证功能。选项 `false` `true`
isAuthKey8021xPlusFT 布尔值	设置为 true 时，表示正在使用 802.1X-Plus-FT 认证密钥。选项 `false` `true`
isAuthKeyEasyPSK 布尔值	设置为 true 时，将激活启用易预共享密钥 (PSK) 认证的功能。选项 `false` `true`
isAuthKeyOWE 布尔值	设置为 true 时，将启用机会性无线加密 (OWE) 认证密钥功能。选项 `false` `true`
isAuthKeyPSK 布尔值	设置为 true 时，将启用预共享密钥 (PSK) 认证功能。选项 `false` `true`
isAuthKeyPSKPlusFT 布尔值	设置为 true 时，将激活启用预共享密钥 (PSK) 和快速转换 (FT) 认证密钥组合的功能。选项 `false` `true`
isAuthKeyPSKSHA256 布尔值	设置为 true 时，将启用使用 SHA256 算法的预共享密钥 (PSK) 认证功能。选项 `false` `true`
isAuthKeySae 布尔值	设置为 true 时，将激活启用同时相等认证 (SAE) 认证密钥的功能。选项 `false` `true`
isAuthKeySaeExt 布尔值	设置为 true 时，将启用同时相等认证 (SAE) 扩展认证密钥功能。选项 `false` `true`
isAuthKeySaeExtPlusFT 布尔值	设置为 true 时，将启用同时相等认证 (SAE) 与快速转换 (FT) 认证密钥组合的功能。选项 `false` `true`
isAuthKeySaePlusFT 布尔值	将其设置为 true 以激活此设置，将启用同时支持同时相等认证 (SAE) 和快速转换 (FT) 的认证密钥功能。选项 `false` `true`
isAuthKeySuiteB1921x 布尔值	设置为 true 时，将启用 SuiteB192-1x 认证密钥功能。选项 `false` `true`
isAuthKeySuiteB1x 布尔值	设置为 true 时，将启用 SuiteB-1x 认证密钥功能。选项 `false` `true`
isBroadcastSSID 布尔值	设置为 true 时，将激活广播 SSID 功能，使 SSID 对搜索可用网络的无线设备公开可见。选项 `false` `true`
isCckmEnabled 布尔值	如果启用 CCKM，则为 True，否则为 False。选项 `false` `true`
isEnabled 布尔值	设置为 true 时，将 SSID 的管理员状态设置为“已启用”。选项 `false` `true`
isFastLaneEnabled 布尔值	如果启用 FastLane，则为 True，否则为 False。选项 `false` `true`
isHex 布尔值	如果密码为十六进制格式，则为 True，否则为 False。选项 `false` `true`
isMacFilteringEnabled 布尔值	设置为 true 时，将激活 MAC 过滤，允许基于设备的 MAC 地址控制网络访问。选项 `false` `true`
isPosturingEnabled 布尔值	仅适用于企业 SSID。设置为 True 时，将启用姿态保持。如果需要为企业 SSID 映射 ACL，则必须设置为 True。选项 `false` `true`
isRandomMacFilterEnabled 布尔值	设置为 true 时，拒绝使用随机 MAC 地址的客户端。选项 `false` `true`
l3AuthType 字符串	L3 认证类型。
managementFrameProtectionClientprotection 字符串	管理帧保护客户端。
multiPSKSettings 列表 / 元素=字典	站点无线设置 SSID 的 multiPSKSettings。
passphrase 字符串	对于 ASCII 类型，密码需要在 8 到 63 个字符之间。十六进制密码需要 64 个字符。
passphraseType 字符串	密码类型。
priority 整数	优先级。
nasOptions 列表 / 元素=字符串	预定义的 NAS 选项：AP 以太网 MAC 地址、AP IP 地址、AP 位置、AP MAC 地址、AP 名称、AP策略标签、AP站点标签、SSID、系统 IP 地址、系统 MAC 地址、系统名称。
neighborListEnable 布尔值	设置为 true 时，将启用邻居列表功能。选项 `false` `true`
openSsid 字符串	在设计中已创建且未与任何其他开放安全 SSID 关联的开放 SSID。
passphrase 字符串	密码（仅适用于具有个人安全级别的 SSID）。对于 ASCII 类型，密码需要在 8 到 63 个字符之间。十六进制密码需要 64 个字符。
profileName 字符串	WLAN 配置文件名称，如果未传递，则将分配自动生成的配置文件名称。相同的 wlanProfileName 也将用于 policyProfileName。
protectedManagementFrame 字符串	（必需，适用于 authType WPA3_PERSONAL、WPA3_ENTERPRISE、OPEN_SECURED）和（可选/必需，适用于 authType WPA2_WPA3_PERSONAL 和 WPA2_WPA3_ENTERPRISE）。
rsnCipherSuiteCcmp128 布尔值	设置为 true 时，将激活鲁棒安全网络 (RSN) 密码套件 CCMP128 加密协议。选项 `false` `true`
rsnCipherSuiteCcmp256 布尔值	设置为 true 时，将激活鲁棒安全网络 (RSN) 密码套件 CCMP256 加密协议。选项 `false` `true`
rsnCipherSuiteGcmp128 布尔值	设置为 true 时，将激活鲁棒安全网络 (RSN) 密码套件 GCMP128 加密协议。选项 `false` `true`
rsnCipherSuiteGcmp256 布尔值	设置为 true 时，将激活鲁棒安全网络 (RSN) 密码套件 GCMP256 加密协议。选项 `false` `true`
sessionTimeOut 整数	这表示由于 inactivity 而自动终止会话之前分配的时间跨度（以秒为单位）。
sessionTimeOutEnable 布尔值	启用对用户会话施加时间限制的功能。选项 `false` `true`
siteId 字符串	SiteId 路径参数。全局站点的站点 UUID。
sleepingClientEnable 布尔值	设置为 true 时，将激活适用于睡眠模式下客户端的超时设置。选项 `false` `true`
sleepingClientTimeout 整数	这指的是睡眠（非活动）客户端从网络超时之前的时间量（以分钟为单位）。
ssid 字符串	SSID 的名称。
ssidRadioType 字符串	无线电策略枚举（默认三频操作（2.4GHz、5GHz 和 6GHz））。
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)
webPassthrough 布尔值	设置为 true 时，将为访客 SSID 激活 Web 直通功能，允许访客绕过某些登录要求。选项 `false` `true`
wlanBandSelectEnable 布尔值	仅当选择的频段选项至少包含 2.4 GHz 和 5 GHz 频段时才允许频段选择。选项 `false` `true`
wlanType 字符串	WLAN 类型。

注释 

注意

使用的 SDK 方法为 wireless.Wireless.create_ssid_v1、wireless.Wireless.delete_ssid_v1、wireless.Wireless.update_ssid_v1，
使用的路径为 post /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids、delete /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids/{id}、put /dna/intent/api/v1/sites/{siteId}/wirelessSettings/ssids/{id}，
不支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参见 

另请参见

Cisco DNA Center 无线 CreateSSIDV1 文档: CreateSSIDV1 API 的完整参考。
Cisco DNA Center 无线 DeleteSSIDV1 文档: DeleteSSIDV1 API 的完整参考。
Cisco DNA Center 无线 UpdateSSIDV1 文档: UpdateSSIDV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.sites_wireless_settings_ssids_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
    acctServers:
    - string
    aclName: string
    authServer: string
    authServers:
    - string
    authType: string
    basicServiceSetClientIdleTimeout: 0
    basicServiceSetMaxIdleEnable: true
    cckmTsfTolerance: 0
    clientExclusionEnable: true
    clientExclusionTimeout: 0
    clientRateLimit: 0
    coverageHoleDetectionEnable: true
    directedMulticastServiceEnable: true
    egressQos: string
    externalAuthIpAddress: string
    fastTransition: string
    fastTransitionOverTheDistributedSystemEnable: true
    ghz24Policy: string
    ghz6PolicyClientSteering: true
    ingressQos: string
    isApBeaconProtectionEnabled: true
    isAuthKey8021x: true
    isAuthKey8021xPlusFT: true
    isAuthKey8021x_SHA256: true
    isAuthKeyEasyPSK: true
    isAuthKeyOWE: true
    isAuthKeyPSK: true
    isAuthKeyPSKPlusFT: true
    isAuthKeyPSKSHA256: true
    isAuthKeySae: true
    isAuthKeySaeExt: true
    isAuthKeySaeExtPlusFT: true
    isAuthKeySaePlusFT: true
    isAuthKeySuiteB1921x: true
    isAuthKeySuiteB1x: true
    isBroadcastSSID: true
    isCckmEnabled: true
    isEnabled: true
    isFastLaneEnabled: true
    isHex: true
    isMacFilteringEnabled: true
    isPosturingEnabled: true
    isRandomMacFilterEnabled: true
    l3AuthType: string
    managementFrameProtectionClientprotection: string
    multiPSKSettings:
    - passphrase: string
      passphraseType: string
      priority: 0
    nasOptions:
    - string
    neighborListEnable: true
    openSsid: string
    passphrase: string
    profileName: string
    protectedManagementFrame: string
    rsnCipherSuiteCcmp128: true
    rsnCipherSuiteCcmp256: true
    rsnCipherSuiteGcmp128: true
    rsnCipherSuiteGcmp256: true
    sessionTimeOut: 0
    sessionTimeOutEnable: true
    siteId: string
    sleepingClientEnable: true
    sleepingClientTimeout: 0
    ssid: string
    ssidRadioType: string
    webPassthrough: true
    wlanBandSelectEnable: true
    wlanType: string

- name: Update by id
  cisco.dnac.sites_wireless_settings_ssids_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
    acctServers:
    - string
    aclName: string
    authServer: string
    authServers:
    - string
    authType: string
    basicServiceSetClientIdleTimeout: 0
    basicServiceSetMaxIdleEnable: true
    cckmTsfTolerance: 0
    clientExclusionEnable: true
    clientExclusionTimeout: 0
    clientRateLimit: 0
    coverageHoleDetectionEnable: true
    directedMulticastServiceEnable: true
    egressQos: string
    externalAuthIpAddress: string
    fastTransition: string
    fastTransitionOverTheDistributedSystemEnable: true
    ghz24Policy: string
    ghz6PolicyClientSteering: true
    id: string
    ingressQos: string
    isApBeaconProtectionEnabled: true
    isAuthKey8021x: true
    isAuthKey8021xPlusFT: true
    isAuthKey8021x_SHA256: true
    isAuthKeyEasyPSK: true
    isAuthKeyOWE: true
    isAuthKeyPSK: true
    isAuthKeyPSKPlusFT: true
    isAuthKeyPSKSHA256: true
    isAuthKeySae: true
    isAuthKeySaeExt: true
    isAuthKeySaeExtPlusFT: true
    isAuthKeySaePlusFT: true
    isAuthKeySuiteB1921x: true
    isAuthKeySuiteB1x: true
    isBroadcastSSID: true
    isCckmEnabled: true
    isEnabled: true
    isFastLaneEnabled: true
    isHex: true
    isMacFilteringEnabled: true
    isPosturingEnabled: true
    isRandomMacFilterEnabled: true
    l3AuthType: string
    managementFrameProtectionClientprotection: string
    multiPSKSettings:
    - passphrase: string
      passphraseType: string
      priority: 0
    nasOptions:
    - string
    neighborListEnable: true
    openSsid: string
    passphrase: string
    profileName: string
    protectedManagementFrame: string
    rsnCipherSuiteCcmp128: true
    rsnCipherSuiteCcmp256: true
    rsnCipherSuiteGcmp128: true
    rsnCipherSuiteGcmp256: true
    sessionTimeOut: 0
    sessionTimeOutEnable: true
    siteId: string
    sleepingClientEnable: true
    sleepingClientTimeout: 0
    ssid: string
    ssidRadioType: string
    webPassthrough: true
    wlanBandSelectEnable: true
    wlanType: string

- name: Delete by id
  cisco.dnac.sites_wireless_settings_ssids_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
    id: string
    siteId: string

返回值 

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

键	描述
dnac_response 字典	包含 Cisco DNAC Python SDK 返回的响应的字典或列表。返回：始终示例： `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

作者

Rafael Campos (@racampos)