vyos.vyos.vyos_vlan module – Manage VLANs on VyOS network devices
Note
This module is part of the vyos.vyos collection (version 5.0.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 vyos.vyos 1.0.0
Synopsis
This module provides declarative management of VLANs on VyOS network devices.
Parameters
Parameter |
Comments |
---|---|
Configure Virtual interface address. |
|
List of VLANs definitions. |
|
Configure Virtual interface address. |
|
This is a intent option and checks the operational state of the for given vlan |
|
Delay the play should wait to check for declarative intent params values. |
|
List of interfaces that should be associated to the VLAN. |
|
Name of the VLAN. |
|
State of the VLAN configuration. Choices:
|
|
ID of the VLAN. Range 0-4094. |
|
This is a intent option and checks the operational state of the for given vlan |
|
Delay the play should wait to check for declarative intent params values. Default: |
|
List of interfaces that should be associated to the VLAN. |
|
Name of the VLAN. |
|
Purge VLANs not defined in the aggregate parameter. Choices:
|
|
State of the VLAN configuration. Choices:
|
|
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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always Sample: |