community.network.edgeswitch_vlan 模块 – 管理 Ubiquiti Edgeswitch 网络设备上的 VLAN

注意

此模块是 community.network 集合(版本 5.1.0)的一部分。

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

要安装它,请使用:ansible-galaxy collection install community.network

要在 playbook 中使用它,请指定:community.network.edgeswitch_vlan

注意

community.network 集合已被弃用,并将从 Ansible 12 中删除。有关更多信息,请参阅讨论主题

已弃用

移除于:

版本 6.0.0

原因:

此集合及其中的所有内容均未维护且已弃用。

替代方案:

未知。

概要

  • 此模块提供对 Ubiquiti Edgeswitch 网络设备上 VLAN 的声明式管理。

别名:network.edgeswitch.edgeswitch_vlan

参数

参数

注释

aggregate

字符串

VLAN 定义的列表。

auto_exclude

布尔值

除非在 *_interfaces 中定义,否则每个交换机接口都将从 vlan_id 中排除。这是所有交换机接口的默认设置。

选择

  • false

  • true

auto_tag

布尔值

除非在 *_interfaces 中定义,否则每个交换机接口都将设置为接受和传输 vlan_id 的未标记帧。这是所有交换机接口的默认设置。

选择

  • false

  • true

auto_untag

布尔值

除非在 *_interfaces 中定义,否则每个交换机接口都将设置为接受未标记的帧并为 vlan_id 传输标记的帧。这是所有交换机接口的默认设置。

选择

  • false

  • true

excluded_interfaces

字符串

应从 VLAN 中排除的接口列表。接受接口范围。

name

字符串

VLAN 的名称。

purge

布尔值

清除未在 aggregate 参数中定义的 VLAN。

选择

  • false ←(默认)

  • true

state

字符串

对 VLAN 配置执行的操作。

选择

  • "present" ←(默认)

  • "absent"

tagged_interfaces

字符串

应接受和传输 VLAN 的标记帧的接口列表。接受接口范围。

untagged_interfaces

字符串

应接受未标记的帧并为 VLAN 传输标记的帧的接口列表。接受接口范围。

vlan_id

字符串

VLAN 的 ID。范围 1-4093。

备注

注意

  • 已针对 edgeswitch 1.7.4 进行测试

  • 此模块使用原生 Ubiquiti VLAN 语法,不支持交换端口兼容性语法。为了清晰起见,强烈建议不要在同一接口上使用两种语法。

  • Edgeswitch 不支持删除或更改 VLAN 1 的名称

  • 由于 auto_tag、auto_untag 和 auto_exclude 是所有接口的一种默认设置,因此它们是互斥的

示例

- name: Create vlan
  community.network.edgeswitch_vlan:
    vlan_id: 100
    name: voice
    action: present

- name: Add interfaces to VLAN
  community.network.edgeswitch_vlan:
    vlan_id: 100
    tagged_interfaces:
      - 0/1
      - 0/4-0/6

- name: Setup three vlans and delete the rest
  community.network.edgeswitch_vlan:
    purge: true
    aggregate:
      - { vlan_id: 1, name: default, auto_untag: true, excluded_interfaces: 0/45-0/48 }
      - { vlan_id: 100, name: voice, auto_tag: true }
      - { vlan_id: 200, name: video, auto_exclude: true, untagged_interfaces: 0/45-0/48, tagged_interfaces: 0/49 }

- name: Delete vlan
  community.network.edgeswitch_vlan:
    vlan_id: 100
    state: absent

返回值

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

描述

commands

列表 / elements=字符串

要发送到设备的配置模式命令列表

返回:始终

示例: ["vlan database", "vlan 100", "vlan name 100 \"test vlan\"", "exit", "interface 0/1", "vlan pvid 50", "vlan participation include 50,100", "vlan tagging 100", "vlan participation exclude 200", "no vlan tagging 200"]

状态

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

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

作者

  • Frederic Bor (@f-bor)