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

注意

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

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

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

要在剧本中使用它，请指定：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，则如果同时指定了 name 和 email，则 name 优先。 选项 "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

返回值

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

键	描述
数据 复杂的	管理员列表。 返回：成功
帐户状态 字符串	帐户状态。 返回：成功 示例： "ok"
email 字符串	管理员的电子邮件地址。 返回：成功 示例： "your@email.com"
拥有 API 密钥 布尔值	定义管理员是否在其帐户中分配了 API。 返回：成功 示例： false
id 字符串	管理员的唯一识别号码。 返回：成功 示例： "1234567890"
上次活跃时间 字符串	管理员在控制面板中活跃的时间的日期和时间。 返回：成功 示例： "2019-01-28 14:58:56 -0800"
name 字符串	管理员的姓名。 返回：成功 示例： "John Doe"
networks 复杂的	管理员有权访问的网络列表。 返回：成功
access 字符串	管理员的访问级别。选项为“完全”、“只读”或“无”。 返回：当设置网络权限时 示例： "read-only"
id 字符串	网络 ID。 返回：当设置网络权限时 示例： "N_0123456789"
组织访问权限 字符串	控制面板管理员对组织的权限。选项为“完全”、“只读”或“无”。 返回：成功 示例： "full"
tags 复杂的	管理员有权访问的标签。 返回：成功
access 字符串	管理员的访问级别。选项为“完全”、“只读”或“无”。 返回：当设置标签权限时 示例： "full"
tag 字符串	标签名称。 返回：当设置标签权限时 示例： "production"
启用双因素身份验证 布尔值	管理员双因素身份验证的启用状态。 返回：成功 示例： false

状态

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

• 有关更多信息，请参阅 已弃用。

作者

• Kevin Breit (@kbreit)

集合链接

• 问题跟踪器
• 代码库（源代码）