cisco.dnac.wireless_enterprise_ssid_v1 module – Resource module for Wireless Enterprise Ssid V1

Note

This module is part of the cisco.dnac collection (version 6.27.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_v1.

New in cisco.dnac 3.1.0

Synopsis

  • Manage operations create, update and delete of the resource Wireless Enterprise Ssid V1.

  • 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.4.9

  • python >= 3.5

Parameters

Parameter

Comments

aaaOverride

boolean

Aaa Override.

Choices:

  • false

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

clientExclusionTimeout

integer

Client Exclusion Timeout.

clientRateLimit

float

Client Rate Limit (in bits per second).

coverageHoleDetectionEnable

boolean

Coverage Hole Detection Enable.

Choices:

  • false

  • true

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • 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: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

enableBasicServiceSetMaxIdle

boolean

Enable Basic Service Set Max Idle.

Choices:

  • false

  • true

enableBroadcastSSID

boolean

Enable Broadcase SSID.

Choices:

  • false

  • true

enableClientExclusion

boolean

Enable Client Exclusion.

Choices:

  • false

  • true

enableDirectedMulticastService

boolean

Enable Directed Multicast Service.

Choices:

  • false

  • true

enableFastLane

boolean

Enable FastLane.

Choices:

  • false

  • true

enableMACFiltering

boolean

Enable MAC Filtering.

Choices:

  • false

  • true

enableNeighborList

boolean

Enable Neighbor List.

Choices:

  • false

  • true

enableSessionTimeOut

boolean

Enable Session Timeout.

Choices:

  • false

  • true

fastTransition

string

Fast Transition.

ghz24Policy

string

Ghz24 Policy.

ghz6PolicyClientSteering

boolean

Ghz6 Policy Client Steering.

Choices:

  • false

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

  • false

  • true

rsnCipherSuiteGcmp128

boolean

Rsn Cipher Suite Gcmp 128.

Choices:

  • false

  • true

rsnCipherSuiteGcmp256

boolean

Rsn Cipher Suite Gcmp256.

Choices:

  • false

  • true

securityLevel

string

Security Level.

sessionTimeOut

integer

Session Time Out.

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:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are wireless.Wireless.create_enterprise_ssid_v1, wireless.Wireless.delete_enterprise_ssid_v1, wireless.Wireless.update_enterprise_ssid_v1,

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

Complete reference of the CreateEnterpriseSSIDV1 API.

Cisco DNA Center documentation for Wireless DeleteEnterpriseSSIDV1

Complete reference of the DeleteEnterpriseSSIDV1 API.

Cisco DNA Center documentation for Wireless UpdateEnterpriseSSIDV1

Complete reference of the UpdateEnterpriseSSIDV1 API.

Examples

- 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

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: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

Authors

  • Rafael Campos (@racampos)