.. 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_settings_anchor_groups_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_settings_anchor_groups module -- Resource module for Wireless Settings Anchor Groups ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). 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_settings_anchor_groups`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Wireless Settings Anchor Groups. - This API allows the user to create an anchor group. - This API allows the user to delete an Anchor Group by specifying the AnchorGroup ID. - This API allows the user to update an anchor group. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. 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_settings_anchor_groups_module__parameter-anchorgroupname: .. rst-class:: ansible-option-title **anchorGroupName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Anchor Group Name. Max length is 32 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. 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_settings_anchor_groups_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. 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_settings_anchor_groups_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. 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_settings_anchor_groups_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. 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_settings_anchor_groups_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, 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_settings_anchor_groups_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. 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_settings_anchor_groups_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. 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:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. AnchorGroup ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-mobilityanchors: .. rst-class:: ansible-option-title **mobilityAnchors** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Peer details. Maximum 24 peers are allowed. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-mobilityanchors/anchorpriority: .. rst-class:: ansible-option-title **anchorPriority** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
This indicates anchor priority. Priority values range from 1 (high) to 3 (low). Primary, secondary or tertiary and defined priority is displayed with guest anchor. Only one priority value is allowed per anchor WLC. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-mobilityanchors/devicename: .. rst-class:: ansible-option-title **deviceName** .. 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_settings_anchor_groups_module__parameter-mobilityanchors/ipaddress: .. rst-class:: ansible-option-title **ipAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv4 address in dotted decimal notation (e.g., 192.168.1.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-mobilityanchors/macaddress: .. rst-class:: ansible-option-title **macAddress** .. 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_settings_anchor_groups_module__parameter-mobilityanchors/managedanchorwlc: .. rst-class:: ansible-option-title **managedAnchorWlc** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
This indicates whether the Wireless LAN Controller supporting Anchor is managed by the Network Controller or not. True means this is managed by Network Controller. .. 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_settings_anchor_groups_module__parameter-mobilityanchors/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_settings_anchor_groups_module__parameter-mobilityanchors/peerdevicetype: .. rst-class:: ansible-option-title **peerDeviceType** .. 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_settings_anchor_groups_module__parameter-mobilityanchors/peeripv6address: .. rst-class:: ansible-option-title **peerIpV6Address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv6 address in standard notation (e.g., 2001 db8 1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-mobilityanchors/privateip: .. rst-class:: ansible-option-title **privateIp** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv4 address in dotted decimal notation (e.g., 192.168.1.1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_module__parameter-mobilityanchors/privateipv6address: .. rst-class:: ansible-option-title **privateIpV6Address** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
IPv6 address in standard notation (e.g., 2001 db8 1). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_anchor_groups_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.create\_anchor\_group, wireless.Wireless.delete\_anchor\_group\_by\_id, wireless.Wireless.update\_anchor\_group, - Paths used are post /dna/intent/api/v1/wirelessSettings/anchorGroups, delete /dna/intent/api/v1/wirelessSettings/anchorGroups/{id}, put /dna/intent/api/v1/wirelessSettings/anchorGroups/{id}, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, - but instead uses the embedded connection manager from Cisco CATALYST SDK - Requires Python \>= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Wireless CreateAnchorGroup `_ Complete reference of the CreateAnchorGroup API. `Cisco Catalyst Center documentation for Wireless DeleteAnchorGroupByID `_ Complete reference of the DeleteAnchorGroupByID API. `Cisco Catalyst Center documentation for Wireless UpdateAnchorGroup `_ Complete reference of the UpdateAnchorGroup API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Update by id cisco.catalystcenter.wireless_settings_anchor_groups: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_debug}}" state: present anchorGroupName: anchorGroup01 id: string mobilityAnchors: - anchorPriority: PRIMARY deviceName: ewlc-NS-01-ipv4-single-stack ipAddress: 19.19.19.19 managedAnchorWlc: true - anchorPriority: SECONDARY deviceName: ewlc-NS-02-ipv6-single-stack managedAnchorWlc: true peerIpV6Address: 2001:db8:3c4d:15::1a2f:1a2b - anchorPriority: SECONDARY deviceName: ewlc-NS-03-ipv6-dual-stack ipAddress: 29.29.29.29 managedAnchorWlc: true peerIpV6Address: 2001:db8:3c4d:15::1a2f:1a3b - anchorPriority: SECONDARY deviceName: ewlc-NS-04-external-ipv4 ipAddress: 31.31.31.31 macAddress: 22:33:55:55:77:89 managedAnchorWlc: false mobilityGroupName: default peerDeviceType: IOS-XE privateIp: 12.12.12.12 - anchorPriority: SECONDARY deviceName: ewlc-NS-05-external-ipv6 macAddress: 22:33:55:55:77:90 managedAnchorWlc: false mobilityGroupName: default peerDeviceType: IOS-XE peerIpV6Address: 2001:db8:3c4d:15::1a2f:1aaa privateIpV6Address: 2001:db8:3c4d:15::1a2f:1111 - anchorPriority: SECONDARY deviceName: ewlc-NS-05-external-dual-stack ipAddress: 41.41.41.41 macAddress: 22:33:55:55:77:91 managedAnchorWlc: false mobilityGroupName: default peerDeviceType: IOS-XE peerIpV6Address: 2001:db8:3c4d:15::1a2f:1bbb privateIp: 12.12.12.12 privateIpV6Address: 2001:db8:3c4d:15::1a2f:1111 - name: Delete by id cisco.catalystcenter.wireless_settings_anchor_groups: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_debug}}" state: absent id: string - name: Create cisco.catalystcenter.wireless_settings_anchor_groups: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_debug}}" state: present anchorGroupName: anchorGroup01 mobilityAnchors: - anchorPriority: PRIMARY deviceName: ewlc-NS-01-ipv4-single-stack ipAddress: 19.19.19.19 managedAnchorWlc: true - anchorPriority: SECONDARY deviceName: ewlc-NS-02-ipv6-single-stack managedAnchorWlc: true peerIpV6Address: 2001:db8:3c4d:15::1a2f:1a2b - anchorPriority: SECONDARY deviceName: ewlc-NS-03-ipv6-dual-stack ipAddress: 29.29.29.29 managedAnchorWlc: true peerIpV6Address: 2001:db8:3c4d:15::1a2f:1a3b - anchorPriority: SECONDARY deviceName: ewlc-NS-04-external-ipv4 ipAddress: 31.31.31.31 macAddress: 22:33:55:55:77:89 managedAnchorWlc: false mobilityGroupName: default peerDeviceType: IOS-XE privateIp: 12.12.12.12 - anchorPriority: SECONDARY deviceName: ewlc-NS-05-external-ipv6 macAddress: 22:33:55:55:77:90 managedAnchorWlc: false mobilityGroupName: default peerDeviceType: IOS-XE peerIpV6Address: 2001:db8:3c4d:15::1a2f:1aaa privateIpV6Address: 2001:db8:3c4d:15::1a2f:1111 - anchorPriority: SECONDARY deviceName: ewlc-NS-05-external-dual-stack ipAddress: 41.41.41.41 macAddress: 22:33:55:55:77:91 managedAnchorWlc: false mobilityGroupName: default peerDeviceType: IOS-XE peerIpV6Address: 2001:db8:3c4d:15::1a2f:1bbb privateIp: 12.12.12.12 privateIpV6Address: 2001:db8:3c4d:15::1a2f:1111 .. 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_settings_anchor_groups_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 Catalyst Center 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": {}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors