ansible / ansible.builtin / v2.9.0 / module / meraki_organization Manage organizations in the Meraki cloud | "added in version" 2.6 of ansible.builtin" Authors: Kevin Breit (@kbreit) preview | supported by communityansible.builtin.meraki_organization (v2.9.0) — module
pip
Install with pip install ansible==2.9.0
Allows for creation, management, and visibility into organizations within Meraki.
- 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
host: default: api.meraki.com description: - Hostname for Meraki dashboard. - Can be used to access regional Meraki environments, such as China. type: str clone: description: - Organization to clone to a new organization. state: choices: - present - query default: present description: - Create or modify an organization. - C(org_id) must be specified if multiple organizations of the same name exist. org_id: aliases: - id description: - ID of organization. type: str timeout: default: 30 description: - Time to timeout for HTTP requests. type: int auth_key: description: - Authentication key provided by the dashboard. Required if environmental variable C(MERAKI_KEY) is not set. required: true type: str org_name: aliases: - name - organization description: - Name of organization. - If C(clone) is specified, C(org_name) is the name of the new organization. type: str use_https: default: true description: - If C(no), it will use HTTP. Otherwise it will use HTTPS. - Only useful for internal Meraki developers. type: bool use_proxy: default: false description: - If C(no), it will not use a proxy, even if one is defined in an environment variable on the target hosts. type: bool output_level: choices: - debug - normal default: normal description: - Set amount of debug output during module execution. type: str output_format: choices: - snakecase - camelcase default: snakecase description: - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel case (ex. C(netId)). type: str validate_certs: default: true description: - Whether to validate HTTP certificates. type: bool rate_limit_retry_time: default: 165 description: - Number of seconds to retry if rate limiter is triggered. type: int internal_error_retry_time: default: 60 description: - Number of seconds to retry if server returns an internal server error. type: int
data: contains: id: description: Unique identification number of organization returned: success sample: 2930418 type: int name: description: Name of organization returned: success sample: YourOrg type: str description: Information about the organization which was created or modified returned: success type: complex