vyos.vyos.vyos_vlan_module.rst

vyos.vyos.vyos_vlan

Manage VLANs on VyOS network devices

Version added: 1.0.0

• Synopsis
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• This module provides declarative management of VLANs on VyOS network devices.

Parameters

Parameter		Choices/Defaults	Comments
address string			Configure Virtual interface address.
aggregate list / elements=dictionary			List of VLANs definitions.
	address string		Configure Virtual interface address.
	associated_interfaces list / elements=string		This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
	delay integer		Delay the play should wait to check for declarative intent params values.
	interfaces list / elements=string / required		List of interfaces that should be associated to the VLAN.
	name string		Name of the VLAN.
	state string	Choices: present absent	State of the VLAN configuration.
	vlan_id integer / required		ID of the VLAN. Range 0-4094.
associated_interfaces list / elements=string			This is a intent option and checks the operational state of the for given vlan name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vlan on device it will result in failure.
delay integer		Default: 10	Delay the play should wait to check for declarative intent params values.
interfaces list / elements=string			List of interfaces that should be associated to the VLAN.
name string			Name of the VLAN.
purge boolean		Choices: no ← yes	Purge VLANs not defined in the aggregate parameter.
state string		Choices: present ← absent	State of the VLAN configuration.
vlan_id integer			ID of the VLAN. Range 0-4094.

Notes

Note

• Tested against VyOS 1.1.8 (helium).
• This module works with connection ansible.netcommon.network_cli. See the VyOS OS Platform Options.
• For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

Examples

- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
commands list	always	The list of configuration mode commands to send to the device Sample: ['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']

Status

Authors

• Trishna Guha (@trishnaguha)