W3cubDocs

/Ansible

cisco.meraki.meraki_mr_rf_profile – Manage RF profiles for Meraki wireless networks

Note

This plugin is part of the cisco.meraki collection (version 2.5.0).

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_rf_profile.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Allows for configuration of radio frequency (RF) profiles in Meraki MR wireless networks.

Parameters

Parameter		Choices/Defaults	Comments
ap_band_settings dictionary			Settings that will be enabled if selectionType is set to 'ap'.
	band_steering_enabled boolean	Choices: no yes	Steers client to most open band.
	mode string	Choices: 2.4ghz 5ghz dual	Sets which RF band the AP will support. aliases: band_operation_mode
auth_key string / required			Authentication key provided by the dashboard. Required if environmental variable `MERAKI_KEY` is not set.
band_selection_type string		Choices: ssid ap	Sets whether band selection is assigned per access point or SSID. This param is required on creation.
client_balancing_enabled boolean		Choices: no yes	Steers client to best available access point.
five_ghz_settings dictionary			Settings related to 5Ghz band.
	channel_width string	Choices: auto 20 40 80	Sets channel width (MHz) for 5Ghz band.
	max_power integer		Sets max power (dBm) of 5Ghz band. Can be integer between 8 and 30.
	min_bitrate integer	Choices: 6 9 12 18 24 36 48 54	Sets minimum bitrate (Mbps) of 5Ghz band.
	min_power integer		Sets minmimum power (dBm) of 5Ghz band. Can be integer between 8 and 30.
	rxsop integer		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).
	valid_auto_channels list / elements=integer	Choices: 36 40 44 48 52 56 60 64 100 104 108 112 116 120 124 128 132 136 140 144 149 153 157 161 165	Sets valid auto channels for 5Ghz band.
host string		Default: "api.meraki.com"	Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China.
internal_error_retry_time integer		Default: 60	Number of seconds to retry if server returns an internal server error.
min_bitrate_type string		Choices: band ssid	Type of minimum bitrate.
name string			The unique name of the new profile. This param is required on creation.
net_id string			ID of network.
net_name string			Name of network.
org_id string			ID of organization.
org_name string			Name of organization. aliases: organization
output_format string		Choices: snakecase ← camelcase	Instructs module whether response keys should be snake case (ex. `net_id`) or camel case (ex. `netId`).
output_level string		Choices: debug normal ←	Set amount of debug output during module execution.
profile_id string			Unique identifier of existing RF profile. aliases: id
rate_limit_retry_time integer		Default: 165	Number of seconds to retry if rate limiter is triggered.
state string		Choices: present ← query absent	Query, edit, or delete wireless RF profile settings.
timeout integer		Default: 30	Time to timeout for HTTP requests.
two_four_ghz_settings dictionary			Settings related to 2.4Ghz band
	ax_enabled boolean	Choices: no yes	Determines whether ax radio on 2.4Ghz band is on or off.
	max_power integer		Sets max power (dBm) of 2.4Ghz band. Can be integer between 5 and 30.
	min_bitrate float	Choices: 1 2 5.5 6 9 11 12 18 24 36 48 54	Sets minimum bitrate (Mbps) of 2.4Ghz band.
	min_power integer		Sets minmimum power (dBm) of 2.4Ghz band. Can be integer between 5 and 30.
	rxsop integer		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).
	valid_auto_channels list / elements=integer	Choices: 1 6 11	Sets valid auto channels for 2.4Ghz band.
use_https boolean		Choices: no yes ←	If `no`, it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers.
use_proxy boolean		Choices: no ← yes	If `no`, it will not use a proxy, even if one is defined in an environment variable on the target hosts.
validate_certs boolean		Choices: no yes ←	Whether to validate HTTP certificates.

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 to 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.

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			Returned	Description
data complex			success	List of wireless RF profile settings.
	ap_band_settings complex		success	Settings that will be enabled if selectionType is set to 'ap'.
		band_steering_enabled boolean	success	Steers client to most open band. Sample: True
		mode string	success	Sets which RF band the AP will support. Sample: dual
	band_selection_type string		success	Sets whether band selection is assigned per access point or SSID. This param is required on creation. Sample: ap
	client_balancing_enabled boolean		success	Steers client to best available access point. Sample: True
	five_ghz_settings complex		success	Settings related to 5Ghz band.
		channel_width string	success	Sets channel width (MHz) for 5Ghz band. Sample: auto
		max_power integer	success	Sets max power (dBm) of 5Ghz band. Can be integer between 8 and 30. Sample: 12
		min_bitrate integer	success	Sets minimum bitrate (Mbps) of 5Ghz band. Sample: 6
		min_power integer	success	Sets minmimum power (dBm) of 5Ghz band. Can be integer between 8 and 30. Sample: 12
		rxsop integer	success	The RX-SOP level controls the sensitivity of the radio. Sample: -70
		valid_auto_channels list / elements=string	success	Sets valid auto channels for 5Ghz band.
	id string		success	Unique identifier of existing RF profile. Sample: 12345
	min_bitrate_type string		success	Type of minimum bitrate. Sample: ssid
	name string		success	The unique name of the new profile. This param is required on creation. Sample: Guest RF profile
	two_four_ghz_settings complex		success	Settings related to 2.4Ghz band
		ax_enabled boolean	success	Determines whether ax radio on 2.4Ghz band is on or off. Sample: True
		max_power integer	success	Sets max power (dBm) of 2.4Ghz band. Sample: 12
		min_bitrate float	success	Sets minimum bitrate (Mbps) of 2.4Ghz band. Sample: 5.5
		min_power integer	success	Sets minmimum power (dBm) of 2.4Ghz band. Sample: 12
		rxsop integer	success	The RX-SOP level controls the sensitivity of the radio. Sample: -70
		valid_auto_channels list / elements=string	success	Sets valid auto channels for 2.4Ghz band. Sample: 6

Authors

Kevin Breit (@kbreit)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/meraki_mr_rf_profile_module.html