cisco.catalystcenter.wireless_provision_device_create_v1 module -- Resource module for Wireless Provision Device Create 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_provision_device_create_v1.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Manage operation create of the resource Wireless Provision Device Create V1.

  • Provision wireless device.

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

payload

list / elements=dictionary

Wireless Provision Device Create's payload.

deviceName

string

Controller Name.

dynamicInterfaces

list / elements=dictionary

Wireless Provision Device Create's dynamicInterfaces.

interfaceGateway

string

Interface Gateway. Required for AireOS.

interfaceIPAddress

string

Interface IP Address. Required for AireOS.

interfaceName

string

Interface Name. Required for both 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 both AireOS and EWLC.

managedAPLocations

list / elements=string

List of managed AP locations (Site Hierarchies).

site

string

Full Site Hierarchy where device has to be assigned.

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

  • Paths used are post /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 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 ProvisionV1

Complete reference of the ProvisionV1 API.

Examples

- name: Create
  cisco.catalystcenter.wireless_provision_device_create_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _debug }}"
    payload:
      - deviceName: string
        dynamicInterfaces:
          - interfaceGateway: string
            interfaceIPAddress: string
            interfaceName: string
            interfaceNetmaskInCIDR: 0
            lagOrPortNumber: 0
            vlanId: 0
        managedAPLocations:
          - string
        site: string

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:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}`

Authors

  • Rafael Campos (@racampos)