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_network.
| 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 |
| 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 |
| - 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 |
| Instructs module whether response keys should be snake case (ex. net_id) or camel case (ex. netId). |
| output_level string |
| 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 |
| 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 |
| 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 |
| 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 |
| If no, it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers. |
| use_proxy boolean |
| If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
| validate_certs boolean |
| Whether to validate HTTP certificates. |
Note
ANSIBLE_MERAKI_FORMAT environment variable to camelcase.- 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
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'] | |
© 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_network_module.html