Documentation

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
Authentication key provided by the dashboard. Required if environmental variable MERAKI_KEY is not set.
email
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
    Choices:
  • full
  • none
  • read-only
Privileges assigned to the administrator in the organization.
output_level
    Choices:
  • normal ←
  • debug
Set amount of debug output during module execution
state
required
    Choices:
  • absent
  • present
  • query
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
    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

Examples

- name: Query information about all administrators associated to the organization
  meraki_admin:
    auth_key: abc12345
    state: query
  delegate_to: localhost

- name: Query information about a single administrator by name
  meraki_admin:
    auth_key: abc12345
    state: query
    name: Jane Doe

- name: Query information about a single administrator by email
  meraki_admin:
    auth_key: abc12345
    state: query
    email: jane@doe.com

- name:  new administrator with organization access
  meraki_admin:
    auth_key: abc12345
    state: present
    name: Jane Doe
    orgAccess: read-only
    email: jane@doe.com

- name: Create a new administrator with organization access
  meraki_admin:
    auth_key: abc12345
    state: present
    name: Jane Doe
    orgAccess: read-only
    email: jane@doe.com

- name: Revoke access to an organization for an administrator
  meraki_admin:
    auth_key: abc12345
    state: absent
    email: jane@doe.com

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
changed
string
 info
Whether object changed as a result of the request.

Sample:
{'changed': False}
data
list
 info
Information about the created or manipulated object.

Sample:
[{'orgAccess': 'full', 'name': 'John Doe', 'tags': [], 'networks': [], 'email': 'john@doe.com', 'id': '12345677890'}]
failed
bool
 info
Boolean value whether the task failed

Sample:
{'failed': False}
response
string
 info
HTTP response description and bytes

Sample:
{'response': 'OK (unknown bytes)'}
status
int
 info
HTTP response code

Sample:
{'status': 200}


Status

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

Author

  • Kevin Breit (@kbreit)

Hint

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