cisco.dnac.wireless_profiles_v1 module -- Resource module for Wireless Profiles V1

Note

This module is part of the cisco.dnac collection (version 6.28.0).

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_profiles_v1.

New in cisco.dnac 6.15.0

Synopsis

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

• This API allows the user to create a Wireless Network Profile.

• This API allows the user to delete Wireless Network Profile by ID.

• This API allows the user to update a Wireless Network Profile by ID.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.4.9

• python >= 3.5

Parameters

Parameter	Comments
additionalInterfaces list / elements=string	These additional interfaces will be configured on the device as independent interfaces in addition to the interfaces mapped to SSIDs. Max Limit 4094.
apZones list / elements=dictionary	Wireless Profiles's apZones.
apZoneName string	AP Zone Name.
rfProfileName string	RF Profile Name.
ssids list / elements=string	Ssids part of apZone.
dnac_debug boolean	Flag for Cisco DNA Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`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: :ansible-option-default:`443`
dnac_username aliases: user string	The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"2.3.7.6"`
id string	Id path parameter. Wireless Profile Id.
ssidDetails list / elements=dictionary	Wireless Profiles's ssidDetails.
anchorGroupName string	Anchor Group Name.
dot11beProfileId string	802.11be Profile Id. Applicable to IOS controllers with version 17.15 and higher. 802.11be Profiles if passed, should be same across all SSIDs in network profile being configured.
enableFabric boolean	True if fabric is enabled, else False. Flex and fabric cannot be enabled simultaneously and a profile can only contain either flex SSIDs or fabric SSIDs and not both at the same time. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
flexConnect dictionary	Wireless Profiles's flexConnect.
enableFlexConnect boolean	True if flex connect is enabled, else False. Flex and fabric cannot be enabled simultaneously and a profile can only contain either flex SSIDs or fabric SSIDs and not both at the same time. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
localToVlan integer	Local to VLAN ID.
interfaceName string	Interface Name.
ssidName string	SSID Name.
vlanGroupName string	VLAN Group 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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
wirelessProfileName string	Wireless Network Profile Name.

Notes

Note

• SDK Method used are wireless.Wireless.create_wireless_profile_connectivity_v1, wireless.Wireless.delete_wireless_profile_connectivity_v1, wireless.Wireless.update_wireless_profile_connectivity_v1,

• Paths used are post /dna/intent/api/v1/wirelessProfiles, delete /dna/intent/api/v1/wirelessProfiles/{id}, put /dna/intent/api/v1/wirelessProfiles/{id},

• 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 CreateWirelessProfileConnectivityV1

Complete reference of the CreateWirelessProfileConnectivityV1 API.

Cisco DNA Center documentation for Wireless DeleteWirelessProfileConnectivityV1

Complete reference of the DeleteWirelessProfileConnectivityV1 API.

Cisco DNA Center documentation for Wireless UpdateWirelessProfileConnectivityV1

Complete reference of the UpdateWirelessProfileConnectivityV1 API.

Examples

- name: Create
  cisco.dnac.wireless_profiles_v1:
    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
    additionalInterfaces:
    - string
    apZones:
    - apZoneName: string
      rfProfileName: string
      ssids:
      - string
    ssidDetails:
    - anchorGroupName: string
      dot11beProfileId: string
      enableFabric: true
      flexConnect:
        enableFlexConnect: true
        localToVlan: 0
      interfaceName: string
      ssidName: string
      vlanGroupName: string
      wlanProfileName: string
    wirelessProfileName: string

- name: Update by id
  cisco.dnac.wireless_profiles_v1:
    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
    additionalInterfaces:
    - string
    apZones:
    - apZoneName: string
      rfProfileName: string
      ssids:
      - string
    id: string
    ssidDetails:
    - anchorGroupName: string
      dot11beProfileId: string
      enableFabric: true
      flexConnect:
        enableFlexConnect: true
        localToVlan: 0
      interfaceName: string
      ssidName: string
      vlanGroupName: string
      wlanProfileName: string
    wirelessProfileName: string

- name: Delete by id
  cisco.dnac.wireless_profiles_v1:
    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
    id: 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: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)