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

Note

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

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

• This module represents an alias of the module wireless_profile_v1

Note

This module has a corresponding action plugin.

Requirements

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

• catalystcentersdk >= 2.3.7.9

• python >= 3.5

Parameters

Parameter	Comments
_api_port integer	The Cisco CATALYST Center port. Default: :ansible-option-default:`443`
_debug boolean	Flag for Cisco CATALYST Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_host string / required	The Cisco CATALYST Center hostname.
_password string	The Cisco CATALYST Center password to authenticate.
_username aliases: user string	The Cisco CATALYST Center username to authenticate. Default: :ansible-option-default:`"admin"`
_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_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_v1, wireless.Wireless.delete_wireless_profile_v1, wireless.Wireless.update_wireless_profile_v1,

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

• It should be noted that this module is an alias of wireless_profile_v1

• 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 CATALYST SDK

• The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Wireless CreateWirelessProfileV1

Complete reference of the CreateWirelessProfileV1 API.

Cisco DNA Center documentation for Wireless DeleteWirelessProfileV1

Complete reference of the DeleteWirelessProfileV1 API.

Cisco DNA Center documentation for Wireless UpdateWirelessProfileV1

Complete reference of the UpdateWirelessProfileV1 API.

Examples

- name: Delete by name
  cisco.catalystcenter.wireless_profile:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    state: absent
    wirelessProfileName: string
- name: Update all
  cisco.catalystcenter.wireless_profile:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC 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)