.. _vyos.rest.vyos_vlan_module: ******************* vyos.rest.vyos_vlan ******************* **Manage VLANs on VyOS network devices via REST API.** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - Manages 802.1Q VLAN sub-interfaces on VyOS Ethernet interfaces using the HTTPS REST API. - Mirrors ``vyos.vyos.vyos_vlan`` but uses the HTTP API. Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
address
string
IP address for the VLAN interface.
aggregate
list / elements=dictionary
List of VLAN definitions.
address
string
interfaces
list / elements=string / required
name
string
state
string
    Choices:
  • present
  • absent
vlan_id
integer / required
api_key
string / required
hostname
string / required
interfaces
list / elements=string
List of physical interfaces to configure the VLAN on.
name
string
VLAN name (used as description on the VIF).
port
integer
Default:
443
purge
boolean
    Choices:
  • no ←
  • yes
Remove VLANs not defined in aggregate.
state
string
    Choices:
  • present ←
  • absent
present to configure, absent to remove.
timeout
integer
Default:
30
verify_ssl
boolean
    Choices:
  • no ←
  • yes
vlan_id
integer
VLAN ID (0-4094).

Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
commands
list
always
set/delete commands issued.


Status ------ Authors ~~~~~~~ - VyOS Community (@vyos)