docs/models/ipam/vlan.md
A Virtual LAN (VLAN) represents an isolated layer two domain, identified by a name and a numeric ID (1-4094) as defined in IEEE 802.1Q. VLANs are arranged into VLAN groups to define scope and to enforce uniqueness.
Multiple VLANs can be created at once by selecting the "Bulk Create" tab on the VLAN creation form. Enter the desired VLAN IDs and/or ID ranges as a comma-separated list (e.g. 100,200-210,4000-4010). The string {vid} may be embedded in the name field as a placeholder for each VLAN's ID; for example, VLAN-{vid} yields VLAN-100, VLAN-200, and so on. All other attributes (status, role, tenant, etc.) are applied to every new VLAN.
The operation is atomic: if any VLAN fails validation (for example, a VLAN ID falling outside the assigned group's permitted ranges), no VLANs are created.
A 12-bit numeric ID for the VLAN, 1-4094 (inclusive).
The configured VLAN name.
The VLAN's operational status.
!!! tip
Additional statuses may be defined by setting VLAN.status under the FIELD_CHOICES configuration parameter.
The user-defined functional role assigned to the VLAN.
!!! warning "Site assignment is deprecated" The assignment of individual VLANs directly to a site has been deprecated. This ability will be removed in a future NetBox release. Users are strongly encouraged to utilize VLAN groups, which have the added benefit of supporting the assignment of a VLAN to multiple sites.
The VLAN group or site to which the VLAN is assigned.
For VLANs which comprise a Q-in-Q/IEEE 802.1ad topology, this field indicates whether the VLAN is treated as a service or customer VLAN.
The designated parent service VLAN for a Q-in-Q customer VLAN. This may be set only for Q-in-Q custom VLANs.