cisco.meraki.meraki_organization 模块 – 管理 Meraki 云中的组织

注意

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

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

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

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

已弃用

移除于:

版本 3.0.0

原因:

更新的模块发布，功能增强

替代方案:

cisco.meraki.organizations

概要

  • 允许创建、管理和查看 Meraki 内的组织。

参数

参数

注释

auth_key

字符串 / 必需

仪表板提供的身份验证密钥。 如果未设置环境变量 MERAKI_KEY，则为必需。

clone

字符串

要克隆到新组织的组织。

delete_confirm

字符串

删除前需要确认的组织 ID。

host

字符串

Meraki 仪表板的主机名。

可用于访问区域 Meraki 环境，例如中国。

默认值: "api.meraki.com"

internal_error_retry_time

整数

如果服务器返回内部服务器错误，则重试的秒数。

默认值: 60

org_id

别名: id

字符串

组织 ID。

org_name

别名: name, organization

字符串

组织名称。

如果指定了 clone，则 org_name 是新组织的名称。

output_format

字符串

指示模块响应键应为蛇形命名法（例如 net_id）还是驼峰命名法（例如 netId）。

选项

  • "snakecase" ← (默认)

  • "camelcase"

output_level

字符串

设置模块执行期间的调试输出量。

选项

  • "debug"

  • "normal" ← (默认)

rate_limit_retry_time

整数

如果触发速率限制器，则重试的秒数。

默认值: 165

state

字符串

创建或修改组织。

如果存在多个同名组织，则必须指定 org_id。

absent 将删除您的整个组织以及所有关联的对象，而无需确认。 请谨慎使用。

选项

  • "absent"

  • "present" ← (默认)

  • "query"

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 模块的输出键值使用蛇形命名法（snake case）。要使用驼峰命名法（camel case），请将 ANSIBLE_MERAKI_FORMAT 环境变量设置为 camelcase。

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

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

示例

- name: Create a new organization named YourOrg
  meraki_organization:
    auth_key: abc12345
    org_name: YourOrg
    state: present
  delegate_to: localhost

- name: Delete an organization named YourOrg
  meraki_organization:
    auth_key: abc12345
    org_name: YourOrg
    state: absent
  delegate_to: localhost

- name: Query information about all organizations associated to the user
  meraki_organization:
    auth_key: abc12345
    state: query
  delegate_to: localhost

- name: Query information about a single organization named YourOrg
  meraki_organization:
    auth_key: abc12345
    org_name: YourOrg
    state: query
  delegate_to: localhost

- name: Rename an organization to RenamedOrg
  meraki_organization:
    auth_key: abc12345
    org_id: 987654321
    org_name: RenamedOrg
    state: present
  delegate_to: localhost

- name: Clone an organization named Org to a new one called ClonedOrg
  meraki_organization:
    auth_key: abc12345
    clone: Org
    org_name: ClonedOrg
    state: present
  delegate_to: localhost

返回值

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

键

描述

data

复杂类型

有关已创建或修改的组织的信息

返回: 成功

id

整数

组织的唯一标识号

返回: 成功

示例: 2930418

name

字符串

组织名称

返回: 成功

示例: "YourOrg"

状态

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

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

作者

  • Kevin Breit (@kbreit)