VLANGROUP: VLAN Group
A group of VLANs scoped to a site or functional boundary, enforcing unique VLAN IDs within the group.
Default definition. This article describes the default
VLANGROUP 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 VLANGROUP.Entity properties
| Property | Value |
|---|---|
| Entity code | VLANGROUP |
| Display name | VLAN Group |
| Plural | VLAN Groups |
| Level | 41100 |
Use cases
A group of VLANs scoped to a site or functional boundary, enforcing unique VLAN IDs within the group.
VLANGROUP organises VLANs into logical groups, typically scoped to a site, building, or functional domain. Within a VLAN group, VLAN IDs must be unique (VLAN 100 can only exist once per group), but the same VLAN ID can be reused across different groups. The minVid/maxVid fields define the allowed VLAN ID range for this group (e.g., 100-999 for user VLANs, 1000-2000 for infrastructure). The site lookup scopes the group geographically. The related list shows all VLANs belonging to this group.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Name. |
description | text (multi-line) | Description. | |
site | reference → SITE | Site this VLAN group is scoped to | |
minVid | number | Lowest allowed VLAN ID in this group | |
maxVid | number | Highest allowed VLAN ID in this group |
Relationships
- Lookups:
sitepoints at aSITErecord. - Related lists:
VLANvia objectRef.
Creating a VLAN Group via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "VLANGROUP",
"level": 41100,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"description": "Example text"
}Listing VLAN Groups
GET /v1/entities/VLANGROUP/SUB