cisco.catalystcenter.wireless_settings_anchor_groups module -- Resource module for Wireless Settings Anchor Groups

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

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_settings_anchor_groups.

New in cisco.catalystcenter 2.0.0

Synopsis

  • 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 action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

anchorGroupName

string

Anchor Group Name. Max length is 32 characters.

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

id

string

Id path parameter. AnchorGroup ID.

mobilityAnchors

list / elements=dictionary

Peer details. Maximum 24 peers are allowed.

anchorPriority

string

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.

deviceName

string

Peer Device Host Name.

ipAddress

string

IPv4 address in dotted decimal notation (e.g., 192.168.1.1).

macAddress

string

Peer Device mobility MAC address. Allowed formats are 0a0b.0c01.0211, 0a0b0c010211, 0a 0b 0c 01 02 11.

managedAnchorWlc

boolean

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:

mobilityGroupName

string

Peer Device mobility group Name. Must be alphanumeric without {!,<,space,?/'} and maximum of 31 characters.

peerDeviceType

string

Indicates peer device mobility belongs to AireOS or IOX-XE family. 0 - indicates AireOS and 1 - indicates C9800.

peerIpV6Address

string

IPv6 address in standard notation (e.g., 2001 db8 1).

privateIp

string

IPv4 address in dotted decimal notation (e.g., 192.168.1.1).

privateIpV6Address

string

IPv6 address in standard notation (e.g., 2001 db8 1).

validate_response_schema

boolean

Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

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 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)

See Also

See also

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

---
- 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

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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)