cisco.dnac.wireless_settings_ap_profiles_info module -- Information module for Wireless Settings Ap Profiles
Note
This module is part of the cisco.dnac collection (version 6.46.0).
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_ap_profiles_info.
New in cisco.dnac 6.17.0
Synopsis
Get all Wireless Settings Ap Profiles.
Get Wireless Settings Ap Profiles by id.
This API allows the user to get AP Profiles that captured in wireless settings design.
This API allows the user to get a AP Profile by AP Profile ID that captured in wireless settings design.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.11.0
python >= 3.12
Parameters
Parameter |
Comments |
|---|---|
ApProfileName query parameter. Employ this query parameter to obtain the details of the apProfiles corresponding to the provided apProfileName. |
|
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: :ansible-option-default:`443` |
|
The Cisco DNA 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 DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Additional headers. |
|
Id path parameter. Ap Profile ID. |
|
Limit query parameter. The number of records to show for this page. Default is 500 if not specified. Maximum allowed limit is 500. |
|
Offset query parameter. The first record to show for this page, the first record is numbered 1. |
|
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.get_ap_profile_by_id, wireless.Wireless.get_ap_profiles,
Paths used are get /dna/intent/api/v1/wirelessSettings/apProfiles, get /dna/intent/api/v1/wirelessSettings/apProfiles/{id},
Supports
check_modeThe 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 GetAPProfileByID
Complete reference of the GetAPProfileByID API.
- Cisco DNA Center documentation for Wireless GetAPProfiles
Complete reference of the GetAPProfiles API.
Examples
---
- name: Get all Wireless Settings Ap Profiles
cisco.dnac.wireless_settings_ap_profiles_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}}"
limit: 0
offset: 0
apProfileName: string
register: result
- name: Get Wireless Settings Ap Profiles by id
cisco.dnac.wireless_settings_ap_profiles_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}}"
id: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|