cisco.meraki.meraki_mr_rf_profile module -- Manage RF profiles for Meraki wireless networks
Note
This module is part of the cisco.meraki collection (version 2.18.2).
To install it, use: ansible-galaxy collection install cisco.meraki.
To use it in a playbook, specify: cisco.meraki.meraki_mr_rf_profile.
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.networks_wireless_rf_profiles
Synopsis
Allows for configuration of radio frequency (RF) profiles in Meraki MR wireless networks.
Parameters
Parameter |
Comments |
|---|---|
Settings that will be enabled if selectionType is set to 'ap'. |
|
Steers client to most open band. Choices: |
|
Sets which RF band the AP will support. Choices: |
|
Authentication key provided by the dashboard. Required if environmental variable |
|
Sets whether band selection is assigned per access point or SSID. This param is required on creation. Choices: |
|
Steers client to best available access point. Choices: |
|
Settings related to 5Ghz band. |
|
Sets channel width (MHz) for 5Ghz band. Choices: |
|
Sets max power (dBm) of 5Ghz band. Can be integer between 8 and 30. |
|
Sets minimum bitrate (Mbps) of 5Ghz band. Choices: |
|
Sets minmimum power (dBm) of 5Ghz band. Can be integer between 8 and 30. |
|
The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). |
|
Sets valid auto channels for 5Ghz band. Choices: |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. |
|
Number of seconds to retry if server returns an internal server error. Default: :ansible-option-default:`60` |
|
Type of minimum bitrate. Choices: |
|
The unique name of the new profile. This param is required on creation. |
|
ID of network. |
|
Name of network. |
|
ID of organization. |
|
Name of organization. |
|
Instructs module whether response keys should be snake case (ex. Choices: |
|
Set amount of debug output during module execution. Choices: |
|
Unique identifier of existing RF profile. |
|
Number of seconds to retry if rate limiter is triggered. Default: :ansible-option-default:`165` |
|
Query, edit, or delete wireless RF profile settings. Choices: |
|
Time to timeout for HTTP requests. Default: :ansible-option-default:`30` |
|
Settings related to 2.4Ghz band |
|
Determines whether ax radio on 2.4Ghz band is on or off. Choices: |
|
Sets max power (dBm) of 2.4Ghz band. Can be integer between 5 and 30. |
|
Sets minimum bitrate (Mbps) of 2.4Ghz band. Choices: |
|
Sets minmimum power (dBm) of 2.4Ghz band. Can be integer between 5 and 30. |
|
The RX-SOP level controls the sensitivity of the radio. It is strongly recommended to use RX-SOP only after consulting a wireless expert. RX-SOP can be configured in the range of -65 to -95 (dBm). |
|
Sets valid auto channels for 2.4Ghz band. Choices: |
|
If Only useful for internal Meraki developers. Choices: |
|
If Choices: |
|
Whether to validate HTTP certificates. Choices: |
Notes
Note
More information about the Meraki API can be found at https://dashboard.meraki.com/api_docs.
Some of the options are likely only used for developers within Meraki.
As of Ansible 2.9, Meraki modules output keys as snake case. To use camel case, set the
ANSIBLE_MERAKI_FORMATenvironment variable tocamelcase.Ansible's Meraki modules will stop supporting camel case output in Ansible 2.13. Please update your playbooks.
Check Mode downloads the current configuration from the dashboard, then compares changes against this download. Check Mode will report changed if there are differences in the configurations, but does not submit changes to the API for validation of change.
Examples
- name: Create RF profile in check mode
meraki_mr_rf_profile:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: present
name: Test Profile
band_selection_type: ap
client_balancing_enabled: True
ap_band_settings:
mode: dual
band_steering_enabled: true
five_ghz_settings:
max_power: 10
min_bitrate: 12
min_power: 8
rxsop: -65
channel_width: 20
valid_auto_channels:
- 36
- 40
- 44
two_four_ghz_settings:
max_power: 10
min_bitrate: 12
min_power: 8
rxsop: -65
ax_enabled: false
valid_auto_channels:
- 1
delegate_to: localhost
- name: Query all RF profiles
meraki_mr_rf_profile:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: query
delegate_to: localhost
- name: Query one RF profile by ID
meraki_mr_rf_profile:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: query
profile_id: '{{ profile_id }}'
delegate_to: localhost
- name: Update profile
meraki_mr_rf_profile:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: present
profile_id: 12345
band_selection_type: ap
client_balancing_enabled: True
ap_band_settings:
mode: dual
band_steering_enabled: true
five_ghz_settings:
max_power: 10
min_bitrate: 12
min_power: 8
rxsop: -65
channel_width: 20
valid_auto_channels:
- 36
- 44
two_four_ghz_settings:
max_power: 10
min_bitrate: 12
min_power: 8
rxsop: -75
ax_enabled: false
valid_auto_channels:
- 1
delegate_to: localhost
- name: Delete RF profile
meraki_mr_rf_profile:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: absent
profile_id: 12345
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of wireless RF profile settings. Returned: success |
|
Settings that will be enabled if selectionType is set to 'ap'. Returned: success |
|
Sets whether band selection is assigned per access point or SSID. This param is required on creation. Returned: success Sample: :ansible-rv-sample-value:`"ap"` |
|
Steers client to best available access point. Returned: success Sample: :ansible-rv-sample-value:`true` |
|
Settings related to 5Ghz band. Returned: success |
|
Sets max power (dBm) of 5Ghz band. Can be integer between 8 and 30. Returned: success Sample: :ansible-rv-sample-value:`12` |
|
Sets minmimum power (dBm) of 5Ghz band. Can be integer between 8 and 30. Returned: success Sample: :ansible-rv-sample-value:`12` |
|
The RX-SOP level controls the sensitivity of the radio. Returned: success Sample: :ansible-rv-sample-value:`-70` |
|
Sets valid auto channels for 5Ghz band. Returned: success |
|
Unique identifier of existing RF profile. Returned: success |
|
The unique name of the new profile. This param is required on creation. Returned: success |
|
Settings related to 2.4Ghz band Returned: success |
|
Determines whether ax radio on 2.4Ghz band is on or off. Returned: success Sample: :ansible-rv-sample-value:`true` |
|
Sets minimum bitrate (Mbps) of 2.4Ghz band. Returned: success Sample: :ansible-rv-sample-value:`5.5` |
|
The RX-SOP level controls the sensitivity of the radio. Returned: success Sample: :ansible-rv-sample-value:`-70` |
|
Sets valid auto channels for 2.4Ghz band. Returned: success Sample: :ansible-rv-sample-value:`["6"]` |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.