cisco.dnac.enterprise_ssid – Manage EnterpriseSsid objects of Wireless¶

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

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

New in version 1.0.0: of cisco.dnac

Synopsis
Requirements
Parameters
See Also
Examples
Return Values

Synopsis ¶

Gets either one or all the enterprise SSID.
Creates enterprise SSID.
Deletes given enterprise SSID.

Note

This module has a corresponding action plugin.

Requirements ¶

The below requirements are needed on the host that executes this module.

dnacentersdk

Parameters ¶

Parameter	Choices/Defaults	Comments
enableBroadcastSSID boolean	Choices: no yes	EnableBroadcastSSID, property of the request body.
enableFastLane boolean	Choices: no yes	EnableFastLane, property of the request body.
enableMACFiltering boolean	Choices: no yes	EnableMACFiltering, property of the request body.
fastTransition string		Fast Transition, property of the request body. Available values are 'Adaptive', 'Enable' and 'Disable'.
name string		Enter SSID Name, property of the request body. Constraint is maxLength set to 32. Required for state create.
passphrase string		Pass Phrase (Only applicable for SSID with PERSONAL security level), property of the request body. Constraints are maxLength set to 63 and minLength set to 8.
radioPolicy string		Radio Policy, property of the request body. Available values are 'Dual band operation (2.4GHz and 5GHz)', 'Dual band operation with band select', '5GHz only' and '2.4GHz only'.
securityLevel string		Security Level, property of the request body. Available values are 'WPA2_ENTERPRISE', 'WPA2_PERSONAL' and 'OPEN'. Required for state create.
ssid_name string		Enter the enterprise SSID name that needs to be retrieved. If not entered, all the enterprise SSIDs will be retrieved. Enter the SSID name to be deleted. Required for state delete.
trafficType string		Traffic Type, property of the request body. Available values are 'voicedata' and 'data'.

Examples ¶

- name: get_enterprise_ssid
  cisco.dnac.enterprise_ssid:
    state: query  # required
    ssid_name: SomeValue  # string
  register: nm_get_enterprise_ssid

- name: create_enterprise_ssid
  cisco.dnac.enterprise_ssid:
    state: create  # required
    name: SomeValue  # string, required
    securityLevel: # valid values are 'WPA2_ENTERPRISE',
      # 'WPA2_PERSONAL',
      # 'OPEN'.
      SomeValue  # string, required
    enableBroadcastSSID: True  # boolean
    enableFastLane: True  # boolean
    enableMACFiltering: True  # boolean
    fastTransition: # valid values are 'Adaptive',
      # 'Enable',
      # 'Disable'.
      SomeValue  # string
    passphrase: SomeValue  # string
    radioPolicy: # valid values are 'Dual band operation (2.4GHz and 5GHz)',
      # 'Dual band operation with band select',
      # '5GHz only',
      # '2.4GHz only'.
      SomeValue  # string
    trafficType: # valid values are 'voicedata',
      # 'data'.
      SomeValue  # string

- name: delete_enterprise_ssid
  cisco.dnac.enterprise_ssid:
    state: delete  # required
    ssid_name: SomeValue  # string, required

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: wireless.create_enterprise_ssid

Authors¶

Rafael Campos (@racampos)

cisco.dnac.enterprise_ssid – Manage EnterpriseSsid objects of Wireless¶

Synopsis¶

Requirements¶

Parameters¶

See Also¶

Examples¶

Return Values¶