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

Note

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

To use it in a playbook, specify: cisco.dnac.wireless_enterprise_ssid.

New in version 3.1.0: of cisco.dnac

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

• python >= 3.5

Parameters

Parameter	Comments
basicServiceSetClientIdleTimeout integer	Basic Service Set Client Idle Timeout.
clientExclusionTimeout integer	Client Exclusion Timeout.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: no ← (default) yes
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: no yes ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: “2.2.3.3”
enableBasicServiceSetMaxIdle boolean	Enable Basic Service Set Max Idle. Choices: no yes
enableBroadcastSSID boolean	Enable Broadcast SSID. Choices: no yes
enableClientExclusion boolean	Enable Client Exclusion. Choices: no yes
enableDirectedMulticastService boolean	Enable Directed Multicast Service. Choices: no yes
enableFastLane boolean	Enable Fast Lane. Choices: no yes
enableMACFiltering boolean	Enable MAC Filtering. Choices: no yes
enableNeighborList boolean	Enable Neighbor List. Choices: no yes
enableSessionTimeOut boolean	Enable Session Timeout. Choices: no yes
fastTransition string	Fast Transition.
mfpClientProtection string	Management Frame Protection Client.
name string	Enter SSID Name.
passphrase string	Pass Phrase (Only applicable for SSID with PERSONAL security level).
radioPolicy string	Radio Policy. Allowed values are ‘Dual band operation (2.4GHz and 5GHz)’, ‘Dual band operation with band select’, ‘5GHz only’, ‘2.4GHz only’.
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.
validate_response_schema boolean	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices: no yes ← (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

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
    basicServiceSetClientIdleTimeout: 0
    clientExclusionTimeout: 0
    enableBasicServiceSetMaxIdle: true
    enableBroadcastSSID: true
    enableClientExclusion: true
    enableDirectedMulticastService: true
    enableFastLane: true
    enableMACFiltering: true
    enableNeighborList: true
    enableSessionTimeOut: true
    fastTransition: string
    mfpClientProtection: string
    name: string
    passphrase: string
    radioPolicy: string
    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
    basicServiceSetClientIdleTimeout: 0
    clientExclusionTimeout: 0
    enableBasicServiceSetMaxIdle: true
    enableBroadcastSSID: true
    enableClientExclusion: true
    enableDirectedMulticastService: true
    enableFastLane: true
    enableMACFiltering: true
    enableNeighborList: true
    enableSessionTimeOut: true
    fastTransition: string
    mfpClientProtection: string
    name: string
    passphrase: string
    radioPolicy: string
    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: “{\n \”executionId\”: \”string\”,\n \”executionStatusUrl\”: \”string\”,\n \”message\”: \”string\”\n}\n”

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)