cisco.catalystcenter.wireless_accesspoint_configuration_summary_info module -- Information module for Wireless Accesspoint Configuration Summary
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_accesspoint_configuration_summary_info.
New in cisco.catalystcenter 3.1.0
Synopsis
Get all Wireless Accesspoint Configuration Summary. - > Users can query access point configuration information for a specific device by using the Ethernet MAC address as a 'key' filter. If no key is specified, all access point details will be retrieved based on the combination of filters provided.
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 |
|---|---|
ApMode query parameter. AP Mode. Allowed values are Local, Bridge, Monitor, FlexConnect, Sniffer, Rogue Detector, SE-Connect, Flex+Bridge, Sensor. |
|
ApModel query parameter. AP Model. |
|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Additional headers. |
|
Key query parameter. The ethernet MAC address of Access point. |
|
Limit query parameter. The number of records to show for this page. The default is 500 if not specified. The maximum allowed limit is 500. |
|
MeshRole query parameter. Mesh Role. Allowed values are RAP or MAP. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
Provisioned query parameter. Indicate whether AP provisioned or not. Allowed values are True or False. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
WlcIpAddress query parameter. WLC IP Address. |
Notes
Note
SDK Method used are wireless.Wireless.get_access_point_configuration,
Paths used are get /dna/intent/api/v1/wireless/accesspoint-configuration/summary,
Supports
check_modeThe 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 GetAccessPointConfiguration
Complete reference of the GetAccessPointConfiguration API.
Examples
---
- name: Get all Wireless Accesspoint Configuration Summary
cisco.catalystcenter.wireless_accesspoint_configuration_summary_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}}"
key: string
wlcIpAddress: string
apMode: string
apModel: string
meshRole: string
provisioned: string
limit: 0
offset: 0
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|