cisco.meraki.meraki_organization – Manage organizations in the Meraki cloud
cisco.meraki.meraki_organization – Manage organizations in the Meraki cloud
Note
This plugin is part of the cisco.meraki collection (version 2.1.3).
To install it use: ansible-galaxy collection install cisco.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_organization
.
Synopsis
- Allows for creation, management, and visibility into organizations within Meraki.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_key string / required |
Authentication key provided by the dashboard. Required if environmental variable | |
clone string |
Organization to clone to a new organization. | |
delete_confirm string |
ID of organization required for confirmation before deletion. | |
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. |
org_id string |
ID of organization.
| |
org_name string |
Name of organization. If
| |
output_format string |
|
Instructs module whether response keys should be snake case (ex. |
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. |
state string |
|
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.
- 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
- name: Create a new organization named YourOrg
meraki_organization:
auth_key: abc12345
org_name: YourOrg
state: present
delegate_to: localhost
- name: Delete an organization named YourOrg
meraki_organization:
auth_key: abc12345
org_name: YourOrg
state: absent
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 |
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.10/collections/cisco/meraki/meraki_organization_module.html