cisco.meraki.meraki_network module – Manage networks in the Meraki cloud
Note
This module is part of the cisco.meraki collection (version 2.18.1).
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
.
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.networks
Synopsis
Allows for creation, management, and visibility into networks within Meraki.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
New network inherits properties from this network ID. Other provided parameters will override the copied configuration. Type which must match this network’s type exactly. |
|
Boolean value specifying whether VLANs should be supported on a network. Requires Choices:
|
|
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: |
|
Choices:
|
|
ID number of a network. |
|
Name of a 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: |
|
This no longer works and will likely be moved to a separate module. Enables access to the device status page (http://device LAN IP). Can only be set if Only can be specified on its own or with Choices:
|
|
Create or modify an organization. Choices:
|
|
List of tags to assign to network.
Ansible 2.8 converts this to a list from a comma separated list. |
|
Time to timeout for HTTP requests. Default: |
|
Timezone associated to network. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for a list of valid timezones. |
|
Type of network device network manages. Required when creating a network. As of Ansible 2.8, As of Ansible 2.8, changes to this parameter are no longer idempotent. 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
- 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: Create new network based on an existing network
meraki_network:
auth_key: abc12345
state: present
org_name: YourOrg
net_name: MyNet
type:
- switch
- appliance
copy_from_network_id: N_1234
- 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 |
Description |
---|---|
Information about the created or manipulated object. Returned: info |
|
Identification string of network. Returned: success Sample: |
|
States whether my.meraki.com and other device portals should be enabled. Returned: success Sample: |
|
Written name of network. Returned: success Sample: |
|
Organization ID which owns the network. Returned: success Sample: |
|
Enables access to the device status page. Returned: success Sample: |
|
Space delimited tags assigned to network. Returned: success Sample: |
|
Timezone where network resides. Returned: success Sample: |
|
Functional type of network. Returned: success Sample: |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.