meraki_organization – Manage organizations in the Meraki cloud
meraki_organization – Manage organizations in the Meraki cloud
New in version 2.6.
Synopsis
- Allows for creation, management, and visibility into organizations within Meraki.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_key - |
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. | |
clone - |
Organization to clone to a new organization. | |
host string |
Default: "api.meraki.com" |
Hostname for Meraki dashboard Only useful for internal Meraki developers |
org_id - |
ID of organization.
| |
org_name - |
Name of organization. If
| |
output_level - |
|
Set amount of debug output during module execution |
state - |
|
Create or modify an organization. |
timeout integer |
Default: 30 |
Time to timeout for HTTP requests. |
use_https boolean |
|
If Only useful for internal Meraki developers |
use_proxy boolean |
|
If |
validate_certs boolean |
|
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
Examples
- name: Create a new organization named YourOrg
meraki_organization:
auth_key: abc12345
org_name: YourOrg
state: present
delegate_to: localhost
- name: Query information about all organizations associated to the user
meraki_organization:
auth_key: abc12345
state: query
delegate_to: localhost
- name: Query information about a single organization named YourOrg
meraki_organization:
auth_key: abc12345
org_name: YourOrg
state: query
delegate_to: localhost
- name: Rename an organization to RenamedOrg
meraki_organization:
auth_key: abc12345
org_id: 987654321
org_name: RenamedOrg
state: present
delegate_to: localhost
- name: Clone an organization named Org to a new one called ClonedOrg
meraki_organization:
auth_key: abc12345
clone: Org
org_name: ClonedOrg
state: present
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 |
success |
Information about the organization which was created or modified
| |
id integer |
success |
Unique identification number of organization
Sample: 2930418 | |
name string |
success |
Name of organization
Sample: YourOrg |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Kevin Breit (@kbreit)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_organization_module.html