You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

vyos.vyos.vyos_vlan module – Manage VLANs on VyOS network devices

Note

This module is part of the vyos.vyos collection (version 2.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vyos.vyos.

To use it in a playbook, specify: vyos.vyos.vyos_vlan.

New in version 1.0.0: of vyos.vyos

Synopsis

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

Note

This module has a corresponding action plugin.

Parameters

Parameter	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	State of the VLAN configuration. Choices: present absent
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	Delay the play should wait to check for declarative intent params values. Default: 10
interfaces list / elements=string	List of interfaces that should be associated to the VLAN.
name string	Name of the VLAN.
provider dictionary	Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli. For more information please see the Network Guide. A dict object containing connection details.
host string	Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
password string	Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port integer	Specifies the port to use when building the connection to the remote device.
ssh_keyfile path	Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout integer	Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
username string	Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
purge boolean	Purge VLANs not defined in the aggregate parameter. Choices: no ← (default) yes
state string	State of the VLAN configuration. Choices: present ← (default) absent
vlan_id integer	ID of the VLAN. Range 0-4094.

Notes

Note

• Tested against VyOS 1.1.8 (helium).

• This module works with connection network_cli. See the VyOS OS Platform Options.

• For more information on using Ansible to manage network devices see the Ansible 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	Description
commands list / elements=string	The list of configuration mode commands to send to the device Returned: always 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”]

Authors

• Trishna Guha (@trishnaguha)

Collection links

Issue Tracker Repository (Sources)