New in version 2.6.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_key | Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. | |
disable_my_meraki bool (added in 2.7) |
| - 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 Only useful for internal Meraki developers |
net_id | ID number of a network. | |
net_name | Name of a network. aliases: name, network | |
org_id | ID of organization associated to a network. | |
org_name | Name of organization associated to a network. aliases: organization | |
output_level |
| Set amount of debug output during module execution |
state |
| Create or modify an organization. |
tags | Comma delimited list of tags to assign to network. | |
timeout int | Default: 30 | Time to timeout for HTTP requests. |
timezone | Timezone associated to network. See https://en.wikipedia.org/wiki/List_of_tz_database_time_zones for a list of valid timezones. | |
type |
| Type of network device network manages. Required when creating a network. aliases: net_type |
use_https bool |
| If no , it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers |
use_proxy bool |
| If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
validate_certs bool |
| Whether to validate HTTP certificates. |
Note
- name: List all networks associated to the YourOrg organization meraki_network: auth_key: abc12345 status: query org_name: YourOrg delegate_to: localhost - name: Query network named MyNet in the YourOrg organization meraki_network: auth_key: abc12345 status: query org_name: YourOrg net_name: MyNet delegate_to: localhost - name: Create network named MyNet in the YourOrg organization meraki_network: auth_key: abc12345 status: present org_name: YourOrg net_name: MyNet type: switch timezone: America/Chicago tags: production, chicago delegate_to: localhost
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 bool | success | States whether my.meraki.com and other device portals should be disabled. Sample: True | |
name string | success | Written name of network. Sample: YourNet | |
tags string | success | Space delimited tags assigned to network. Sample: production wireless | |
organizationId string | success | Organization ID which owns the network. Sample: 0987654321 | |
timeZone string | success | Timezone where network resides. Sample: America/Chicago | |
type string | success | Functional type of network. Sample: switch | |
id string | success | Identification string of network. Sample: N_12345 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_network_module.html