cisco.meraki.meraki_mr_radio module – Manage device radio settings for Meraki wireless networks
Note
This module is part of the cisco.meraki collection (version 2.18.3).
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.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_mr_radio
.
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.devices_wireless_radio_settings
Synopsis
Allows for configuration of radio settings in Meraki MR wireless networks.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
Manual radio settings for 5 GHz. Default: |
|
Sets a manual channel for 5 GHz. Choices:
|
|
Sets a manual channel for 5 GHz. Can be ‘0’, ‘20’, ‘40’, or ‘80’ or null for using auto channel width. Choices:
|
|
Set a manual target power for 5 GHz. Can be between ‘8’ or ‘30’ or null for using auto power range. |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Number of seconds to retry if server returns an internal server error. Default: |
|
ID of a network. |
|
Name of a 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:
|
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
The ID of an RF profile to assign to the device. If the value of this parameter is null, the appropriate basic RF profile (indoor or outdoor) will be assigned to the device. Assigning an RF profile will clear ALL manually configured overrides on the device (channel width, channel, power). |
|
The name of an RF profile to assign to the device. Similar to ``rf_profile_id``, but requires ``net_id`` (preferred) or ``net_name``. |
|
Serial number of a device to query. |
|
Query or edit radio settings on a device. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
Manual radio settings for 2.4 GHz. Default: |
|
Sets a manual channel for 2.4 GHz. Can be ‘1’, ‘2’, ‘3’, ‘4’, ‘5’, ‘6’, ‘7’, ‘8’, ‘9’, ‘10’, ‘11’, ‘12’, ‘13’ or ‘14’ or null for using auto channel. Choices:
|
|
Set a manual target power for 2.4 GHz. Can be between ‘5’ or ‘30’ or null for using auto power range. |
|
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_FORMAT
environment 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: Query a device's radio configuration
meraki_mr_radio:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
serial: YourSerialNumber
state: query
delegate_to: localhost
- name: Configure a device's radios
meraki_mr_radio:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
serial: YourSerialNumber
state: present
five_ghz_settings:
channel: 56
channel_width: 20
target_power: 10
two_four_ghz_settings:
channel: 6
target_power: 12
rf_profile_name: Test Profile
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
RF settings configured on a specific device. Returned: success |
|
Configured manual radio settings for 5 GHz. Returned: success |
|
Configured manual channel for 5 GHz. Null indicates auto channel. Returned: success Sample: |
|
Configured manual channel for 5 GHz. Null indicates auto channel width. Returned: success Sample: |
|
Configured manual target power for 5 GHz. Null indicates auto power. Returned: success Sample: |
|
The ID of an RF profile assigned to the device. Null indicates the appropriate basic RF profile (indoor or outdoor) is assigned to the device. Returned: success |
|
Serial number of the device that was configured. Returned: success Sample: |
|
Configured manual radio settings for 2.4 GHz. Returned: success |
|
Configured manual channel for 2.4 GHz. Null indicates auto channel. Returned: success Sample: |
|
Configured manual target power for 2.4 GHz. Null indicates auto power. Returned: success Sample: |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.