meraki_organization - Manage organizations in the Meraki cloud¶

New in version 2.6.

Synopsis
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

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. aliases: id
org_name		Name of organization. If `clone` is specified, `org_name` is the name of the new organization. aliases: name, organization
output_level	Choices: normal ← debug	Set amount of debug output during module execution
state	Choices: present ← query	Create or modify an organization.
timeout int	Default: 30	Time to timeout for HTTP requests.
use_https bool	Choices: no yes ←	If `no`, it will use HTTP. Otherwise it will use HTTPS. Only useful for internal Meraki developers
use_proxy bool	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 bool	Choices: no yes ←	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 int	success	Unique identification number of organization Sample: 2930418
	name string	success	Name of organization Sample: YourOrg

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

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.

Author ¶

Kevin Breit (@kbreit)

Hint

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