cisco.meraki.meraki_network – Manage networks in the Meraki cloud

Note

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

To install it use: ansible-galaxy collection install cisco.meraki.

To use it in a playbook, specify: cisco.meraki.meraki_network.

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Allows for creation, management, and visibility into networks within Meraki.

Parameters

Parameter	Choices/Defaults	Comments
auth_key string / required		Authentication key provided by the dashboard. Required if environmental variable `MERAKI_KEY` is not set.
enable_vlans boolean	no yes	Boolean value specifying whether VLANs should be supported on a network. Requires `net_name` or `net_id` to be specified.
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.
local_status_page_enabled boolean	no yes	- Enables the local device status pages (U[my.meraki.com](my.meraki.com), U[ap.meraki.com](ap.meraki.com), U[switch.meraki.com](switch.meraki.com), U[wired.meraki.com](wired.meraki.com)). - Only can be specified on its own or with `remote_status_page_enabled`.
net_id string		ID number of a network.
net_name string		Name of a network. aliases: name, network
org_id string		ID of organization.
org_name string		Name of organization. aliases: organization
output_format string	snakecase ← camelcase	Instructs module whether response keys should be snake case (ex. `net_id`) or camel case (ex. `netId`).
output_level string	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.
remote_status_page_enabled boolean	no yes	Enables access to the device status page (http://device LAN IP). Can only be set if `local_status_page_enabled:` is set to `yes`. Only can be specified on its own or with `local_status_page_enabled`.
state string	absent present ← query	Create or modify an organization.
tags list / elements=string		List of tags to assign to network. `tags` name conflicts with the tags parameter in Ansible. Indentation problems may cause unexpected behaviors. Ansible 2.8 converts this to a list from a comma separated list.
timeout integer	Default: 30	Time to timeout for HTTP requests.
timezone string		Timezone associated to network. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for a list of valid timezones.
type list / elements=string	appliance switch wireless	Type of network device network manages. Required when creating a network. As of Ansible 2.8, `combined` type is no longer accepted. As of Ansible 2.8, changes to this parameter are no longer idempotent. aliases: net_type
use_https boolean	no yes ←	If `no`, it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers.
use_proxy boolean	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	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

- delegate_to: localhost
  block:
    - name: List all networks associated to the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
    - name: Query network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
    - name: Create network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type: switch
        timezone: America/Chicago
        tags: production, chicago
    - name: Create combined network named MyNet in the YourOrg organization
      meraki_network:
        auth_key: abc12345
        state: present
        org_name: YourOrg
        net_name: MyNet
        type:
          - switch
          - appliance
        timezone: America/Chicago
        tags: production, chicago
    - name: Enable VLANs on a network
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        enable_vlans: yes
    - name: Modify local status page enabled state
      meraki_network:
        auth_key: abc12345
        state: query
        org_name: YourOrg
        net_name: MyNet
        local_status_page_enabled: yes

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
data complex		info	Information about the created or manipulated object.
	id string	success	Identification string of network. Sample: N_12345
	local_status_page_enabled boolean	success	States whether my.meraki.com and other device portals should be enabled. Sample: True
	name string	success	Written name of network. Sample: YourNet
	organization_id string	success	Organization ID which owns the network. Sample: 0987654321
	remote_status_page_enabled boolean	success	Enables access to the device status page. Sample: True
	tags list / elements=string	success	Space delimited tags assigned to network. Sample: ['production']
	time_zone string	success	Timezone where network resides. Sample: America/Chicago
	type list / elements=string	success	Functional type of network. Sample: ['switch']

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/2.11/collections/cisco/meraki/meraki_network_module.html