cisco.meraki.meraki_admin module – Manage administrators in the Meraki cloud
Note
This module is part of the cisco.meraki collection (version 2.18.3).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.meraki
.
To use it in a playbook, specify: cisco.meraki.meraki_admin
.
New in cisco.meraki 1.0.0
DEPRECATED
- Removed in:
version 3.0.0
- Why:
Updated modules released with increased functionality
- Alternative:
cisco.meraki.organizations_admins
Synopsis
Allows for creation, management, and visibility into administrators within Meraki.
Parameters
Parameter |
Comments |
---|---|
Authentication key provided by the dashboard. Required if environmental variable |
|
Email address for the dashboard administrator. Email cannot be updated. Required when creating or editing an administrator. |
|
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. Default: |
|
Number of seconds to retry if server returns an internal server error. Default: |
|
Name of the dashboard administrator. Required when creating a new administrator. |
|
List of networks the administrator has privileges on. When creating a new administrator, |
|
The privilege of the dashboard administrator on the network. Valid options are |
|
Network ID for which administrator should have privileges assigned. |
|
Network name for which administrator should have privileges assigned. |
|
Privileges assigned to the administrator in the organization. Choices:
|
|
ID of organization. |
|
Name of organization. Used when When creating a new administrator, |
|
Instructs module whether response keys should be snake case (ex. Choices:
|
|
Set amount of debug output during module execution. Choices:
|
|
Number of seconds to retry if rate limiter is triggered. Default: |
|
Create or modify, or delete an organization If Choices:
|
|
Tags the administrator has privileges on. When creating a new administrator, If |
|
The privilege of the dashboard administrator for the tag. |
|
Object tag which privileges should be assigned. |
|
Time to timeout for HTTP requests. Default: |
|
If Only useful for internal Meraki developers. Choices:
|
|
If Choices:
|
|
Whether to validate HTTP certificates. Choices:
|
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: Query information about all administrators associated to the organization
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: query
delegate_to: localhost
- name: Query information about a single administrator by name
meraki_admin:
auth_key: abc12345
org_id: 12345
state: query
name: Jane Doe
- name: Query information about a single administrator by email
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: query
email: [email protected]
- name: Create new administrator with organization access
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: present
name: Jane Doe
org_access: read-only
email: [email protected]
- name: Create new administrator with organization access
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: present
name: Jane Doe
org_access: read-only
email: [email protected]
- name: Create a new administrator with organization access
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: present
name: Jane Doe
org_access: read-only
email: [email protected]
- name: Revoke access to an organization for an administrator
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: absent
email: [email protected]
- name: Create a new administrator with full access to two tags
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: present
name: Jane Doe
orgAccess: read-only
email: [email protected]
tags:
- tag: tenant
access: full
- tag: corporate
access: read-only
- name: Create a new administrator with full access to a network
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: present
name: Jane Doe
orgAccess: read-only
email: [email protected]
networks:
- id: N_12345
access: full
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
List of administrators. Returned: success |
|
Status of account. Returned: success Sample: |
|
Email address of administrator. Returned: success Sample: |
|
Defines whether administrator has an API assigned to their account. Returned: success Sample: |
|
Unique identification number of administrator. Returned: success Sample: |
|
Date and time of time the administrator was active within Dashboard. Returned: success Sample: |
|
Given name of administrator. Returned: success Sample: |
|
List of networks administrator has access on. Returned: success |
|
Access level of administrator. Options are ‘full’, ‘read-only’, or ‘none’. Returned: when network permissions are set Sample: |
|
The network ID. Returned: when network permissions are set Sample: |
|
The privilege of the dashboard administrator on the organization. Options are ‘full’, ‘read-only’, or ‘none’. Returned: success Sample: |
|
Tags the administrator has access on. Returned: success |
|
Access level of administrator. Options are ‘full’, ‘read-only’, or ‘none’. Returned: when tag permissions are set Sample: |
|
Tag name. Returned: when tag permissions are set Sample: |
|
Enabled state of two-factor authentication for administrator. Returned: success Sample: |
Status
This module will be removed in version 3.0.0. [deprecated]
For more information see DEPRECATED.