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

New in cisco.catalystcenter 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.

• 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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
_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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
_version string	Informs the SDK which version of Cisco CATALYST Center to use. Default: :ansible-option-default:`"2.3.7.6"`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
dtlsHighCipher boolean	DTLS High Cipher. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`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 CATALYST Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`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 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 MobilityProvisionV1

Complete reference of the MobilityProvisionV1 API.

Examples

- name: Create
  cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_v1:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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
catalystcenter_response dictionary	A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)