← Back to index

opnsense_interfaces_vlan (Data Source)

VLANs (Virtual LANs) can be used to segment a single physical network into multiple virtual networks.

Schema

Required

  • id (String) UUID of the resource.

Read-Only

  • description (String) Optional description here for your reference (not parsed).
  • device (String) Custom VLAN name. Custom names are possible, but only if the start of the name matches the required prefix and contains numeric characters or dots, e.g. vlan0.1.2 or qinq0.3.4.
  • parent (String) VLAN capable interface to attach the VLAN to, e.g. vtnet0.
  • priority (Number) 802.1Q VLAN PCP (priority code point).
  • tag (Number) 802.1Q VLAN tag.