VLAN: VLAN
A Virtual LAN with a VLAN ID, scoped to a site and VLAN group, with associated IP prefixes.
VLAN definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches VLAN.Entity properties
| Property | Value |
|---|---|
| Entity code | VLAN |
| Display name | VLAN |
| Plural | VLANs |
| Level | 41200 |
Use cases
A Virtual LAN with a VLAN ID, scoped to a site and VLAN group, with associated IP prefixes.
VLAN represents a Layer 2 broadcast domain identified by its 802.1Q VLAN ID (1-4094). Each VLAN belongs to a VLANGROUP which enforces ID uniqueness within its scope, and is associated with a SITE for geographic context. The role field classifies the VLAN's purpose (Production, Management, Storage, Voice, Guest, etc.) which is useful for policy enforcement and documentation. Status tracks the lifecycle from Active through Reserved to Deprecated. The related list shows PREFIX records assigned to this VLAN, providing the L3 overlay for this L2 domain. This entity replaces the free-text VLAN ID fields previously scattered across LOGICALCONNECTION and RACK definitions.
Fields
VLAN Details
| Field | Type | Required | Notes |
|---|---|---|---|
vid | number | Yes | 802.1Q VLAN ID (1-4094) |
name | text | Yes | Descriptive name (e.g., Servers-Prod, Guest-WiFi) |
description | text (multi-line) | Description. | |
status | enum | Yes | Valid ids: 1 (Active), 2 (Reserved), 3 (Deprecated). |
role | enum | Valid ids: 1 (Production), 2 (Development), 3 (Management), 4 (Storage), 5 (Voice), 6 (Guest), 7 (DMZ), 8 (Monitoring), 9 (Backup), 10 (Transit). |
Scope
| Field | Type | Required | Notes |
|---|---|---|---|
site | reference → SITE | Site. | |
vlanGroup | reference → VLANGROUP | VLAN Group. |
Attachments and additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
sitepoints at aSITErecord;vlanGrouppoints at aVLANGROUPrecord. - Related lists:
PREFIXvia objectRef.
Creating a VLAN via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "VLAN",
"level": 41200,
"comboKey": "SUB:<your-sub-id>|ENT:",
"vid": 0,
"name": "Example name",
"status": 1
}Listing VLANs
GET /v1/entities/VLAN/SUB