.. 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_rf_profile_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.meraki.meraki_mr_rf_profile module -- Manage RF profiles 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_rf_profile`. .. version_added .. contents:: :local: :depth: 1 .. Deprecated DEPRECATED ---------- :Removed in: version 3.0.0 :Why: Updated modules released with increased functionality :Alternative: cisco.meraki.networks\_wireless\_rf\_profiles Synopsis -------- .. Description - Allows for configuration of radio frequency (RF) profiles 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_rf_profile_module__parameter-ap_band_settings: .. rst-class:: ansible-option-title **ap_band_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Settings that will be enabled if selectionType is set to 'ap'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-ap_band_settings/band_steering_enabled: .. rst-class:: ansible-option-title **band_steering_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Steers client to most open band. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-ap_band_settings/band_operation_mode: .. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-ap_band_settings/mode: .. rst-class:: ansible-option-title **mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: band_operation_mode` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets which RF band the AP will support. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"2.4ghz"` - :ansible-option-choices-entry:`"5ghz"` - :ansible-option-choices-entry:`"dual"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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_rf_profile_module__parameter-band_selection_type: .. rst-class:: ansible-option-title **band_selection_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets whether band selection is assigned per access point or SSID. This param is required on creation. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"ssid"` - :ansible-option-choices-entry:`"ap"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-client_balancing_enabled: .. rst-class:: ansible-option-title **client_balancing_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Steers client to best available access point. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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
Settings related to 5Ghz band. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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 channel width (MHz) for 5Ghz band. .. 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_rf_profile_module__parameter-five_ghz_settings/max_power: .. rst-class:: ansible-option-title **max_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets max power (dBm) of 5Ghz band. Can be integer between 8 and 30. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-five_ghz_settings/min_bitrate: .. rst-class:: ansible-option-title **min_bitrate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets minimum bitrate (Mbps) of 5Ghz band. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`6` - :ansible-option-choices-entry:`9` - :ansible-option-choices-entry:`12` - :ansible-option-choices-entry:`18` - :ansible-option-choices-entry:`24` - :ansible-option-choices-entry:`36` - :ansible-option-choices-entry:`48` - :ansible-option-choices-entry:`54` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-five_ghz_settings/min_power: .. rst-class:: ansible-option-title **min_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets minmimum power (dBm) of 5Ghz band. Can be integer between 8 and 30. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-five_ghz_settings/rxsop: .. rst-class:: ansible-option-title **rxsop** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-five_ghz_settings/valid_auto_channels: .. rst-class:: ansible-option-title **valid_auto_channels** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` .. raw:: html
- .. raw:: html
Sets valid auto channels for 5Ghz band. .. 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_rf_profile_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_rf_profile_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_rf_profile_module__parameter-min_bitrate_type: .. rst-class:: ansible-option-title **min_bitrate_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of minimum bitrate. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`"band"` - :ansible-option-choices-entry:`"ssid"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The unique name of the new profile. This param is required on creation. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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 network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-net_name: .. rst-class:: ansible-option-title **net_name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of network. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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_rf_profile_module__parameter-org_name: .. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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_rf_profile_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_rf_profile_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_rf_profile_module__parameter-id: .. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-profile_id: .. rst-class:: ansible-option-title **profile_id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: id` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier of existing RF profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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_rf_profile_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, edit, or delete wireless RF profile settings. .. 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"` - :ansible-option-choices-entry:`"absent"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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_rf_profile_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
Settings related to 2.4Ghz band .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-two_four_ghz_settings/ax_enabled: .. rst-class:: ansible-option-title **ax_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines whether ax radio on 2.4Ghz band is on or off. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-two_four_ghz_settings/max_power: .. rst-class:: ansible-option-title **max_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets max power (dBm) of 2.4Ghz band. Can be integer between 5 and 30. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-two_four_ghz_settings/min_bitrate: .. rst-class:: ansible-option-title **min_bitrate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Sets minimum bitrate (Mbps) of 2.4Ghz band. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`1.0` - :ansible-option-choices-entry:`2.0` - :ansible-option-choices-entry:`5.5` - :ansible-option-choices-entry:`6.0` - :ansible-option-choices-entry:`9.0` - :ansible-option-choices-entry:`11.0` - :ansible-option-choices-entry:`12.0` - :ansible-option-choices-entry:`18.0` - :ansible-option-choices-entry:`24.0` - :ansible-option-choices-entry:`36.0` - :ansible-option-choices-entry:`48.0` - :ansible-option-choices-entry:`54.0` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-two_four_ghz_settings/min_power: .. rst-class:: ansible-option-title **min_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets minmimum power (dBm) of 2.4Ghz band. Can be integer between 5 and 30. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-two_four_ghz_settings/rxsop: .. rst-class:: ansible-option-title **rxsop** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
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). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__parameter-two_four_ghz_settings/valid_auto_channels: .. rst-class:: ansible-option-title **valid_auto_channels** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=integer` .. raw:: html
- .. raw:: html
Sets valid auto channels for 2.4Ghz band. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`1` - :ansible-option-choices-entry:`6` - :ansible-option-choices-entry:`11` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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_rf_profile_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_rf_profile_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: 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 .. 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_rf_profile_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
List of wireless RF profile settings. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/ap_band_settings: .. rst-class:: ansible-option-title **ap_band_settings** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`complex` .. raw:: html
- .. raw:: html
Settings that will be enabled if selectionType is set to 'ap'. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/ap_band_settings/band_steering_enabled: .. rst-class:: ansible-option-title **band_steering_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Steers client to most open band. .. 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:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/ap_band_settings/mode: .. rst-class:: ansible-option-title **mode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets which RF band the AP will support. .. 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:`"dual"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/band_selection_type: .. rst-class:: ansible-option-title **band_selection_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Sets whether band selection is assigned per access point or SSID. This param is required on creation. .. 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:`"ap"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/client_balancing_enabled: .. rst-class:: ansible-option-title **client_balancing_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Steers client to best available access point. .. 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:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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:`complex` .. raw:: html
- .. raw:: html
Settings related to 5Ghz band. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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
Sets channel width (MHz) for 5Ghz band. .. 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:`"auto"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/five_ghz_settings/max_power: .. rst-class:: ansible-option-title **max_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets max power (dBm) of 5Ghz band. Can be integer between 8 and 30. .. 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:`12` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/five_ghz_settings/min_bitrate: .. rst-class:: ansible-option-title **min_bitrate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets minimum bitrate (Mbps) of 5Ghz band. .. 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:`6` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/five_ghz_settings/min_power: .. rst-class:: ansible-option-title **min_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets minmimum power (dBm) of 5Ghz band. Can be integer between 8 and 30. .. 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:`12` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/five_ghz_settings/rxsop: .. rst-class:: ansible-option-title **rxsop** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The RX-SOP level controls the sensitivity of the radio. .. 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:`-70` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/five_ghz_settings/valid_auto_channels: .. rst-class:: ansible-option-title **valid_auto_channels** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Sets valid auto channels for 5Ghz band. .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Unique identifier of existing RF profile. .. 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:`"12345"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/min_bitrate_type: .. rst-class:: ansible-option-title **min_bitrate_type** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of minimum bitrate. .. 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:`"ssid"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/name: .. rst-class:: ansible-option-title **name** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The unique name of the new profile. This param is required on creation. .. 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:`"Guest RF profile"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_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:`complex` .. raw:: html
- .. raw:: html
Settings related to 2.4Ghz band .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` success .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/two_four_ghz_settings/ax_enabled: .. rst-class:: ansible-option-title **ax_enabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Determines whether ax radio on 2.4Ghz band is on or off. .. 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:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/two_four_ghz_settings/max_power: .. rst-class:: ansible-option-title **max_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets max power (dBm) of 2.4Ghz band. .. 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:`12` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/two_four_ghz_settings/min_bitrate: .. rst-class:: ansible-option-title **min_bitrate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
Sets minimum bitrate (Mbps) of 2.4Ghz band. .. 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:`5.5` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/two_four_ghz_settings/min_power: .. rst-class:: ansible-option-title **min_power** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Sets minmimum power (dBm) of 2.4Ghz band. .. 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:`12` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/two_four_ghz_settings/rxsop: .. rst-class:: ansible-option-title **rxsop** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The RX-SOP level controls the sensitivity of the radio. .. 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:`-70` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.meraki.meraki_mr_rf_profile_module__return-data/two_four_ghz_settings/valid_auto_channels: .. rst-class:: ansible-option-title **valid_auto_channels** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Sets valid auto channels for 2.4Ghz band. .. 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:`["6"]` .. 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 ~~~~~~~ - Kevin Breit (@kbreit) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors