cisco.dnac.enterprise_ssid (2.0.7) — module

Manage EnterpriseSsid objects of Wireless

| "added in version" 1.0.0 of cisco.dnac"

Authors: Rafael Campos (@racampos)

This plugin has a corresponding action plugin.

Install collection

Install with ansible-galaxy collection install cisco.dnac:==2.0.7


Add to requirements.yml

  collections:
    - name: cisco.dnac
      version: 2.0.7

Description

Gets either one or all the enterprise SSID.

Creates enterprise SSID.

Deletes given enterprise SSID.


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: get_enterprise_ssid
  cisco.dnac.enterprise_ssid:
    state: query  # required
    ssid_name: SomeValue  # string
  register: nm_get_enterprise_ssid
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete_enterprise_ssid
  cisco.dnac.enterprise_ssid:
    state: delete  # required
    ssid_name: SomeValue  # string, required

Inputs

    
name:
    description:
    - Enter SSID Name, property of the request body. Constraint is maxLength set to 32.
    - Required for state create.
    type: str

ssid_name:
    description:
    - '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.
    type: str

passphrase:
    description:
    - '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.

      '
    type: str

radioPolicy:
    description:
    - 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''.

      '
    type: str

trafficType:
    description:
    - Traffic Type, property of the request body.
    - Available values are 'voicedata' and 'data'.
    type: str

securityLevel:
    description:
    - Security Level, property of the request body.
    - Available values are 'WPA2_ENTERPRISE', 'WPA2_PERSONAL' and 'OPEN'.
    - Required for state create.
    type: str

enableFastLane:
    description:
    - EnableFastLane, property of the request body.
    type: bool

fastTransition:
    description:
    - Fast Transition, property of the request body.
    - Available values are 'Adaptive', 'Enable' and 'Disable'.
    type: str

enableMACFiltering:
    description:
    - EnableMACFiltering, property of the request body.
    type: bool

enableBroadcastSSID:
    description:
    - EnableBroadcastSSID, property of the request body.
    type: bool

Outputs

dnac_response:
  description: A dictionary with the response returned by the DNA Center Python SDK
  returned: always
  sample:
    response: 29
    version: '1.0'
  type: dict
missing_params:
  description: Provided arguments do not comply with the schema of the DNA Center
    Python SDK function
  returned: when the function request schema is not satisfied
  sample: null
  type: list
sdk_function:
  description: The DNA Center SDK function used to execute the task
  returned: always
  sample: wireless.create_enterprise_ssid
  type: str

See also