vyos.vyos.vyos_vlan 模块 – 管理 VyOS 网络设备上的 VLAN

注意

此模块是 vyos.vyos 集合（版本 5.0.0）的一部分。

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

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

要在 playbook 中使用它，请指定：vyos.vyos.vyos_vlan。

vyos.vyos 1.0.0 中的新功能

概要 

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

参数 

参数	注释
地址字符串	配置虚拟接口地址。
聚合列表 / 元素=字典	VLAN 定义的列表。
地址字符串	配置虚拟接口地址。
关联接口列表 / 元素=字符串	这是一个意图选项，并检查给定 VLAN `name` 的关联接口的运行状态。如果 `associated_interfaces` 中的值与设备上 VLAN 的运行状态不匹配，则会导致失败。
延迟整数	播放应等待检查声明式意图参数值的延迟。
接口列表 / 元素=字符串 / 必需	应与 VLAN 关联的接口列表。
名称字符串	VLAN 的名称。
状态字符串	VLAN 配置的状态。选项 `"present"` `"absent"`
vlan_id 整数 / 必需	VLAN 的 ID。范围 0-4094。
关联接口列表 / 元素=字符串	这是一个意图选项，并检查给定 VLAN `name` 的关联接口的运行状态。如果 `associated_interfaces` 中的值与设备上 VLAN 的运行状态不匹配，则会导致失败。
延迟整数	播放应等待检查声明式意图参数值的延迟。默认值： `10`
接口列表 / 元素=字符串	应与 VLAN 关联的接口列表。
名称字符串	VLAN 的名称。
清除布尔值	清除未在 aggregate 参数中定义的 VLAN。选项 `false` ← （默认） `true`
状态字符串	VLAN 配置的状态。选项 `"present"` ← （默认） `"absent"`
vlan_id 整数	VLAN 的 ID。范围 0-4094。

备注 

注意

已针对 VyOS 1.1.8 (helium) 进行测试。
此模块与连接 ansible.netcommon.network_cli 一起使用。请参阅 VyOS OS 平台选项。
有关使用 Ansible 管理网络设备的更多信息，请参阅 :ref:`Ansible 网络指南 <network_guide>`

示例 

- name: Create vlan
  vyos.vyos.vyos_vlan:
    vlan_id: 100
    name: vlan-100
    interfaces: eth1
    state: present

- name: Add interfaces to VLAN
  vyos.vyos.vyos_vlan:
    vlan_id: 100
    interfaces:
      - eth1
      - eth2

- name: Configure virtual interface address
  vyos.vyos.vyos_vlan:
    vlan_id: 100
    interfaces: eth1
    address: 172.26.100.37/24

- name: vlan interface config + intent
  vyos.vyos.vyos_vlan:
    vlan_id: 100
    interfaces: eth0
    associated_interfaces:
      - eth0

- name: vlan intent check
  vyos.vyos.vyos_vlan:
    vlan_id: 100
    associated_interfaces:
      - eth3
      - eth4

- name: Delete vlan
  vyos.vyos.vyos_vlan:
    vlan_id: 100
    interfaces: eth1
    state: absent

返回值 

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

键	描述
命令列表 / 元素=字符串	要发送到设备的配置模式命令列表已返回：始终示例： `["set interfaces ethernet eth1 vif 100 description VLAN 100", "set interfaces ethernet eth1 vif 100 address 172.26.100.37/24", "delete interfaces ethernet eth1 vif 100"]`

作者

Trishna Guha (@trishnaguha)