W3cubDocs

/Ansible

cisco.dnac.wireless_provision_device_update_v1 module – Resource module for Wireless Provision Device Update V1

Note

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

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

New in cisco.dnac 3.1.0

Synopsis

  • Manage operation update of the resource Wireless Provision Device Update V1.
  • 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 >= 2.4.9
  • python >= 3.5

Parameters

Parameter

Comments

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"

headers

dictionary

Additional headers.

payload

list / elements=dictionary

Wireless Provision Device Update’s payload.

deviceName

string

Controller Name.

dynamicInterfaces

list / elements=dictionary

Wireless Provision Device Update’s dynamicInterfaces.

interfaceGateway

string

Interface Gateway. Required for AireOS.

interfaceIPAddress

string

Interface IP Address. Required for AireOS.

interfaceName

string

Interface Name. Required for AireOS and EWLC.

interfaceNetmaskInCIDR

integer

Interface Netmask In CIDR. Required for AireOS.

lagOrPortNumber

integer

Lag Or Port Number. Required for AireOS.

vlanId

integer

VLAN ID. Required for AireOS and EWLC.

managedAPLocations

list / elements=string

List of managed AP locations (Site Hierarchies).

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.provision_update,
  • Paths used are put /dna/intent/api/v1/wireless/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 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 ProvisionUpdateV1

Complete reference of the ProvisionUpdateV1 API.

Examples

- name: Update all
  cisco.dnac.wireless_provision_device_update_v1:
    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}}"
    headers: '{{my_headers | from_json}}'
    payload:
      - deviceName: string
        dynamicInterfaces:
          - interfaceGateway: string
            interfaceIPAddress: string
            interfaceName: string
            interfaceNetmaskInCIDR: 0
            lagOrPortNumber: 0
            vlanId: 0
        managedAPLocations:
          - 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 DNAC Python SDK

Returned: always

Sample: {"executionId": "string", "executionStatusUrl": "string", "message": "string"}

Authors

  • Rafael Campos (@racampos)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/wireless_provision_device_update_v1_module.html