cisco.dnac.wireless_settings_anchor_groups_id module – Resource module for Wireless Settings Anchor Groups Id
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_settings_anchor_groups_id
.
New in cisco.dnac 6.17.0
Synopsis
This module represents an alias of the module wireless_settings_anchor_groups_id_v1
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 |
---|---|
Anchor Group Name. Max length is 32 characters. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Id path parameter. AnchorGroup ID. |
|
Wireless Settings Anchor Groups Id’s mobilityAnchors. |
|
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. |
|
Peer Host Name. |
|
This indicates Mobility public IP address. Allowed formats are 192.168.0.1, 10.0.0.1, 255.255.255.255. |
|
Peer Device mobility MAC address. Allowed formats are 0a0b.0c01.0211, 0a0b0c010211, 0a 0b 0c 01 02 11. |
|
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. Choices:
|
|
Peer Device mobility group Name. Must be alphanumeric without {!,<,space,?/’} and maximum of 31 characters. |
|
Indicates peer device mobility belongs to AireOS or IOS-XE family. |
|
This indicates private management IP address. Allowed formats are 192.168.0.1, 10.0.0.1, 255.255.255.255. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are wireless.Wireless.delete_anchor_group_by_id_v1, wireless.Wireless.update_anchor_group_v1,
Paths used are delete /dna/intent/api/v1/wirelessSettings/anchorGroups/{id}, put /dna/intent/api/v1/wirelessSettings/anchorGroups/{id},
It should be noted that this module is an alias of wireless_settings_anchor_groups_id_v1
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 DeleteAnchorGroupByIDV1
Complete reference of the DeleteAnchorGroupByIDV1 API.
- Cisco DNA Center documentation for Wireless UpdateAnchorGroupV1
Complete reference of the UpdateAnchorGroupV1 API.
Examples
- name: Delete by id
cisco.dnac.wireless_settings_anchor_groups_id:
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}}"
state: absent
id: string
- name: Update by id
cisco.dnac.wireless_settings_anchor_groups_id:
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}}"
state: present
anchorGroupName: string
id: string
mobilityAnchors:
- anchorPriority: string
deviceName: string
ipAddress: string
macAddress: string
managedAnchorWlc: true
mobilityGroupName: string
peerDeviceType: string
privateIp: string
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |