cisco.dnac.wireless_controllers_wireless_mobility_groups_mobility_provision_v1 module – Resource module for Wireless Controllers Wireless Mobility Groups Mobility Provision V1

Note

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

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

New in cisco.dnac 6.15.0

Synopsis

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

  • This API is used to provision/deploy wireless mobility into Cisco wireless controllers.

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

dataLinkEncryption

boolean

A secure link in which data is encrypted using CAPWAP DTLS protocol can be established between two controllers. This value will be applied to all peers during POST operation.

Choices:

  • false

  • true

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"

dtlsHighCipher

boolean

DTLS High Cipher.

Choices:

  • false

  • true

macAddress

string

Device mobility MAC Address. Allowed formats are 0a0b.0c01.0211, 0a0b0c010211, 0a 0b 0c 01 02 11.

managementIp

string

Self device wireless Management IP.

mobilityGroupName

string

Self device Group Name. Must be alphanumeric without {!,<,space,?/’} and maximum of 31 characters.

mobilityPeers

list / elements=dictionary

Wireless Controllers Wireless Mobility Groups Mobility Provision’s mobilityPeers.

deviceSeries

string

Indicates peer device mobility belongs to AireOS or IOX-XE family. 0 - indicates AireOS and 1 - indicates C9800.

hashKey

string

SSC hash string must be 40 characters.

memberMacAddress

string

Peer device mobility MAC Address. Allowed formats are 0a0b.0c01.0211, 0a0b0c010211, 0a 0b 0c 01 02 11.

mobilityGroupName

string

Peer Device mobility group Name. Must be alphanumeric without {!,<,space,?/’} and maximum of 31 characters.

peerDeviceName

string

Peer device Host Name.

peerIp

string

This indicates public ip address.

peerNetworkDeviceId

string

The possible values are UNKNOWN or valid UUID of Network device Id. UNKNOWN represents out of band device which is not managed internally. Valid UUID represents WLC network device id.

privateIpAddress

string

This indicates private/management ip address.

networkDeviceId

string

Obtain the network device ID value by using the API call GET /dna/intent/api/v1/network-device/ip-…

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

  • Paths used are post /dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups/mobilityProvision,

  • 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 MobilityProvisionV1

Complete reference of the MobilityProvisionV1 API.

Examples

- name: Create
  cisco.dnac.wireless_controllers_wireless_mobility_groups_mobility_provision_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}}"
    dataLinkEncryption: true
    dtlsHighCipher: true
    macAddress: string
    managementIp: string
    mobilityGroupName: string
    mobilityPeers:
    - deviceSeries: string
      hashKey: string
      memberMacAddress: string
      mobilityGroupName: string
      peerDeviceName: string
      peerIp: string
      peerNetworkDeviceId: string
      privateIpAddress: string
    networkDeviceId: 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: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Authors

  • Rafael Campos (@racampos)