cisco.meraki.meraki_ms_stack 模块 – 修改 Meraki 中交换机堆叠配置。

注意

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

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

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

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

cisco.meraki 1.3.0 中的新增功能

已弃用

移除于：

版本 3.0.0

原因：

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

替代方案：

cisco.meraki.networks_switch_stacks

概要

  • 允许修改 Meraki MS 交换机堆叠。

参数

参数

注释

auth_key

字符串 / 必需

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

host

字符串

Meraki 仪表盘的主机名。

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

默认值： "api.meraki.com"

internal_error_retry_time

整数

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

默认值： 60

name

字符串

堆叠名称。

net_id

字符串

MX 防火墙所在的网络 ID。

net_name

字符串

MX 防火墙所在的网络名称。

org_id

字符串

组织 ID。

org_name

别名：organization

字符串

组织名称。

output_format

字符串

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

选项

  • "snakecase" ← (默认)

  • "camelcase"

output_level

字符串

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

选项

  • "debug"

  • "normal" ← (默认)

rate_limit_retry_time

整数

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

默认值： 165

serials

列表 / 元素=字符串

应包含或从堆叠中移除的交换机序列号列表。

stack_id

字符串

要修改或删除的堆叠 ID。

state

字符串

创建或修改组织。

选项

  • "present" ← (默认)

  • "query"

  • "absent"

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: Create new stack
  meraki_switch_stack:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    name: Test stack
    serials:
    - "ABCD-1231-4579"
    - "ASDF-4321-0987"

- name: Add switch to stack
  meraki_switch_stack:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987
    serials:
    - "ABCD-1231-4579"

- name: Remove switch from stack
  meraki_switch_stack:
    auth_key: abc123
    state: absent
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987
    serials:
    - "ABCD-1231-4579"

- name: Query one stack
  meraki_switch_stack:
    auth_key: abc123
    state: query
    org_name: YourOrg
    net_name: YourNet
    stack_id: ABC12340987

返回值

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

键

描述

data

复杂类型

VPN 设置。

返回：成功

id

字符串

交换机堆叠的 ID。

返回：始终

示例： "7636"

name

字符串

交换机堆叠的描述性名称。

返回：始终

示例： "MyStack"

serials

列表 / 元素=字符串

交换机堆叠中的序列号列表。

返回：始终

示例： ["QBZY-XWVU-TSRQ", "QBAB-CDEF-GHIJ"]

状态

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

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

作者

  • Kevin Breit (@kbreit)