.. 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_provision_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_controllers_provision module -- Resource module for Wireless Controllers 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_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\_provision\_v1 .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_controllers_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_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_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_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_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_provision_module__parameter-_username: .. _ansible_collections.cisco.catalystcenter.wireless_controllers_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_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_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_provision_module__parameter-apauthorizationlistname: .. rst-class:: ansible-option-title **apAuthorizationListName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AP Authorization List name. 'Obtain the AP Authorization List names by using the API call GET /intent/api/v1/wirelessSettings/apAuthorizationLists. During re-provision, obtain the AP Authorization List configured for the given provisioned network device Id using the API call GET /intent/api/v1/wireless/apAuthorizationLists/{networkDev... .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-authorizemeshandnonmeshaccesspoints: .. rst-class:: ansible-option-title **authorizeMeshAndNonMeshAccessPoints** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True if AP Authorization List should authorize against All Mesh/Non-Mesh APs, else false if AP Authorization List should only authorize against Mesh APs (Applicable only when Mesh is enabled on sites). .. 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_provision_module__parameter-deviceid: .. rst-class:: ansible-option-title **deviceId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
DeviceId path parameter. Network Device ID. This value can be obtained by using the API call GET /dna/intent/api/v1/network-device/ip-address/${ipAddress}. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-interfaces: .. rst-class:: ansible-option-title **interfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Provision's interfaces. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-interfaces/interfacegateway: .. rst-class:: ansible-option-title **interfaceGateway** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Interface Gateway. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-interfaces/interfaceipaddress: .. rst-class:: ansible-option-title **interfaceIPAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Interface IP Address. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-interfaces/interfacename: .. rst-class:: ansible-option-title **interfaceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Interface Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-interfaces/interfacenetmaskincidr: .. rst-class:: ansible-option-title **interfaceNetmaskInCIDR** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Interface Netmask In CIDR, range is 1-30. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-interfaces/lagorportnumber: .. rst-class:: ansible-option-title **lagOrPortNumber** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Lag Or Port Number. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-interfaces/vlanid: .. rst-class:: ansible-option-title **vlanId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
VLAN ID range is 1 - 4094. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-rollingapupgrade: .. rst-class:: ansible-option-title **rollingApUpgrade** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Controllers Provision's rollingApUpgrade. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-rollingapupgrade/aprebootpercentage: .. rst-class:: ansible-option-title **apRebootPercentage** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
AP Reboot Percentage. Permissible values - 5, 15, 25. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_controllers_provision_module__parameter-rollingapupgrade/enablerollingapupgrade: .. rst-class:: ansible-option-title **enableRollingApUpgrade** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True if Rolling AP Upgrade is enabled, else False. .. 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_provision_module__parameter-skipapprovision: .. rst-class:: ansible-option-title **skipApProvision** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
True if Skip AP Provision is enabled, else False. .. 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_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.wireless\_controller\_provision\_v1, - Paths used are post /dna/intent/api/v1/wirelessControllers/{deviceId}/provision, - It should be noted that this module is an alias of wireless\_controllers\_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 WirelessControllerProvisionV1 `_ Complete reference of the WirelessControllerProvisionV1 API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.catalystcenter.wireless_controllers_provision: _host: "{{ _host }}" _username: "{{ _username }}" _password: "{{ _password }}" _verify: "{{ _verify }}" _api_port: "{{ _api_port }}" _version: "{{ _version }}" _debug: "{{ _debug }}" apAuthorizationListName: string authorizeMeshAndNonMeshAccessPoints: true deviceId: string interfaces: - interfaceGateway: string interfaceIPAddress: string interfaceName: string interfaceNetmaskInCIDR: 0 lagOrPortNumber: 0 vlanId: 0 rollingApUpgrade: apRebootPercentage: 0 enableRollingApUpgrade: true skipApProvision: true .. 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_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