cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting module -- Resource module for Fabrics Fabric Id Switch Wireless Setting

Note

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

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

New in cisco.catalystcenter 2.0.0

Synopsis

  • Manage operation update of the resource Fabrics Fabric Id Switch Wireless Setting. - > This API is used to enable or disable wireless capabilities on switch devices, along with configuring rolling AP upgrades on the fabric site. Reboot action is required to remove wireless configurations.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

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

Default: :ansible-option-default:`"3.1.6.0"`

fabricId

string

FabricId path parameter. The 'fabricId' represents the Fabric ID of a particular Fabric Site. The 'fabricId' can be obtained using the api /dna/intent/api/v1/sda/fabricSites.

payload

list / elements=dictionary

Fabrics Fabric Id Switch Wireless Setting's payload.

deviceRoles

string

Description.

id

string

Description.

lscPercentage

integer

Permissible values are 1, 5, 15, 25 and 1000. This represents the percentage of access points that can be affected due to certificate renewal execution in the current iteration. This field is applicable only when the selected LSC profile is of staggered execution type. * 1 - 1% of access points will be considered for certificate renewal in each iteration * 5 - 5% of access points will be considered for certificate renewal in each iteration * 15 - 15% of access points will be considered for certificate renewal in each iteration * 25 - 25% of access points will be considered for certificate renewal in each iteration * 1000 - Access points are selected one after another in a serial manner for certificate renewal. The corresponding device option is 'Serial'.

lscProfileName

string

LSC profile name. Obtain the LSC profile names by using the GET API call /dna/intent/api/v1/wirelessSettings/lscRenewalProfiles.

rollingApUpgrade

dictionary

Fabrics Fabric Id Switch Wireless Setting's rollingApUpgrade.

apRebootPercentage

integer

AP Reboot Percentage. Permissible values - 1, 5, 15, 25 and 1000 * 1 - 1% of access points will be rebooted in each iteration * 5 - 5% of access points will be rebooted in each iteration * 15 - 15% of access points will be rebooted in each iteration * 25 - 25% of access points will be rebooted in each iteration * 1000 - Access points are rebooted one after another in a serial manner. The corresponding device option is labeled 'Serial'.

enableRollingApUpgrade

boolean

True if Rolling AP Upgrade is enabled, else False.

Choices:

validate_response_schema

boolean

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

Choices:

Notes

Note

  • SDK Method used are fabric_wireless.FabricWireless.switch_wireless_setting_and_rolling_ap_upgrade_management,

  • Paths used are put /dna/intent/api/v1/sda/fabrics/{fabricId}/switchWirelessSetting,

  • 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

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Fabric Wireless SwitchWirelessSettingAndRollingAPUpgradeManagement

Complete reference of the SwitchWirelessSettingAndRollingAPUpgradeManagement API.

Examples

---
- name: Update all
  cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    state: present
    enableWireless: true
    fabricId: e290f1ee-6c54-4b01-90e6-d701748f0851
    id: 5259d6b3-3569-405f-9c5f-4d642809add2
    lscPercentage: 1000
    lscProfileName: autoLscStraggeredProfile
    rollingApUpgrade:
      apRebootPercentage: 1000
      enableRollingApUpgrade: true

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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)