cisco.dnac.wireless_controllers_provision module – Resource module for Wireless Controllers Provision

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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

New in cisco.dnac 6.15.0

Synopsis

  • This module represents an alias of the module wireless_controllers_provision_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

deviceId

string

DeviceId path parameter. Network Device ID. This value can be obtained by using the API call GET /dna/intent/api/v1/network-device/ip-address/${ipAddress}.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

  • false ← (default)

  • 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: 443

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: "admin"

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

  • false

  • true ← (default)

dnac_version

string

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

Default: "2.3.7.6"

interfaces

list / elements=dictionary

Wireless Controllers Provision’s interfaces.

interfaceGateway

string

Interface Gateway.

interfaceIPAddress

string

Interface IP Address.

interfaceName

string

Interface Name.

interfaceNetmaskInCIDR

integer

Interface Netmask In CIDR, range is 1-30.

lagOrPortNumber

integer

Lag Or Port Number.

vlanId

integer

VLAN ID range is 1 - 4094.

rollingApUpgrade

dictionary

Wireless Controllers Provision’s rollingApUpgrade.

apRebootPercentage

integer

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

enableRollingApUpgrade

boolean

True if Rolling AP Upgrade is enabled, else False.

Choices:

  • false

  • true

skipApProvision

boolean

True if Skip AP Provision is enabled, else False.

Choices:

  • false

  • true

validate_response_schema

boolean

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

Choices:

  • false

  • true ← (default)

Notes

Note

  • SDK Method used are wireless.Wireless.wireless_controller_provision_v1,

  • Paths used are post /dna/intent/api/v1/wirelessControllers/{deviceId}/provision,

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

Complete reference of the WirelessControllerProvisionV1 API.

Examples

- name: Create
  cisco.dnac.wireless_controllers_provision:
    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}}"
    deviceId: string
    interfaces:
    - interfaceGateway: string
      interfaceIPAddress: string
      interfaceName: string
      interfaceNetmaskInCIDR: 0
      lagOrPortNumber: 0
      vlanId: 0
    rollingApUpgrade:
      apRebootPercentage: 0
      enableRollingApUpgrade: true
    skipApProvision: 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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)