cisco.meraki.meraki_mr_settings module – Manage general settings for Meraki wireless networks
Note
This module is part of the cisco.meraki collection (version 2.13.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_settings
.
Synopsis
Allows for configuration of general settings in Meraki MR wireless networks.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
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: |
|
Toggle for enabling or disabling IPv6 bridging in a network. If enabled, SSIDs must also be configured to use bridge mode. Choices:
|
|
Toggle for enabling or disabling LED lights on all APs in the network. Choices:
|
|
Toggle for enabling or disabling location analytics for your network. Choices:
|
|
Toggle for enabling or disabling meshing in a network. Choices:
|
|
ID of network. |
|
Name of 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: |
|
Query or edit wireless settings. Choices:
|
|
Time to timeout for HTTP requests. Default: |
|
The upgrade strategy to apply to the network. Requires firmware version MR 26.8 or higher. Choices:
|
|
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 all settings
meraki_mr_settings:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: query
delegate_to: localhost
- name: Configure settings
meraki_mr_settings:
auth_key: abc123
org_name: YourOrg
net_name: YourNet
state: present
upgrade_strategy: minimize_upgrade_time
ipv6_bridge_enabled: false
led_lights_on: true
location_analytics_enabled: true
meshing_enabled: true
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of wireless settings. Returned: success |
|
Toggle for enabling or disabling IPv6 bridging in a network. If enabled, SSIDs must also be configured to use bridge mode. Returned: success Sample: |
|
Toggle for enabling or disabling LED lights on all APs in the network. Returned: success Sample: |
|
Toggle for enabling or disabling location analytics for your network. Returned: success Sample: |
|
Toggle for enabling or disabling meshing in a network. Returned: success Sample: |
|
The upgrade strategy to apply to the network. Requires firmware version MR 26.8 or higher. Returned: success Sample: |