cisco.catalystcenter.wireless_profile module -- Resource module for Wireless Profile

Note

This module is part of the cisco.catalystcenter collection (version 2.2.2).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

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

New in cisco.catalystcenter 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 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.

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 3.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catalystcenter_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catalystcenter_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catalystcenter_host string / required	The Cisco Catalyst Center hostname.
catalystcenter_password string	The Cisco Catalyst Center password to authenticate.
catalystcenter_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catalystcenter_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catalystcenter_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
flexConnect dictionary	Wireless Profile's flexConnect.
enableFlexConnect boolean	True if flex connect is enabled else false. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
localToVlan integer	Local to VLAN ID. Required if enableFlexConnect is true.
interfaceName string	Interface Name.
name string	Ssid Name.
policyProfileName string	Policy Profile Name.
wlanProfileName string	WLAN Profile Name.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`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 uses the embedded connection manager from Cisco CATALYST SDK

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.catalystcenter.wireless_profile:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: absent
    wirelessProfileName: string
- name: Update all
  cisco.catalystcenter.wireless_profile:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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.catalystcenter.wireless_profile:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_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 CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)