cisco.catalystcenter.wireless_controllers_mesh_ap_neighbours_info module -- Information module for Wireless Controllers Mesh Ap Neighbours

Note

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

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

New in cisco.catalystcenter 6.17.0

Synopsis

  • Get all Wireless Controllers Mesh Ap Neighbours. - > Retrieves all mesh access point neighbour details, including Child, Parent, Neighbour, Tentative Parent, and Blocklisted statuses.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.1.6.0.0

  • python >= 3.12

Parameters

Parameter

Comments

apName

string

ApName query parameter. Employ this query parameter to obtain the details of the access points corresponding to the provided access point name.

catalystcenter_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

string

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

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

ethernetMacAddress

string

EthernetMacAddress query parameter. Employ this query parameter to obtain the details of the access points corresponding to the provided ethernet MAC address.

headers

dictionary

Additional headers.

meshRole

string

MeshRole query parameter. Employ this query parameter to obtain the details of the access points corresponding to the provided mesh role. Allowed values are RAP or MAP.

neighbourType

string

NeighbourType query parameter. Employ this query parameter to obtain the details of the access points corresponding to the provided mesh neighbour type. Allowed values are Child, Parent, Neigh, Tentative Parent, Blocklisted.

validate_response_schema

boolean

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

Choices:

wlcIpAddress

string

WlcIpAddress query parameter. Employ this query parameter to obtain the details of the access points corresponding to the provided WLC IP address.

Notes

Note

  • SDK Method used are wireless.Wireless.get_mesh_ap_neighbours,

  • Paths used are get /dna/intent/api/v1/wirelessControllers/meshApNeighbours,

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

See Also

See also

Cisco DNA Center documentation for Wireless GetMeshApNeighbours

Complete reference of the GetMeshApNeighbours API.

Examples

---
- name: Get all Wireless Controllers Mesh Ap Neighbours
  cisco.catalystcenter.wireless_controllers_mesh_ap_neighbours_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    wlcIpAddress: string
    apName: string
    ethernetMacAddress: string
    meshRole: string
    neighbourType: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"apName": "string", "ethernetMacAddress": "string", "id": "string", "meshRole": "string", "neighbourApName": "string", "neighbourMacAddress": "string", "neighbourType": "string", "wlcIpAddress": "string"}`

Authors

  • Rafael Campos (@racampos)