cisco.dnac.wireless_profile module – Resource module for Wireless Profile

Note

This module is part of the cisco.dnac collection (version 6.24.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operations create, update and delete of the resource Wireless Profile.

  • Creates Wireless Network Profile on Cisco DNA Center and associates sites and SSIDs to it.

  • Delete the Wireless Profile from Cisco DNA Center whose name is provided.

  • Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. This API has been deprecated. Please use the new endpoint URL /dna/intent/api/v2/wireless/profile.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.7.2

  • python >= 3.5

Parameters

Parameter

Comments

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • true

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:

  • false

  • true ← (default)

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: "2.3.7.6"

profileDetails

dictionary

Wireless Profile’s profileDetails.

name

string

Profile Name.

sites

list / elements=string

Array of site name hierarchies(eg “Global/aaa/zzz”, “Global/aaa/zzz”).

ssidDetails

list / elements=dictionary

Wireless Profile’s ssidDetails.

enableFabric

boolean

True if ssid is fabric else false.

Choices:

  • false

  • true

flexConnect

dictionary

Wireless Profile’s flexConnect.

enableFlexConnect

boolean

True if flex connect is enabled else false.

Choices:

  • false

  • true

localToVlan

integer

Local To Vlan Id.

interfaceName

string

Interface Name.

name

string

Ssid Name is required if ssidDetails is passed in PayLoad for mapping to the Network Profile.

policyProfileName

string

Policy Profile Name.

wlanProfileName

string

WLAN Profile Name.

validate_response_schema

boolean

Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

  • false

  • true ← (default)

wirelessProfileName

string

WirelessProfileName path parameter. Wireless Profile Name.

Notes

Note

  • SDK Method used are wireless.Wireless.create_wireless_profile, wireless.Wireless.delete_wireless_profile, wireless.Wireless.update_wireless_profile,

  • Paths used are post /dna/intent/api/v1/wireless/profile, delete /dna/intent/api/v1/wireless-profile/{wirelessProfileName}, put /dna/intent/api/v1/wireless/profile,

  • 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

See Also

See also

Cisco DNA Center documentation for Wireless CreateWirelessProfile

Complete reference of the CreateWirelessProfile API.

Cisco DNA Center documentation for Wireless DeleteWirelessProfile

Complete reference of the DeleteWirelessProfile API.

Cisco DNA Center documentation for Wireless UpdateWirelessProfile

Complete reference of the UpdateWirelessProfile API.

Examples

- name: Delete by name
  cisco.dnac.wireless_profile:
    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
    wirelessProfileName: string

- name: Update all
  cisco.dnac.wireless_profile:
    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
    profileDetails:
      name: string
      sites:
      - string
      ssidDetails:
      - enableFabric: true
        flexConnect:
          enableFlexConnect: true
          localToVlan: 0
        interfaceName: string
        name: string
        policyProfileName: string
        wlanProfileName: string

- name: Create
  cisco.dnac.wireless_profile:
    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
    profileDetails:
      name: string
      sites:
      - string
      ssidDetails:
      - enableFabric: true
        flexConnect:
          enableFlexConnect: true
          localToVlan: 0
        interfaceName: string
        name: string
        policyProfileName: string
        wlanProfileName: 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: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

Authors

  • Rafael Campos (@racampos)