cisco.dnac.wireless_settings_rf_profiles_info module – Information module for Wireless Settings Rf Profiles
Note
This module is part of the cisco.dnac collection (version 6.41.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_settings_rf_profiles_info.
New in cisco.dnac 6.15.0
Synopsis
Get all Wireless Settings Rf Profiles.
Get Wireless Settings Rf Profiles by id.
This API allows the user to get a RF Profile by RF Profile ID.
This API allows the user to get all RF Profiles.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.10.1
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
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: |
|
EnableRadioType6GHz query parameter. Enable Radio Type6GHz. Choices:
|
|
EnableRadioTypeA query parameter. Enable Radio TypeA. Choices:
|
|
EnableRadioTypeB query parameter. Enable Radio TypeB. Choices:
|
|
Additional headers. |
|
Id path parameter. RF 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. |
|
RfProfileName query parameter. RF Profile Name. |
|
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_rf_profile_by_id, wireless.Wireless.get_rf_profiles,
Paths used are get /dna/intent/api/v1/wirelessSettings/rfProfiles, get /dna/intent/api/v1/wirelessSettings/rfProfiles/{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 GetRFProfileByID
Complete reference of the GetRFProfileByID API.
- Cisco DNA Center documentation for Wireless GetRFProfiles
Complete reference of the GetRFProfiles API.
Examples
---
- name: Get all Wireless Settings Rf Profiles
cisco.dnac.wireless_settings_rf_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
rfProfileName: string
enableRadioTypeA: true
enableRadioTypeB: true
enableRadioType6GHz: true
register: result
- name: Get Wireless Settings Rf Profiles by id
cisco.dnac.wireless_settings_rf_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 |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |