meraki_admin – Manage administrators in the Meraki cloud
meraki_admin – Manage administrators in the Meraki cloud
New in version 2.6.
Synopsis
- Allows for creation, management, and visibility into administrators within Meraki.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
auth_key string |
Authentication key provided by the dashboard. Required if environmental variable | ||
string |
Email address for the dashboard administrator. Email cannot be updated. Required when creating or editing an administrator. | ||
host string |
Default: "api.meraki.com" |
Hostname for Meraki dashboard. Can be used to access regional Meraki environments, such as China. | |
name string |
Name of the dashboard administrator. Required when creating a new administrator. | ||
networks - |
List of networks the administrator has privileges on. When creating a new administrator, | ||
access string |
The privilege of the dashboard administrator on the network. Valid options are | ||
id string |
Network ID for which administrator should have privileges assigned. | ||
org_access string |
|
Privileges assigned to the administrator in the organization.
| |
org_id string |
ID of organization. | ||
org_name string |
Name of organization. Used when When creating a new administrator,
| ||
output_level string |
|
Set amount of debug output during module execution. | |
state string / required |
|
Create or modify, or delete an organization If | |
tags - |
Tags the administrator has privileges on. When creating a new administrator, If | ||
access string |
The privilege of the dashboard administrator for the tag. | ||
tag string |
Object tag which privileges should be assigned. | ||
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: 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 | Returned | Description | ||
---|---|---|---|---|
data complex |
success |
List of administrators.
| ||
accountStatus string |
success |
Status of account.
Sample: ok | ||
string |
success |
Email address of administrator.
Sample: | ||
hasApiKey boolean |
success |
Defines whether administrator has an API assigned to their account.
| ||
id string |
success |
Unique identification number of administrator.
Sample: 1234567890 | ||
lastActive string |
success |
Date and time of time the administrator was active within Dashboard.
Sample: 2019-01-28 14:58:56 -0800 | ||
name string |
success |
Given name of administrator.
Sample: John Doe | ||
networks complex |
success |
List of networks administrator has access on.
| ||
access string |
when network permissions are set |
Access level of administrator. Options are 'full', 'read-only', or 'none'.
Sample: read-only | ||
id string |
when network permissions are set |
The network ID.
Sample: N_0123456789 | ||
orgAccess string |
success |
The privilege of the dashboard administrator on the organization. Options are 'full', 'read-only', or 'none'.
Sample: full | ||
tags complex |
success |
Tags the administrator has access on.
| ||
access string |
when tag permissions are set |
Access level of administrator. Options are 'full', 'read-only', or 'none'.
Sample: full | ||
tag string |
when tag permissions are set |
Tag name.
Sample: production | ||
twoFactorAuthEnabled boolean |
success |
Enabled state of two-factor authentication for administrator.
|
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.8/modules/meraki_admin_module.html