cisco.dnac.wireless_enterprise_ssid module – Resource module for Wireless Enterprise Ssid
Note
This module is part of the cisco.dnac collection (version 6.22.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.wireless_enterprise_ssid
.
New in cisco.dnac 3.1.0
Synopsis
Manage operations create, update and delete of the resource Wireless Enterprise Ssid.
Creates enterprise SSID.
Deletes given enterprise SSID.
Update enterprise SSID.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Aaa Override. Choices:
|
|
Takes string inputs for the AKMs that should be set true. Possible AKM values dot1x,dot1x_ft, dot1x_sha, psk, psk_ft, psk_sha, owe, sae, sae_ft. |
|
Basic Service Set Client Idle Timeout (Default 300 if enableBasicServiceSetMaxIdle is true, 0 otherwise). |
|
Client Exclusion Timeout(Default 180 if enableClientExclusion is true, 0 otherwise). |
|
Client Rate Limit (in bits per second). |
|
Coverage Hole Detection Enable. Choices:
|
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Enable Basic Service Set Max Idle (Default true). Choices:
|
|
Enable Broadcase SSID. Choices:
|
|
Enable Client Exclusion(Default true). Choices:
|
|
Enable Directed Multicast Service. Choices:
|
|
Enable FastLane. Choices:
|
|
Enable MAC Filtering. Choices:
|
|
Enable Neighbor List. Choices:
|
|
Enable Session Timeout(Default true). Choices:
|
|
Fast Transition. |
|
Ghz24 Policy. |
|
Ghz6 Policy Client Steering. Choices:
|
|
Management Frame Protection Client. |
|
Wireless Enterprise Ssid’s multiPSKSettings. |
|
Passphrase. |
|
Passphrase Type. |
|
Priority. |
|
SSID NAME. |
|
Nas Options. |
|
Passphrase. |
|
Policy Profile Name. |
|
Profile Name. |
|
(Required applicable for Security Type WPA3_PERSONAL, WPA3_ENTERPRISE, OPEN_SECURED) and (Optional, Required Applicable for Security Type WPA2_WPA3_PERSONAL and WPA2_WPA3_ENTERPRISE). |
|
Radio Policy Enum. |
|
Rsn Cipher Suite Ccmp256. Choices:
|
|
Rsn Cipher Suite Gcmp 128. Choices:
|
|
Rsn Cipher Suite Gcmp256. Choices:
|
|
Security Level. |
|
Session Time Out (Default 1800 if enableSessionTimeOut is true, 0 otherwise). |
|
SsidName path parameter. Enter the SSID name to be deleted. |
|
Traffic Type Enum (voicedata or data ). |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are wireless.Wireless.create_enterprise_ssid, wireless.Wireless.delete_enterprise_ssid, wireless.Wireless.update_enterprise_ssid,
Paths used are post /dna/intent/api/v1/enterprise-ssid, delete /dna/intent/api/v1/enterprise-ssid/{ssidName}, put /dna/intent/api/v1/enterprise-ssid,
Does not support
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Wireless CreateEnterpriseSSID
Complete reference of the CreateEnterpriseSSID API.
- Cisco DNA Center documentation for Wireless DeleteEnterpriseSSID
Complete reference of the DeleteEnterpriseSSID API.
- Cisco DNA Center documentation for Wireless UpdateEnterpriseSSID
Complete reference of the UpdateEnterpriseSSID API.
Examples
- name: Create
cisco.dnac.wireless_enterprise_ssid:
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:
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:
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |