cisco.dnac.wireless_settings_rf_profiles_info module -- Information module for Wireless Settings Rf Profiles Info
Note
This module is part of the cisco.dnac collection (version 6.28.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_rf_profiles_info.
New in cisco.dnac 6.15.0
Synopsis
This module represents an alias of the module wireless_settings_rf_profiles_v1_info
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 |
|---|---|
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:`"2.3.7.6"` |
|
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_v1, wireless.Wireless.get_rf_profiles_v1,
Paths used are get /dna/intent/api/v1/wirelessSettings/rfProfiles, get /dna/intent/api/v1/wirelessSettings/rfProfiles/{id},
It should be noted that this module is an alias of wireless_settings_rf_profiles_v1_info
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 GetRFProfileByIDV1
Complete reference of the GetRFProfileByIDV1 API.
- Cisco DNA Center documentation for Wireless GetRFProfilesV1
Complete reference of the GetRFProfilesV1 API.
Examples
- name: Get all Wireless Settings Rf Profiles Info
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 Info 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 |
|---|---|