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

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

New in cisco.dnac 6.17.0

Synopsis

  • This module represents an alias of the module fabrics_fabric_id_switch_wireless_setting_v1

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

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

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:

dnac_version

string

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

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

enableWireless

boolean

Enable Wireless.

Choices:

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. Example e290f1ee-6c54-4b01-90e6-d701748f0851.

id

string

Network Device ID of the wireless capable switch.

rollingApUpgrade

dictionary

Fabrics Fabric Id Switch Wireless Setting's rollingApUpgrade.

apRebootPercentage

integer

AP Reboot Percentage. Permissible values - 5, 15, 25.

enableRollingApUpgrade

boolean

Enable Rolling Ap Upgrade.

Choices:

validate_response_schema

boolean

Flag for Cisco DNA 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_v1,

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

  • It should be noted that this module is an alias of fabrics_fabric_id_switch_wireless_setting_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 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 Fabric Wireless SwitchWirelessSettingAndRollingAPUpgradeManagementV1

Complete reference of the SwitchWirelessSettingAndRollingAPUpgradeManagementV1 API.

Examples

- name: Update all
  cisco.dnac.fabrics_fabric_id_switch_wireless_setting:
    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
    enableWireless: true
    fabricId: string
    id: string
    rollingApUpgrade:
      apRebootPercentage: 0
      enableRollingApUpgrade: true

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)