.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.meraki.meraki_mr_radio_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.meraki_mr_radio module -- Manage device radio settings for Meraki wireless networks ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.meraki collection `_ (version 2.20.6). To install it, use: :code:`ansible-galaxy collection install cisco.meraki`. To use it in a playbook, specify: :code:`cisco.meraki.meraki_mr_radio`. .. version_added .. contents:: :local: :depth: 1 .. Deprecated DEPRECATED ---------- :Removed in: version 3.0.0 :Why: Updated modules released with increased functionality :Alternative: cisco.meraki.devices\_wireless\_radio\_settings Synopsis -------- .. Description - Allows for configuration of radio settings in Meraki MR wireless networks. .. Aliases .. Requirements .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-auth_key: .. rst-class:: ansible-option-title **auth_key** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
Authentication key provided by the dashboard. Required if environmental variable \ :literal:`MERAKI\_KEY`\ is not set. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-five_ghz_settings: .. rst-class:: ansible-option-title **five_ghz_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Manual radio settings for 5 GHz. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`{}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-five_ghz_settings/channel: .. rst-class:: ansible-option-title **channel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets a manual channel for 5 GHz. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`36` - :ansible-option-choices-entry:`40` - :ansible-option-choices-entry:`44` - :ansible-option-choices-entry:`48` - :ansible-option-choices-entry:`52` - :ansible-option-choices-entry:`56` - :ansible-option-choices-entry:`60` - :ansible-option-choices-entry:`64` - :ansible-option-choices-entry:`100` - :ansible-option-choices-entry:`104` - :ansible-option-choices-entry:`108` - :ansible-option-choices-entry:`112` - :ansible-option-choices-entry:`116` - :ansible-option-choices-entry:`120` - :ansible-option-choices-entry:`124` - :ansible-option-choices-entry:`128` - :ansible-option-choices-entry:`132` - :ansible-option-choices-entry:`136` - :ansible-option-choices-entry:`140` - :ansible-option-choices-entry:`144` - :ansible-option-choices-entry:`149` - :ansible-option-choices-entry:`153` - :ansible-option-choices-entry:`157` - :ansible-option-choices-entry:`161` - :ansible-option-choices-entry:`165` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-five_ghz_settings/channel_width: .. rst-class:: ansible-option-title **channel_width** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets a manual channel for 5 GHz. Can be '0', '20', '40', or '80' or null for using auto channel width. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"auto"` - :ansible-option-choices-entry:`"20"` - :ansible-option-choices-entry:`"40"` - :ansible-option-choices-entry:`"80"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-five_ghz_settings/target_power: .. rst-class:: ansible-option-title **target_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Set a manual target power for 5 GHz. Can be between '8' or '30' or null for using auto power range. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-host: .. rst-class:: ansible-option-title **host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"api.meraki.com"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-internal_error_retry_time: .. rst-class:: ansible-option-title **internal_error_retry_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of seconds to retry if server returns an internal server error. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`60` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-net_id: .. rst-class:: ansible-option-title **net_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-net_name: .. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-network: .. rst-class:: ansible-option-title **net_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: network` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of a network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-org_id: .. rst-class:: ansible-option-title **org_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
ID of organization. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-org_name: .. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-organization: .. rst-class:: ansible-option-title **org_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: organization` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of organization. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-output_format: .. rst-class:: ansible-option-title **output_format** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Instructs module whether response keys should be snake case (ex. \ :literal:`net\_id`\ ) or camel case (ex. \ :literal:`netId`\ ). .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"snakecase"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"camelcase"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-output_level: .. rst-class:: ansible-option-title **output_level** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Set amount of debug output during module execution. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"debug"` - :ansible-option-choices-entry-default:`"normal"` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-rate_limit_retry_time: .. rst-class:: ansible-option-title **rate_limit_retry_time** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of seconds to retry if rate limiter is triggered. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`165` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-rf_profile_id: .. rst-class:: ansible-option-title **rf_profile_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-rf_profile_name: .. rst-class:: ansible-option-title **rf_profile_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The name of an RF profile to assign to the device. Similar to \`\`rf\_profile\_id\`\`, but requires \`\`net\_id\`\` (preferred) or \`\`net\_name\`\`. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-serial: .. rst-class:: ansible-option-title **serial** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Serial number of a device to query. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-state: .. rst-class:: ansible-option-title **state** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Query or edit radio settings on a device. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`"query"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-timeout: .. rst-class:: ansible-option-title **timeout** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Time to timeout for HTTP requests. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`30` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-two_four_ghz_settings: .. rst-class:: ansible-option-title **two_four_ghz_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Manual radio settings for 2.4 GHz. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`{}` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-two_four_ghz_settings/channel: .. rst-class:: ansible-option-title **channel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`1` - :ansible-option-choices-entry:`2` - :ansible-option-choices-entry:`3` - :ansible-option-choices-entry:`4` - :ansible-option-choices-entry:`5` - :ansible-option-choices-entry:`6` - :ansible-option-choices-entry:`7` - :ansible-option-choices-entry:`8` - :ansible-option-choices-entry:`9` - :ansible-option-choices-entry:`10` - :ansible-option-choices-entry:`11` - :ansible-option-choices-entry:`12` - :ansible-option-choices-entry:`13` - :ansible-option-choices-entry:`14` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-two_four_ghz_settings/target_power: .. rst-class:: ansible-option-title **target_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Set a manual target power for 2.4 GHz. Can be between '5' or '30' or null for using auto power range. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-use_https: .. rst-class:: ansible-option-title **use_https** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If \ :literal:`no`\ , it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-use_proxy: .. rst-class:: ansible-option-title **use_proxy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
If \ :literal:`no`\ , it will not use a proxy, even if one is defined in an environment variable on the target hosts. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__parameter-validate_certs: .. rst-class:: ansible-option-title **validate_certs** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Whether to validate HTTP certificates. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`ANSIBLE\_MERAKI\_FORMAT`\ environment variable to \ :literal:`camelcase`\ . - 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. .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data: .. rst-class:: ansible-option-title **data** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html
- .. raw:: html
RF settings configured on a specific device. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/five_ghz_settings: .. rst-class:: ansible-option-title **five_ghz_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configured manual radio settings for 5 GHz. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/five_ghz_settings/channel: .. rst-class:: ansible-option-title **channel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configured manual channel for 5 GHz. Null indicates auto channel. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"56"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/five_ghz_settings/channel_width: .. rst-class:: ansible-option-title **channel_width** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configured manual channel for 5 GHz. Null indicates auto channel width. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"40"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/five_ghz_settings/target_power: .. rst-class:: ansible-option-title **target_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configured manual target power for 5 GHz. Null indicates auto power. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`25` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/rf_profile_id: .. rst-class:: ansible-option-title **rf_profile_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/serial: .. rst-class:: ansible-option-title **serial** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Serial number of the device that was configured. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"xyz"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/two_four_ghz_settings: .. rst-class:: ansible-option-title **two_four_ghz_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Configured manual radio settings for 2.4 GHz. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/two_four_ghz_settings/channel: .. rst-class:: ansible-option-title **channel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Configured manual channel for 2.4 GHz. Null indicates auto channel. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`"11"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_radio_module__return-data/two_four_ghz_settings/target_power: .. rst-class:: ansible-option-title **target_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Configured manual target power for 2.4 GHz. Null indicates auto power. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`15` .. raw:: html
.. Status (Presently only deprecated) Status ------ .. Deprecated note - This module will be removed in version 3.0.0. *[deprecated]* - For more information see `DEPRECATED`_. .. Authors Authors ~~~~~~~ - Tyler Christiansen (@supertylerc) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors