meraki_admin
Manage reviewed legacy Meraki settings on the controller
Collection: cisco.meraki
Full Name: cisco.meraki.meraki_admin
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Manage reviewed legacy Meraki settings on the controller
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| auth_key | str | yes | ||
| host | str | api.meraki.com | ||
| use_proxy | bool | false | ||
| use_https | bool | true | ||
| validate_certs | bool | true | ||
| output_format | str | snakecase | ||
| output_level | str | normal | ||
| timeout | int | 30 | ||
| org_name | str | |||
| org_id | str | |||
| rate_limit_retry_time | int | 165 | ||
| internal_error_retry_time | int | 60 | ||
| state | str | yes | ||
| name | str | |||
| str | ||||
| org_access | str | |||
| tags | list | |||
| networks | list |
Example
yaml
- 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: jane@doe.com
- 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: jane@doe.com
- 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: jane@doe.com
- 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: jane@doe.com
- name: Revoke access to an organization for an administrator
meraki_admin:
auth_key: abc12345
org_name: YourOrg
state: absent
email: jane@doe.com
- 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: jane@doe.com
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: jane@doe.com
networks:
- id: N_12345
access: full