cisco.meraki.meraki_mx_network_vlan_settings 模块 – 管理 Meraki 网络的 VLAN 设置

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.meraki.meraki_mx_network_vlan_settings。

已弃用

在:中删除

版本 3.0.0

原因:

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

替代方案:

cisco.meraki.networks_appliance_vlans_settings

概要

  • 编辑 Meraki 中网络上的 VLAN 启用状态。

参数

参数

注释

auth_key

字符串 / 必填

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

host

字符串

Meraki 仪表板的主机名。

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

默认值： "api.meraki.com"

internal_error_retry_time

整数

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

默认值： 60

net_id

字符串

网络的 ID 号。

net_name

别名：name，network

字符串

网络的名称。

org_id

字符串

组织的 ID。

org_name

别名：organization

字符串

组织的名称。

output_format

字符串

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

选择

  • "snakecase" ← （默认）

  • "camelcase"

output_level

字符串

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

选择

  • "debug"

  • "normal" ← （默认）

rate_limit_retry_time

整数

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

默认值： 165

state

字符串

创建或修改警报。

选择

  • "present"

  • "query"

timeout

整数

HTTP 请求的超时时间。

默认值： 30

use_https

布尔值

如果为 no，则将使用 HTTP。否则将使用 HTTPS。

仅对 Meraki 内部开发人员有用。

选择

  • false

  • true ← （默认）

use_proxy

布尔值

如果为 no，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。

选择

  • false ← （默认）

  • true

validate_certs

布尔值

是否验证 HTTP 证书。

选择

  • false

  • true ← （默认）

vlans_enabled

布尔值

是否在网络上启用了 VLAN。

选择

  • 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: Update settings
  meraki_mx_network_vlan_settings:
    auth_key: abc123
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlans_enabled: true

返回值

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

键

描述

data

复杂

有关已创建或操作的对象的信息。

已返回： info

vlans_enabled

布尔值

是否为此网络启用了 VLAN。

已返回： success

状态

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

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

作者

  • Kevin Breit (@kbreit)