.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision module -- Resource module for Wireless Controllers Wireless Mobility Groups Mobility Provision ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.1.4). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 6.15.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - This module represents an alias of the module wireless\_controllers\_wireless\_mobility\_groups\_mobility\_provision\_v1 .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 2.3.7.9 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-_api_port: .. rst-class:: ansible-option-title **_api_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-_debug: .. rst-class:: ansible-option-title **_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco CATALYST Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-_host: .. rst-class:: ansible-option-title **_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-_password: .. rst-class:: ansible-option-title **_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-_username: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-user: .. rst-class:: ansible-option-title **_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco CATALYST Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-_verify: .. rst-class:: ansible-option-title **_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-_version: .. rst-class:: ansible-option-title **_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco CATALYST Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-datalinkencryption: .. rst-class:: ansible-option-title **dataLinkEncryption** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-dtlshighcipher: .. rst-class:: ansible-option-title **dtlsHighCipher** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
DTLS High Cipher. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-macaddress: .. rst-class:: ansible-option-title **macAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Device mobility MAC Address. Allowed formats are 0a0b.0c01.0211, 0a0b0c010211, 0a 0b 0c 01 02 11. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-managementip: .. rst-class:: ansible-option-title **managementIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Self device wireless Management IP. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitygroupname: .. rst-class:: ansible-option-title **mobilityGroupName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Self device Group Name. Must be alphanumeric without {!,\<,space,?/'} and maximum of 31 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers: .. rst-class:: ansible-option-title **mobilityPeers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Wireless Mobility Groups Mobility Provision's mobilityPeers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/deviceseries: .. rst-class:: ansible-option-title **deviceSeries** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Indicates peer device mobility belongs to AireOS or IOX-XE family. 0 - indicates AireOS and 1 - indicates C9800. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/hashkey: .. rst-class:: ansible-option-title **hashKey** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SSC hash string must be 40 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/membermacaddress: .. rst-class:: ansible-option-title **memberMacAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Peer device mobility MAC Address. Allowed formats are 0a0b.0c01.0211, 0a0b0c010211, 0a 0b 0c 01 02 11. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/mobilitygroupname: .. rst-class:: ansible-option-title **mobilityGroupName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Peer Device mobility group Name. Must be alphanumeric without {!,\<,space,?/'} and maximum of 31 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/peerdevicename: .. rst-class:: ansible-option-title **peerDeviceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Peer device Host Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/peerip: .. rst-class:: ansible-option-title **peerIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This indicates public ip address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/peernetworkdeviceid: .. rst-class:: ansible-option-title **peerNetworkDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-mobilitypeers/privateipaddress: .. rst-class:: ansible-option-title **privateIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This indicates private/management ip address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-networkdeviceid: .. rst-class:: ansible-option-title **networkDeviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Obtain the network device ID value by using the API call GET /dna/intent/api/v1/network-device/ip-... .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.mobility\_provision\_v1, - Paths used are post /dna/intent/api/v1/wirelessControllers/wirelessMobilityGroups/mobilityProvision, - It should be noted that this module is an alias of wireless\_controllers\_wireless\_mobility\_groups\_mobility\_provision\_v1 - Does not support \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Wireless MobilityProvisionV1 `_ Complete reference of the MobilityProvisionV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision: _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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_wireless_mobility_groups_mobility_provision_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors