cisco.dnac.wireless_profile – Manage WirelessProfile 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.wireless_profile.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Gets either one or all the wireless network profiles if no name is provided for network-profile.

  • Creates Wireless Network Profile on DNAC and associates sites and SSIDs to it.

  • Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided.

  • Delete the Wireless Profile from DNAC whose name is provided.

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
profile_name
string
ProfileName query parameter.
profileDetails
dictionary / required
Profile Details, property of the request body.
name
string
It is the wireless profile's name.
sites
list / elements=string
It is the wireless profile's sites.
ssidDetails
list / elements=dictionary
It is the wireless profile's ssidDetails.
enableFabric
boolean
    Choices:
  • no
  • yes
It is the wireless profile's enableFabric.
flexConnect
dictionary
It is the wireless profile's flexConnect.
enableFlexConnect
boolean
    Choices:
  • no
  • yes
It is the wireless profile's enableFlexConnect.
localToVlan
integer
It is the wireless profile's localToVlan.
interfaceName
string
It is the wireless profile's interfaceName.
name
string
It is the wireless profile's name.
type
string
It is the wireless profile's type.
wireless_profile_name
string
WirelessProfileName path parameter.
Required for state delete.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.wireless_profile

The official documentation on the cisco.dnac.plugins.module_utils.definitions.wireless_profile module.

WirelessProfile reference

Complete reference of the WirelessProfile object model.

WirelessProfile reference

SDK reference.

Examples

- name: get_wireless_profile
  cisco.dnac.wireless_profile:
    state: query  # required
    profile_name: SomeValue  # string
  register: nm_get_wireless_profile

- name: create_wireless_profile
  cisco.dnac.wireless_profile:
    state: create  # required
    profileDetails:  # required
      name: SomeValue  # string
      sites:
      - SomeValue  # string
      ssidDetails:
      - name: SomeValue  # string
        type: SomeValue  # string
        enableFabric: True  # boolean
        flexConnect:
          enableFlexConnect: True  # boolean
          localToVlan: 1  #  integer
        interfaceName: SomeValue  # string

- name: update_wireless_profile
  cisco.dnac.wireless_profile:
    state: update  # required
    profileDetails:  # required
      name: SomeValue  # string
      sites:
      - SomeValue  # string
      ssidDetails:
      - name: SomeValue  # string
        type: SomeValue  # string
        enableFabric: True  # boolean
        flexConnect:
          enableFlexConnect: True  # boolean
          localToVlan: 1  #  integer
        interfaceName: SomeValue  # string

- name: delete_wireless_profile
  cisco.dnac.wireless_profile:
    state: delete  # required
    wireless_profile_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_wireless_profile


Authors

  • Rafael Campos (@racampos)