cisco.meraki.meraki_mx_vlan 模块 – 管理 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_vlan。

已弃用

在以下版本中删除:

版本 3.0.0

原因:

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

替代方案:

cisco.meraki.networks_appliance_vlans

概要

• 在 Meraki 环境中创建、编辑、查询或删除 VLAN。

参数

参数	注释
appliance_ip 字符串	设备的 IP 地址。 地址必须在 subnet 参数中指定的子网内。
auth_key 字符串 / 必需	仪表板提供的身份验证密钥。如果未设置环境变量 MERAKI_KEY，则为必需。
dhcp_boot_filename 字符串	DHCP 引导的启动文件名
dhcp_boot_next_server 字符串	DHCP 引导选项，用于将引导客户端定向到服务器以从中加载引导文件。
dhcp_boot_options_enabled 布尔值	启用 DHCP 引导选项 选项 false true
dhcp_handling 字符串	如何在网络上处理 DHCP 数据包。 选项 “运行 DHCP 服务器” “将 DHCP 中继到 另一台 服务器” “不响应 DHCP 请求” "none" "server" "relay"
dhcp_lease_time 字符串	DHCP 租约计时器设置 选项 “30 分钟” “1 小时” “4 小时” “12 小时” “1 天” “1 周”
dhcp_options 列表 / elements=字典	DHCP 选项值列表
code 整数	DHCP 选项编号。
type 字符串	DHCP 选项值的类型。 选项 "text" "ip" "hex" "integer"
value 字符串	DHCP 选项的值。
dhcp_relay_server_ips 列表 / elements=字符串	要将 DHCP 数据包转发到的 IP 地址。
dns_nameservers 字符串	以分号分隔的 DNS IP 地址列表。 为预编程的 DNS 条目指定以下选项之一：opendns、google_dns、upstream_dns
fixed_ip_assignments 列表 / elements=字典	要通过 DHCP 按 MAC 地址分发的静态 IP 地址分配。
ip 字符串	用于固定 IP 分配绑定的 IP 地址。
mac 字符串	用于固定 IP 分配绑定的 MAC 地址。
name 字符串	IP 分配绑定的描述性名称。
host 字符串	Meraki 仪表板的主机名。 可用于访问区域性 Meraki 环境，例如中国。 默认值： "api.meraki.com"
internal_error_retry_time 整数	如果服务器返回内部服务器错误，则重试的秒数。 默认值： 60
name 别名：vlan_name 字符串	VLAN 的名称。
net_id 字符串	VLAN 所在的网络或应所在的网络的 ID。
net_name 别名：network 字符串	VLAN 所在的网络或应所在的网络的名称。
org_id 字符串	组织的 ID。
org_name 别名：organization 字符串	组织的名称。
output_format 字符串	指示模块响应键是否应为蛇形命名 (例如 net_id) 或驼峰命名 (例如 netId)。 选项 "snakecase" ← (默认) "camelcase"
output_level 字符串	设置模块执行期间的调试输出量。 选项 "debug" "normal" ← (默认)
rate_limit_retry_time 整数	如果触发速率限制器，则重试的秒数。 默认值： 165
reserved_ip_range 列表 / elements=字典	应保留且不通过 DHCP 分发的 IP 地址范围。
comment 字符串	IP 地址保留的描述
end 字符串	保留 IP 地址范围的最后一个 IP 地址，包括在内。
开始 字符串	保留 IP 地址范围的第一个 IP 地址，包括在内。
状态 字符串	指定应查询、创建/修改还是删除对象。 选项 “absent” “present” "query" ←（默认）
子网 字符串	网络子网的 CIDR 表示法。
超时 整数	HTTP 请求的超时时间。 默认值： 30
use_https 布尔值	如果为 no，则将使用 HTTP。否则将使用 HTTPS。 仅对 Meraki 内部开发人员有用。 选项 false true ←（默认）
use_proxy 布尔值	如果为 no，则即使在目标主机上的环境变量中定义了代理，也不会使用代理。 选项 false ←（默认） true
validate_certs 布尔值	是否验证 HTTP 证书。 选项 false true ←（默认）
vlan_id 整数	VLAN 的 ID 号。 ID 应在 1-4096 之间。
vpn_nat_subnet 字符串	如果 VLAN 上启用了 VPN 和 VPN 子网转换，则为转换后的 VPN 子网。

注释

注意

• 如果网络上未启用 VLAN，则 Meraki 的 API 将返回错误。如果网络上启用了 VLAN，则会正确返回 VLAN。

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

• Meraki 的 API 默认情况下禁用网络的 VLAN 支持，并且没有在 API 中启用 VLAN 支持的方法。必须手动启用 VLAN 支持。

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

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

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

• Ansible 的 Meraki 模块将在 Ansible 2.13 中停止支持驼峰式输出。请更新您的剧本。

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

示例

- name: Query all VLANs in a network.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: query
  delegate_to: localhost

- name: Query information about a single VLAN by ID.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    vlan_id: 2
    state: query
  delegate_to: localhost

- name: Create a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlan_id: 2
    name: TestVLAN
    subnet: 192.0.1.0/24
    appliance_ip: 192.0.1.1
  delegate_to: localhost

- name: Update a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: present
    vlan_id: 2
    name: TestVLAN
    subnet: 192.0.1.0/24
    appliance_ip: 192.168.250.2
    fixed_ip_assignments:
      - mac: "13:37:de:ad:be:ef"
        ip: 192.168.250.10
        name: fixed_ip
    reserved_ip_range:
      - start: 192.168.250.10
        end: 192.168.250.20
        comment: reserved_range
    dns_nameservers: opendns
  delegate_to: localhost

- name: Enable DHCP on VLAN with options
  meraki_vlan:
    auth_key: abc123
    state: present
    org_name: YourOrg
    net_name: YourNet
    vlan_id: 2
    name: TestVLAN
    subnet: 192.168.250.0/24
    appliance_ip: 192.168.250.2
    dhcp_handling: server
    dhcp_lease_time: 1 hour
    dhcp_boot_options_enabled: false
    dhcp_options:
      - code: 5
        type: ip
        value: 192.0.1.1
  delegate_to: localhost

- name: Delete a VLAN.
  meraki_vlan:
    auth_key: abc12345
    org_name: YourOrg
    net_name: YourNet
    state: absent
    vlan_id: 2
  delegate_to: localhost

返回值

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

键	描述
响应 复杂	有关已创建或修改的组织的信息 返回：成功
appliance_ip 字符串	VLAN 中 Meraki 设备的 IP 地址 返回：成功 示例： "192.0.1.1"
dhcp_boot_filename 字符串	引导文件的文件名。 返回：成功 示例： "boot.txt"
dhcp_boot_next_server 字符串	DHCP 引导选项，用于将引导客户端定向到服务器以加载引导文件。 返回：成功 示例： "192.0.1.2"
dhcp_boot_options_enabled 布尔值	是否启用了 DHCP 引导选项。 返回：成功 示例： false
dhcp_handling 字符串	VLAN 上 DHCP 服务器的状态。 返回：成功 示例： "运行 DHCP 服务器"
dhcp_lease_time 字符串	服务器活动时的 DHCP 租约时间。 返回：成功 示例： "1 天"
dhcp_options 复杂	DHCP 选项。 返回：成功
code 整数	DHCP 选项的代码。 介于 2 和 254 之间的整数。 返回：成功 示例： 43
type 字符串	DHCP 选项的类型。 选择为 text、ip、hex、integer。 返回：成功 示例： "text"
value 字符串	DHCP 选项的值。 返回：成功 示例： "192.0.1.2"
dnsnamservers 字符串	IP 地址或 Meraki 定义的 DNS 服务器，VLAN 默认应使用这些服务器 返回：成功 示例： "upstream_dns"
fixed_ip_assignments 复杂	已分配 IP 地址的 MAC 地址列表。 返回：成功
macaddress 复杂	已为其分配 IP 地址的 MAC 地址。键值是实际的 MAC 地址。 返回：成功
ip 字符串	分配给 MAC 地址的 IP 地址。 返回：成功 示例： "192.0.1.4"
name 字符串	绑定的描述性名称。 返回：成功 示例： "fixed_ip"
id 整数	VLAN ID 号。 返回：成功 示例： 2
name 字符串	VLAN 的描述性名称。 返回：成功 示例： "TestVLAN"
networkId 字符串	VLAN 所关联的 Meraki 网络的 ID 号。 返回：成功 示例： "N_12345"
reserved_ip_ranges 复杂	保留用于静态分配的 IP 地址范围列表。 返回：成功
comment 字符串	IP 地址保留的描述。 返回：成功 示例： "reserved_range"
end 字符串	保留范围内的最后一个 IP 地址。 返回：成功 示例： "192.0.1.10"
开始 字符串	保留范围内的第一个 IP 地址。 返回：成功 示例： "192.0.1.5"
子网 字符串	VLAN 的 CIDR 表示法 IP 子网。 返回：成功 示例： "192.0.1.0/24"

状态

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

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

作者

• Kevin Breit (@kbreit)

集合链接

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