cisco.dnac.wireless_provision – Manage WirelessProvision objects of Wireless

Note

This plugin is part of the cisco.dnac collection (version 2.0.7).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.wireless_provision.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Provision wireless devices.

  • Updates wireless provisioning.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
payload
list / elements=dictionary / required
An object to send in the Request body.
deviceName
string / required
It is the wireless provision's deviceName.
dynamicInterfaces
list / elements=dictionary
It is the wireless provision's dynamicInterfaces.
interfaceGateway
string
It is the wireless provision's interfaceGateway.
interfaceIPAddress
string
It is the wireless provision's interfaceIPAddress.
interfaceName
string
It is the wireless provision's interfaceName.
interfaceNetmaskInCIDR
integer
It is the wireless provision's interfaceNetmaskInCIDR.
lagOrPortNumber
integer
It is the wireless provision's lagOrPortNumber.
vlanId
integer
It is the wireless provision's vlanId.
managedAPLocations
list / elements=string
It is the wireless provision's managedAPLocations.
site
string / required
It is the wireless provision's site.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.wireless_provision

The official documentation on the cisco.dnac.plugins.module_utils.definitions.wireless_provision module.

WirelessProvision reference

Complete reference of the WirelessProvision object model.

WirelessProvision reference

SDK reference.

Examples

- name: provision
  cisco.dnac.wireless_provision:
    state: create  # required
    payload:  # required
    - deviceName: SomeValue  # string, required
      site: SomeValue  # string, required
      managedAPLocations:
      - SomeValue  # string
      dynamicInterfaces:
      - interfaceIPAddress: SomeValue  # string
        interfaceNetmaskInCIDR: 1  #  integer
        interfaceGateway: SomeValue  # string
        lagOrPortNumber: 1  #  integer
        vlanId: 1  #  integer
        interfaceName: SomeValue  # string

- name: provision_update
  cisco.dnac.wireless_provision:
    state: update  # required
    payload:  # required
    - deviceName: SomeValue  # string, required
      managedAPLocations:
      - SomeValue  # string
      dynamicInterfaces:
      - interfaceIPAddress: SomeValue  # string
        interfaceNetmaskInCIDR: 1  #  integer
        interfaceGateway: SomeValue  # string
        lagOrPortNumber: 1  #  integer
        vlanId: 1  #  integer
        interfaceName: SomeValue  # string

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary with the response returned by the DNA Center Python SDK

Sample:
{'response': 29, 'version': '1.0'}
missing_params
list / elements=string
when the function request schema is not satisfied
Provided arguments do not comply with the schema of the DNA Center Python SDK function

sdk_function
string
always
The DNA Center SDK function used to execute the task

Sample:
wireless.provision


Authors

  • Rafael Campos (@racampos)