cisco.meraki.networks_appliance_rf_profiles module – Resource module for networks _appliance _rfprofiles
Note
This module is part of the cisco.meraki collection (version 2.18.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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.meraki.networks_appliance_rf_profiles.
New in cisco.meraki 2.18.0
Synopsis
Manage operations create, update and delete of the resource networks _appliance _rfprofiles.
Creates new RF profile for this network.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
meraki >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Settings related to 5Ghz band. |
|
Determines whether ax radio on 5Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering. Defaults to true. Choices:
|
|
Sets min bitrate (Mbps) of 5Ghz band. Can be one of ‘6’, ‘9’, ‘12’, ‘18’, ‘24’, ‘36’, ‘48’ or ‘54’. Defaults to 12. |
|
meraki_action_batch_retry_wait_time (integer), action batch concurrency error retry wait time Default: |
|
meraki_api_key (string), API key generated in dashboard; can also be set as an environment variable MERAKI_DASHBOARD_API_KEY |
|
meraki_base_url (string), preceding all endpoint resources Default: |
|
meraki_be_geo_id (string), optional partner identifier for API usage tracking; can also be set as an environment variable BE_GEO_ID Default: |
|
meraki_caller (string), optional identifier for API usage tracking; can also be set as an environment variable MERAKI_PYTHON_SDK_CALLER Default: |
|
meraki_certificate_path (string), path for TLS/SSL certificate verification if behind local proxy Default: |
|
meraki_inherit_logging_config (boolean), Inherits your own logger instance Choices:
|
|
meraki_log_file_prefix (string), log file name appended with date and timestamp Default: |
|
log_path (string), path to output log; by default, working directory of script if not specified Default: |
|
meraki_maximum_retries (integer), retry up to this many times when encountering 429s or other server-side errors Default: |
|
meraki_nginx_429_retry_wait_time (integer), Nginx 429 retry wait time Default: |
|
meraki_output_log (boolean), create an output log file? Choices:
|
|
meraki_print_console (boolean), print logging output to console? Choices:
|
|
meraki_requests_proxy (string), proxy server and port, if needed, for HTTPS Default: |
|
meraki_retry_4xx_error (boolean), retry if encountering other 4XX error (besides 429)? Choices:
|
|
meraki_retry_4xx_error_wait_time (integer), other 4XX error retry wait time Default: |
|
meraki_simulate (boolean), simulate POST/PUT/DELETE calls to prevent changes? Choices:
|
|
meraki_single_request_timeout (integer), maximum number of seconds for each API call Default: |
|
meraki_suppress_logging (boolean), disable all logging? you’re on your own then! Choices:
|
|
meraki_use_iterator_for_get_pages (boolean), list* methods will return an iterator with each object instead of a complete list with all items Choices:
|
|
meraki_wait_on_rate_limit (boolean), retry if 429 rate limit error encountered? Choices:
|
|
The name of the new profile. Must be unique. This param is required on creation. |
|
NetworkId path parameter. Network ID. |
|
Per-SSID radio settings by number. |
|
Settings for SSID 1. |
|
Choice between ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ or ‘multi’. |
|
Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false. Choices:
|
|
Settings for SSID 2. |
|
Choice between ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ or ‘multi’. |
|
Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false. Choices:
|
|
Settings for SSID 3. |
|
Choice between ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ or ‘multi’. |
|
Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false. Choices:
|
|
Settings for SSID 4. |
|
Choice between ‘dual’, ‘2.4ghz’, ‘5ghz’, ‘6ghz’ or ‘multi’. |
|
Steers client to most open band between 2.4 GHz and 5 GHz. Can be either true or false. Choices:
|
|
Settings related to 2.4Ghz band. |
|
Determines whether ax radio on 2.4Ghz band is on or off. Can be either true or false. If false, we highly recommend disabling band steering. Defaults to true. Choices:
|
|
Sets min bitrate (Mbps) of 2.4Ghz band. Can be one of ‘1’, ‘2’, ‘5.5’, ‘6’, ‘9’, ‘11’, ‘12’, ‘18’, ‘24’, ‘36’, ‘48’ or ‘54’. Defaults to 11. |
Notes
Note
SDK Method used are appliance.Appliance.create_network_appliance_rf_profile,
Paths used are post /networks/{networkId}/appliance/rfProfiles,
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco Meraki documentation for appliance createNetworkApplianceRfProfile
Complete reference of the createNetworkApplianceRfProfile API.
Examples
- name: Create
cisco.meraki.networks_appliance_rf_profiles:
meraki_api_key: "{{meraki_api_key}}"
meraki_base_url: "{{meraki_base_url}}"
meraki_single_request_timeout: "{{meraki_single_request_timeout}}"
meraki_certificate_path: "{{meraki_certificate_path}}"
meraki_requests_proxy: "{{meraki_requests_proxy}}"
meraki_wait_on_rate_limit: "{{meraki_wait_on_rate_limit}}"
meraki_nginx_429_retry_wait_time: "{{meraki_nginx_429_retry_wait_time}}"
meraki_action_batch_retry_wait_time: "{{meraki_action_batch_retry_wait_time}}"
meraki_retry_4xx_error: "{{meraki_retry_4xx_error}}"
meraki_retry_4xx_error_wait_time: "{{meraki_retry_4xx_error_wait_time}}"
meraki_maximum_retries: "{{meraki_maximum_retries}}"
meraki_output_log: "{{meraki_output_log}}"
meraki_log_file_prefix: "{{meraki_log_file_prefix}}"
meraki_log_path: "{{meraki_log_path}}"
meraki_print_console: "{{meraki_print_console}}"
meraki_suppress_logging: "{{meraki_suppress_logging}}"
meraki_simulate: "{{meraki_simulate}}"
meraki_be_geo_id: "{{meraki_be_geo_id}}"
meraki_use_iterator_for_get_pages: "{{meraki_use_iterator_for_get_pages}}"
meraki_inherit_logging_config: "{{meraki_inherit_logging_config}}"
state: present
fiveGhzSettings:
axEnabled: true
minBitrate: 48
name: MX RF Profile
networkId: string
perSsidSettings:
'1':
bandOperationMode: dual
bandSteeringEnabled: true
'2':
bandOperationMode: dual
bandSteeringEnabled: true
'3':
bandOperationMode: dual
bandSteeringEnabled: true
'4':
bandOperationMode: dual
bandSteeringEnabled: true
twoFourGhzSettings:
axEnabled: true
minBitrate: 12.0
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Meraki Python SDK Returned: always Sample: |