cisco.meraki.meraki_admin 模块 – 管理 Meraki 云中的管理员

注意

此模块是 cisco.meraki 集合 (版本 2.18.3) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cisco.meraki。

要在 playbook 中使用它，请指定：cisco.meraki.meraki_admin。

cisco.meraki 1.0.0 中的新增功能

已弃用

在以下版本中移除：

3.0.0 版本

原因：

发布了具有增强功能的更新模块

替代方案：

cisco.meraki.organizations_admins

概要

• 允许在 Meraki 中创建、管理和查看管理员。

参数

参数	注释
auth_key 字符串 / 必需	仪表盘提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则需要此密钥。
email 字符串	仪表盘管理员的电子邮件地址。 电子邮件无法更新。 创建或编辑管理员时需要。
host 字符串	Meraki 仪表盘的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
name 字符串	仪表盘管理员的名称。 创建新管理员时需要。
networks 列表 / 元素=字典	管理员拥有权限的网络列表。 创建新管理员时，必须指定 org_name、network 或 tags。
access 字符串	仪表盘管理员在网络上的权限。 有效选项为 full、read-only 或 none。
id 字符串	应为其分配权限的管理员的网络 ID。
network 字符串	应为其分配权限的管理员的网络名称。
org_access 别名：orgAccess 字符串	分配给组织中管理员的权限。 选项 "full" "none" "read-only"
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。 当 name 应引用另一个对象时使用。 创建新管理员时，必须指定 org_name、network 或 tags。
output_format 字符串	指示模块响应键应该是蛇形命名法 (例如 net_id) 还是驼峰式命名法 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
state 字符串 / 必需	创建或修改或删除组织 如果 state 为 absent，则如果同时指定了名称和电子邮件，则名称优先。 选项 "absent" "present" "query"
tags 列表 / 元素=字典	管理员拥有权限的标签。 创建新管理员时，必须指定 org_name、network 或 tags。 如果指定了 none，则必须指定 network 或 tags。
access 字符串	仪表盘管理员对标签的权限。
tag 字符串	应为其分配权限的对象标签。
timeout 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为no，则使用HTTP；否则使用HTTPS。 仅对Meraki内部开发人员有用。 选项 false true ← (默认)
use_proxy 布尔值	如果为no，则即使目标主机环境变量中定义了代理，也不会使用代理。 选项 false ← (默认) true
validate_certs 布尔值	是否验证HTTP证书。 选项 false true ← (默认)

注释

注意

• 有关Meraki API的更多信息，请访问 https://dashboard.meraki.com/api_docs。

• 某些选项可能仅供Meraki内部开发人员使用。

• 从Ansible 2.9开始，Meraki模块将键输出为蛇形命名法。要使用驼峰命名法，请将ANSIBLE_MERAKI_FORMAT环境变量设置为camelcase。

• Ansible的Meraki模块将在Ansible 2.13中停止支持驼峰命名法输出。请更新您的playbook。

• 检查模式会从仪表板下载当前配置，然后将更改与下载的配置进行比较。如果配置存在差异，检查模式将报告已更改，但不会将更改提交到API进行更改验证。

示例

- 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

返回值

常见的返回值已在 此处 记录，以下是此模块特有的字段

键	描述
data 复杂的	管理员列表。 返回：成功
account_status 字符串	帐户状态。 返回：成功 示例："ok"
email 字符串	管理员的电子邮件地址。 返回：成功 示例："[email protected]"
has_api_key 布尔值	定义管理员帐户是否分配了API。 返回：成功 示例：false
id 字符串	管理员的唯一识别号。 返回：成功 示例："1234567890"
last_active 字符串	管理员在仪表板上活跃的日期和时间。 返回：成功 示例："2019-01-28 14:58:56 -0800"
name 字符串	管理员的姓名。 返回：成功 示例："John Doe"
networks 复杂的	管理员可以访问的网络列表。 返回：成功
access 字符串	管理员的访问级别。选项为“full”、“read-only”或“none”。 返回：当设置网络权限时 示例："read-only"
id 字符串	网络ID。 返回：当设置网络权限时 示例："N_0123456789"
org_access 字符串	仪表板管理员对组织的权限。选项为“full”、“read-only”或“none”。 返回：成功 示例："full"
tags 复杂的	管理员可以访问的标签。 返回：成功
access 字符串	管理员的访问级别。选项为“full”、“read-only”或“none”。 返回：当设置标签权限时 示例："full"
tag 字符串	标签名称。 返回：当设置标签权限时 示例："production"
two_factor_auth_enabled 布尔值	管理员双因素身份验证的启用状态。 返回：成功 示例：false

状态

• 此模块将在3.0.0版中移除。[已弃用]

• 更多信息请参见 已弃用。

作者

• Kevin Breit (@kbreit)

收藏链接

• 问题追踪器
• 仓库（源代码）