cisco.catalystcenter.wireless_access_points_provision module -- Resource module for Wireless Access Points Provision

Note

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

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

New in cisco.catalystcenter 6.15.0

Synopsis

  • Manage operation create of the resource Wireless Access Points Provision. - > This API is used to provision Access Points. Prerequisite Access Point has to be assigned to the site using the API /dna/intent/api/v1/networkDevices/assignToSite/apply.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.1.3.0.0

  • python >= 3.5

Parameters

Parameter

Comments

apZoneName

string

AP Zone Name. A custom AP Zone should be passed if no rfProfileName is provided.

catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

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

networkDevices

list / elements=dictionary

Wireless Access Points Provision's networkDevices.

beamState

string

Beam State (Applicable only for CW9179F AP models).

deviceId

string

Network device ID of access points.

meshRole

string

Mesh Role (Applicable only when AP is in Bridge Mode).

rfProfileName

string

RF Profile Name. RF Profile is not allowed for custom AP Zones.

siteId

string

Site ID.

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

  • Paths used are post /dna/intent/api/v1/wirelessAccessPoints/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

See Also

See also

Cisco DNA Center documentation for Wireless APProvision

Complete reference of the APProvision API.

Examples

---
- name: Create
  cisco.catalystcenter.wireless_access_points_provision:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_api_port: "{{catalystcenter_api_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    apZoneName: string
    networkDevices:
      - beamState: string
        deviceId: string
        meshRole: string
    rfProfileName: string
    siteId: string

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 CATALYST Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)