cisco.dnac.wireless_controllers_mesh_ap_neighbours_v1_info module – Information module for Wireless Controllers Mesh Ap Neighbours V1
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_controllers_mesh_ap_neighbours_v1_info
.
New in cisco.dnac 6.17.0
Synopsis
Get all Wireless Controllers Mesh Ap Neighbours V1.
Retrieves all Mesh accesspoint Neighbours details whether child, parent, etc.
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 |
---|---|
ApName query parameter. Employ this query parameter to obtain the details of the Access points corresponding to the provided ap name. |
|
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: |
|
EthernetMacAddress query parameter. Employ this query parameter to obtain the details of the Access points corresponding to the provided EthernetMacAddress. |
|
Additional headers. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
|
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_v1,
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 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 GetMeshApNeighboursV1
Complete reference of the GetMeshApNeighboursV1 API.
Examples
- name: Get all Wireless Controllers Mesh Ap Neighbours V1
cisco.dnac.wireless_controllers_mesh_ap_neighbours_v1_info:
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}}"
headers: "{{my_headers | from_json}}"
wlcIpAddress: string
apName: string
ethernetMacAddress: string
register: result
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: |