#!/usr/bin/python # -*- coding: utf-8 -*- # Copyright (c) 2021, Cisco Systems # GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt) DOCUMENTATION = r""" --- module: wireless_enterprise_ssid short_description: Resource module for Wireless Enterprise Ssid description: - Manage operations create, update and delete of the resource Wireless Enterprise Ssid. - Creates enterprise SSID. - Deletes given enterprise SSID. - Update enterprise SSID. version_added: '3.1.0' extends_documentation_fragment: - cisco.dnac.module author: Rafael Campos (@racampos) options: aaaOverride: description: Aaa Override. type: bool authKeyMgmt: description: 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. elements: str type: list basicServiceSetClientIdleTimeout: description: Basic Service Set Client Idle Timeout (Default 300 if enableBasicServiceSetMaxIdle is true, 0 otherwise). type: int clientExclusionTimeout: description: Client Exclusion Timeout(Default 180 if enableClientExclusion is true, 0 otherwise). type: int clientRateLimit: description: Client Rate Limit (in bits per second). type: float coverageHoleDetectionEnable: description: Coverage Hole Detection Enable. type: bool enableBasicServiceSetMaxIdle: description: Enable Basic Service Set Max Idle (Default true). type: bool enableBroadcastSSID: description: Enable Broadcase SSID. type: bool enableClientExclusion: description: Enable Client Exclusion(Default true). type: bool enableDirectedMulticastService: description: Enable Directed Multicast Service. type: bool enableFastLane: description: Enable FastLane. type: bool enableMACFiltering: description: Enable MAC Filtering. type: bool enableNeighborList: description: Enable Neighbor List. type: bool enableSessionTimeOut: description: Enable Session Timeout(Default true). type: bool fastTransition: description: Fast Transition. type: str ghz24Policy: description: Ghz24 Policy. type: str ghz6PolicyClientSteering: description: Ghz6 Policy Client Steering. type: bool mfpClientProtection: description: Management Frame Protection Client. type: str multiPSKSettings: description: Wireless Enterprise Ssid's multiPSKSettings. elements: dict suboptions: passphrase: description: Passphrase. type: str passphraseType: description: Passphrase Type. type: str priority: description: Priority. type: int type: list name: description: SSID NAME. type: str nasOptions: description: Nas Options. elements: str type: list passphrase: description: Passphrase. type: str policyProfileName: description: Policy Profile Name. type: str profileName: description: Profile Name. type: str protectedManagementFrame: description: (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). type: str radioPolicy: description: Radio Policy Enum. type: str rsnCipherSuiteCcmp256: description: Rsn Cipher Suite Ccmp256. type: bool rsnCipherSuiteGcmp128: description: Rsn Cipher Suite Gcmp 128. type: bool rsnCipherSuiteGcmp256: description: Rsn Cipher Suite Gcmp256. type: bool securityLevel: description: Security Level. type: str sessionTimeOut: description: Session Time Out (Default 1800 if enableSessionTimeOut is true, 0 otherwise). type: int ssidName: description: SsidName path parameter. Enter the SSID name to be deleted. type: str trafficType: description: Traffic Type Enum (voicedata or data ). type: str requirements: - dnacentersdk >= 2.7.1 - python >= 3.5 seealso: - name: Cisco DNA Center documentation for Wireless CreateEnterpriseSSID description: Complete reference of the CreateEnterpriseSSID API. link: https://developer.cisco.com/docs/dna-center/#!create-enterprise-ssid - name: Cisco DNA Center documentation for Wireless DeleteEnterpriseSSID description: Complete reference of the DeleteEnterpriseSSID API. link: https://developer.cisco.com/docs/dna-center/#!delete-enterprise-ssid - name: Cisco DNA Center documentation for Wireless UpdateEnterpriseSSID description: Complete reference of the UpdateEnterpriseSSID API. link: https://developer.cisco.com/docs/dna-center/#!update-enterprise-ssid notes: - 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, """ EXAMPLES = r""" - 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 = r""" dnac_response: description: A dictionary or list with the response returned by the Cisco DNAC Python SDK returned: always type: dict sample: > { "executionId": "string", "executionStatusUrl": "string", "message": "string" } """