ansible.builtin.meraki_admin (v2.6.0) — module

Install Ansible via pip

Install with pip install ansible==2.6.0

Description

Allows for creation, management, and visibility into administrators within Meraki.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
host:
    default: api.meraki.com
    description:
    - Hostname for Meraki dashboard.
    - Can be used to access regional Meraki environments, such as China.
    type: str

name:
    description:
    - Name of the dashboard administrator.
    - Required when creating a new administrator.

tags:
    description:
    - Tags the administrator has privileges on.
    - When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.
    - If C(none) is specified, C(network) or C(tags) must be specified.

email:
    description:
    - Email address for the dashboard administrator.
    - Email cannot be updated.
    - Required when creating or editing an administrator.

state:
    choices:
    - absent
    - present
    - query
    description:
    - Create or modify an organization
    required: true

org_id:
    description:
    - ID of organization.
    type: str

timeout:
    default: 30
    description:
    - Time to timeout for HTTP requests.
    type: int

auth_key:
    description:
    - Authentication key provided by the dashboard. Required if environmental variable
      C(MERAKI_KEY) is not set.
    required: true
    type: str

networks:
    description:
    - List of networks the administrator has privileges on.
    - When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.

org_name:
    aliases:
    - organization
    description:
    - Name of organization.
    - Used when C(name) should refer to another object.
    - When creating a new administrator, C(org_name), C(network), or C(tags) must be specified.
    type: str

orgAccess:
    choices:
    - full
    - none
    - read-only
    description:
    - Privileges assigned to the administrator in the organization.

use_https:
    default: true
    description:
    - If C(no), it will use HTTP. Otherwise it will use HTTPS.
    - Only useful for internal Meraki developers.
    type: bool

use_proxy:
    default: false
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

output_level:
    choices:
    - debug
    - normal
    default: normal
    description:
    - Set amount of debug output during module execution.
    type: str

output_format:
    choices:
    - snakecase
    - camelcase
    default: snakecase
    description:
    - Instructs module whether response keys should be snake case (ex. C(net_id)) or camel
      case (ex. C(netId)).
    type: str

validate_certs:
    default: true
    description:
    - Whether to validate HTTP certificates.
    type: bool

rate_limit_retry_time:
    default: 165
    description:
    - Number of seconds to retry if rate limiter is triggered.
    type: int

internal_error_retry_time:
    default: 60
    description:
    - Number of seconds to retry if server returns an internal server error.
    type: int

Outputs

changed:
  description: Whether object changed as a result of the request.
  returned: info
  sample:
    changed: false
  type: string
data:
  description: Information about the created or manipulated object.
  returned: info
  sample:
  - email: john@doe.com
    id: '12345677890'
    name: John Doe
    networks: []
    orgAccess: full
    tags: []
  type: list
failed:
  description: Boolean value whether the task failed
  returned: info
  sample:
    failed: false
  type: bool
response:
  description: HTTP response description and bytes
  returned: info
  sample:
    response: OK (unknown bytes)
  type: string
status:
  description: HTTP response code
  returned: info
  sample:
    status: 200
  type: int