cisco.dnac.ssid (2.0.7) — module

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

Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites.

Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center.

Requirements

• dnacentersdk

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: create_and_provision_ssid
  cisco.dnac.ssid:
    state: create  # required
    enableFabric: True  # boolean, required
    managedAPLocations:  # required
    - SomeValue  # string
    ssidDetails:  # required
      name: SomeValue  # string
      securityLevel: SomeValue  # string
      enableFastLane: True  # boolean
      passphrase: SomeValue  # string
      trafficType: SomeValue  # string
      enableBroadcastSSID: True  # boolean
      radioPolicy: SomeValue  # string
      enableMACFiltering: True  # boolean
      fastTransition: SomeValue  # string
      webAuthURL: SomeValue  # string
    ssidType: # valid values are 'Guest',
      # 'Enterprise'.
      SomeValue  # string, required
    flexConnect:
      enableFlexConnect: True  # boolean
      localToVlan: 1  #  integer

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: delete_ssid_and_provision_it_to_devices
  cisco.dnac.ssid:
    state: delete  # required
    managed_aplocations: SomeValue  # string, required
    ssid_name: SomeValue  # string, required

Inputs

    
ssidType:
    description:
    - SSID Type, property of the request body.
    - Available values are 'Guest' and 'Enterprise'.
    - Required for state create.
    type: str

ssid_name:
    description:
    - SsidName path parameter.
    - Required for state delete.
    type: str

flexConnect:
    description:
    - Flex Connect - Applicable for non fabric profile, property of the request body.
    suboptions:
      enableFlexConnect:
        description:
        - It is the Ssid's enableFlexConnect.
        type: bool
      localToVlan:
        description:
        - It is the Ssid's localToVlan.
        type: int
    type: dict

ssidDetails:
    description:
    - SsidDetails, property of the request body.
    - Required for state create.
    suboptions:
      enableBroadcastSSID:
        description:
        - It is the Ssid's enableBroadcastSSID.
        type: bool
      enableFastLane:
        description:
        - It is the Ssid's enableFastLane.
        type: bool
      enableMACFiltering:
        description:
        - It is the Ssid's enableMACFiltering.
        type: bool
      fastTransition:
        description:
        - It is the Ssid's fastTransition.
        type: str
      name:
        description:
        - It is the Ssid's name.
        type: str
      passphrase:
        description:
        - It is the Ssid's passphrase.
        type: str
      radioPolicy:
        description:
        - It is the Ssid's radioPolicy.
        type: str
      securityLevel:
        description:
        - It is the Ssid's securityLevel.
        type: str
      trafficType:
        description:
        - It is the Ssid's trafficType.
        type: str
      webAuthURL:
        description:
        - It is the Ssid's webAuthURL.
        type: str
    type: dict

enableFabric:
    description:
    - EnableFabric, property of the request body.
    - Required for state create.
    type: bool

managedAPLocations:
    description:
    - Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body
      (list of strings).
    - Required for state create.
    type: list

managed_aplocations:
    description:
    - ManagedAPLocations path parameter.
    - Required for state delete.
    type: str

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_and_provision_ssid
  type: str

See also

• cisco.dnac.plugins.module_utils.definitions.ssid
• Ssid reference: Complete reference of the Ssid object model. link
• Ssid reference: SDK reference. link