.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting module -- Resource module for Fabrics Fabric Id Switch Wireless Setting ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-fabricid: .. rst-class:: ansible-option-title **fabricId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload: .. rst-class:: ansible-option-title **payload** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Fabrics Fabric Id Switch Wireless Setting's payload. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload/deviceroles: .. rst-class:: ansible-option-title **deviceRoles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload/lscpercentage: .. rst-class:: ansible-option-title **lscPercentage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload/lscprofilename: .. rst-class:: ansible-option-title **lscProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
LSC profile name. Obtain the LSC profile names by using the GET API call /dna/intent/api/v1/wirelessSettings/lscRenewalProfiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload/rollingapupgrade: .. rst-class:: ansible-option-title **rollingApUpgrade** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Fabrics Fabric Id Switch Wireless Setting's rollingApUpgrade. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload/rollingapupgrade/aprebootpercentage: .. rst-class:: ansible-option-title **apRebootPercentage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-payload/rollingapupgrade/enablerollingapupgrade: .. rst-class:: ansible-option-title **enableRollingApUpgrade** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True if Rolling AP Upgrade is enabled, else False. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Fabric Wireless SwitchWirelessSettingAndRollingAPUpgradeManagement `_ Complete reference of the SwitchWirelessSettingAndRollingAPUpgradeManagement API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.fabrics_fabric_id_switch_wireless_setting_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors