cisco.dnac.wireless_enterprise_ssid module -- Resource module for Wireless Enterprise Ssid

Note

This module is part of the cisco.dnac collection (version 6.24.0).

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
aaaOverride boolean	Aaa Override. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
authKeyMgmt list / elements=string	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.
basicServiceSetClientIdleTimeout integer	Basic Service Set Client Idle Timeout (Default 300 if enableBasicServiceSetMaxIdle is true, 0 otherwise).
clientExclusionTimeout integer	Client Exclusion Timeout(Default 180 if enableClientExclusion is true, 0 otherwise).
clientRateLimit float	Client Rate Limit (in bits per second).
coverageHoleDetectionEnable boolean	Coverage Hole Detection Enable. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The Cisco DNA Center hostname.
dnac_password string	The Cisco DNA Center password to authenticate.
dnac_port integer	The Cisco DNA Center port. Default: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"`
enableBasicServiceSetMaxIdle boolean	Enable Basic Service Set Max Idle (Default true). Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enableBroadcastSSID boolean	Enable Broadcase SSID. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enableClientExclusion boolean	Enable Client Exclusion(Default true). Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enableDirectedMulticastService boolean	Enable Directed Multicast Service. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enableFastLane boolean	Enable FastLane. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enableMACFiltering boolean	Enable MAC Filtering. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enableNeighborList boolean	Enable Neighbor List. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
enableSessionTimeOut boolean	Enable Session Timeout(Default true). Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
fastTransition string	Fast Transition.
ghz24Policy string	Ghz24 Policy.
ghz6PolicyClientSteering boolean	Ghz6 Policy Client Steering. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
mfpClientProtection string	Management Frame Protection Client.
multiPSKSettings list / elements=dictionary	Wireless Enterprise Ssid's multiPSKSettings.
passphrase string	Passphrase.
passphraseType string	Passphrase Type.
priority integer	Priority.
name string	SSID NAME.
nasOptions list / elements=string	Nas Options.
passphrase string	Passphrase.
policyProfileName string	Policy Profile Name.
profileName string	Profile Name.
protectedManagementFrame string	(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).
radioPolicy string	Radio Policy Enum.
rsnCipherSuiteCcmp256 boolean	Rsn Cipher Suite Ccmp256. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
rsnCipherSuiteGcmp128 boolean	Rsn Cipher Suite Gcmp 128. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
rsnCipherSuiteGcmp256 boolean	Rsn Cipher Suite Gcmp256. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
securityLevel string	Security Level.
sessionTimeOut integer	Session Time Out (Default 1800 if enableSessionTimeOut is true, 0 otherwise).
ssidName string	SsidName path parameter. Enter the SSID name to be deleted.
trafficType string	Traffic Type Enum (voicedata or data ).
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

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
dnac_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)