Docs4dev
Docs
ansible / latest / collections / cisco / meraki / meraki_mr_settings_module.html

cisco.meraki.meraki_mr_settings – Manage general settings 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_settings.

Synopsis

  • Allows for configuration of general settings in Meraki MR wireless networks.

Parameters

Parameter Choices/Defaults Comments
auth_key
string / required
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
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.
ipv6_bridge_enabled
boolean
    Choices:
  • no
  • yes
Toggle for enabling or disabling IPv6 bridging in a network.
If enabled, SSIDs must also be configured to use bridge mode.
led_lights_on
boolean
    Choices:
  • no
  • yes
Toggle for enabling or disabling LED lights on all APs in the network.
location_analytics_enabled
boolean
    Choices:
  • no
  • yes
Toggle for enabling or disabling location analytics for your network.
meshing_enabled
boolean
    Choices:
  • no
  • yes
Toggle for enabling or disabling meshing in a network.
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.
rate_limit_retry_time
integer
Default:
165
Number of seconds to retry if rate limiter is triggered.
state
string
    Choices:
  • present ←
  • query
Query or edit wireless settings.
timeout
integer
Default:
30
Time to timeout for HTTP requests.
upgrade_strategy
string
    Choices:
  • minimize_upgrade_time
  • minimize_client_downtime
The upgrade strategy to apply to the network.
Requires firmware version MR 26.8 or higher.
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: 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 Returned Description
data
complex
success
List of wireless settings.

ipv6_bridge_enabled
boolean
success
Toggle for enabling or disabling IPv6 bridging in a network.
If enabled, SSIDs must also be configured to use bridge mode.

Sample:
True
led_lights_on
boolean
success
Toggle for enabling or disabling LED lights on all APs in the network.

Sample:
True
location_analytics_enabled
boolean
success
Toggle for enabling or disabling location analytics for your network.

Sample:
True
meshing_enabled
boolean
success
Toggle for enabling or disabling meshing in a network.

Sample:
True
upgrade_strategy
string
success
The upgrade strategy to apply to the network.
Requires firmware version MR 26.8 or higher.

Sample:
minimize_upgrade_time


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_settings_module.html