cisco.catalystcenter.wireless_controllers_provision_v1 module -- Resource module for Wireless Controllers Provision V1

Note

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

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

New in cisco.catalystcenter 6.15.0

Synopsis

  • Manage operation create of the resource Wireless Controllers Provision V1.

  • 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 >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

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

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:

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

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:

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_v1,

  • 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 the embedded connection manager from Cisco CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST 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.catalystcenter.wireless_controllers_provision_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    apAuthorizationListName: string
    authorizeMeshAndNonMeshAccessPoints: true
    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

catalystcenter_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)