meraki_network – Manage networks in the Meraki cloud

New in version 2.6.

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
auth_key
string
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
disable_my_meraki
boolean
added in 2.7
    Choices:
  • no
  • yes
- Disables 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))
host
string
Default:
"api.meraki.com"
Hostname for Meraki dashboard.
Can be used to access regional Meraki environments, such as China.
net_id
-
ID number of a network.
net_name
-
Name of a network.

aliases: name, network
org_id
integer
ID of organization associated to a network.
org_name
string
Name of organization associated to a network.

aliases: organization
output_level
string
    Choices:
  • debug
  • normal ←
Set amount of debug output during module execution.
state
-
    Choices:
  • absent
  • present ←
  • query
Create or modify an organization.
tags
list
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
-
Timezone associated to network.
type
list
    Choices:
  • 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
    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

Examples

- name: List all networks associated to the YourOrg organization
  meraki_network:
    auth_key: abc12345
    state: query
    org_name: YourOrg
  delegate_to: localhost
- name: Query network named MyNet in the YourOrg organization
  meraki_network:
    auth_key: abc12345
    state: query
    org_name: YourOrg
    net_name: MyNet
  delegate_to: localhost
- 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
  delegate_to: localhost
- 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
  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
 info
Information about the created or manipulated object.
  disableMyMerakiCom
boolean
 success
States whether my.meraki.com and other device portals should be disabled.

Sample:
True
  id
string
 success
Identification string of network.

Sample:
N_12345
  name
string
 success
Written name of network.

Sample:
YourNet
  organizationId
string
 success
Organization ID which owns the network.

Sample:
0987654321
  tags
string
 success
Space delimited tags assigned to network.

Sample:
production wireless
  timeZone
string
 success
Timezone where network resides.

Sample:
America/Chicago
  type
string
 success
Functional type of network.

Sample:
switch


Status

Authors

  • Kevin Breit (@kbreit)

Hint

If you notice any issues in this documentation you can edit this document to improve it.