New in version 2.6.
Parameter | Choices/Defaults | Comments |
---|---|---|
auth_key | Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set. | |
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 Only useful for internal Meraki developers |
name | 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, org_name , network , or tags must be specified. | |
org_id | ID of organization. | |
org_name | Name of organization. Used when name should refer to another object.When creating a new administrator, org_name , network , or tags must be specified.aliases: organization | |
orgAccess |
| Privileges assigned to the administrator in the organization. |
output_level |
| Set amount of debug output during module execution |
state required |
| Create or modify an organization |
tags | Tags the administrator has privileges on. When creating a new administrator, org_name , network , or tags must be specified.If none is specified, network or tags must be specified. | |
timeout int | Default: 30 | Time to timeout for HTTP requests. |
use_https bool |
| If no , it will use HTTP. Otherwise it will use HTTPS.Only useful for internal Meraki developers |
use_proxy bool |
| If no , it will not use a proxy, even if one is defined in an environment variable on the target hosts. |
validate_certs bool |
| Whether to validate HTTP certificates. |
Note
- 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 orgAccess: 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 orgAccess: 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 orgAccess: 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]
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | ||
---|---|---|---|---|
data complex | success | List of administrators. | ||
orgAccess string | success | The privilege of the dashboard administrator on the organization. Options are 'full', 'read-only', or 'none'. Sample: full | ||
name string | success | Given name of administrator. Sample: John Doe | ||
tags complex | success | Tags the adminsitrator 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 | ||
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 | ||
email string | success | Email address of administrator. Sample: | ||
id string | success | Unique identification number of administrator. Sample: 1234567890 |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/meraki_admin_module.html