cisco.catalystcenter.wireless_controllers_provision module -- Resource module for Wireless Controllers Provision

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

New in cisco.catalystcenter 1.0.0

Synopsis

  • Manage operation create of the resource Wireless Controllers Provision.

  • This API is used to provision wireless controller.

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

apAuthorizationListName

string

AP Authorization List name. 'Obtain the AP Authorization List names by using the API call GET /intent/api/v1/wirelessSettings/apAuthorizationLists. During re-provision, obtain the AP Authorization List configured for the given provisioned network device Id using the API call GET /intent/api/v1/wireless/apAuthorizationLists/{networkDev... (Mandatory for Mesh and Remote Teleworker enabled sites).

authorizeMeshAndNonMeshAccessPoints

boolean

True if AP Authorization List should authorize against All Mesh/Non-Mesh APs, else false if AP Authorization List should only authorize against Mesh APs (Applicable only when Mesh is enabled on sites).

Choices:

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"`

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

featureTemplatesOverridenAttributes

dictionary

Wireless Controllers Provision's featureTemplatesOverridenAttributes.

editFeatureTemplates

list / elements=dictionary

This array consists of Feature Templates that need to be overridden during the provisioning process for the current provision instance. These edits will not alter the original designs of the Feature Templates but will only apply to the values for the current provisioning instance. Note Locked attributes cannot be edited in the Provision API. Additionally, default feature templates ('systemTemplate') cannot be included in the payload, as they are not editable.

additionalIdentifiers

dictionary

Wireless Controllers Provision's additionalIdentifiers.

siteUuid

string

Site UUID. This must be provided if `featureTemplateId` belongs to `Flex Configuration` feature template.

wlanProfileName

string

WLAN Profile Name. This must be passed if `featureTemplateId` belongs to `Advanced SSID Configuration` Feature Template.

attributes

dictionary

This dynamic map should contain attribute name and overridden value of respective Feature Template whose `featureTemplateId`. List of attributes applicable to given `featureTemplateId` can be retrieved from its GET API call /dna/intent/api/v1/featureTemplates/wireless/<featureTemplateName>/featureTemplateId.

excludedAttributes

list / elements=string

List of attributes which will NOT be provisioned.

featureTemplateId

string

Feature Template ID.

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.

ipV6Addresses

list / elements=dictionary

Wireless Controllers Provision's ipV6Addresses.

ipAddress

string

IpV6 Address for the Dynamic Interface.

prefixLength

float

The network portion of an address, indicating how many of the leftmost bits are used for the network identifier.

lagOrPortNumber

integer

Lag Or Port Number.

vlanId

integer

VLAN ID range is 1 - 4094.

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 API call GET /dna/intent/api/v1/wirelessSettings/lscRenewalProfiles.

natIpAddress

string

NAT IP Address that can be configured for Remote Teleworker enabled controller.

rollingApUpgrade

dictionary

Rolling AP Upgrade.

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:

skipApProvision

boolean

True if Skip AP Provision 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 wireless.Wireless.wireless_controller_provision,

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

  • 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 Wireless WirelessControllerProvision

Complete reference of the WirelessControllerProvision API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_controllers_provision:
    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}}"
    apAuthorizationListName: string
    authorizeMeshAndNonMeshAccessPoints: true
    deviceId: string
    featureTemplatesOverridenAttributes:
      editFeatureTemplates:
        - additionalIdentifiers:
            siteUuid: string
            wlanProfileName: string
          attributes: {}
          excludedAttributes:
            - string
          featureTemplateId: string
    interfaces:
      - interfaceGateway: string
        interfaceIPAddress: string
        interfaceName: string
        interfaceNetmaskInCIDR: 0
        ipV6Addresses:
          - ipAddress: string
            prefixLength: 0
        lagOrPortNumber: 0
        vlanId: 0
    lscPercentage: 0
    lscProfileName: string
    natIpAddress: string
    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

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)