VPORTGROUP: Port Group
A VLAN-backed port group on a virtual switch, defining network segmentation, security policies, and traffic shaping for connected VMs.
VPORTGROUP 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 VPORTGROUP.Entity properties
| Property | Value |
|---|---|
| Entity code | VPORTGROUP |
| Display name | Port Group |
| Plural | Port Groups |
| Level | 311 |
Use cases
A VLAN-backed port group on a virtual switch, defining network segmentation, security policies, and traffic shaping for connected VMs.
VPORTGROUP is a child of VSWITCH via comboKey (SUB|HYPC|VSW). It represents a named network segment that VMs attach to. equivalent to a vSphere Port Group, Hyper-V VM Network, or OVS port/bridge. Each port group defines the VLAN tagging, security posture (promiscuous mode, MAC changes, forged transmits), and optional traffic shaping. The ipSubnet field links to the existing IPADDRESS or IPRANGE entities to tie virtual networking back to the IP address management model. VMs reference a port group via the networkPortGroup field on COMPINV.
Fields
Port Group Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Port Group Name. |
description | text (multi-line) | Description. | |
vswitch | reference → VSWITCH | Virtual Switch. | |
status | enum | Yes | Valid ids: 1 (Active), 2 (Inactive), 3 (Error). |
VLAN Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
vlanId | number | 0 = none, 4095 = trunk all | |
vlanType | enum | Valid ids: 1 (Access), 2 (Trunk), 3 (Private VLAN (Promiscuous)), 4 (Private VLAN (Isolated)), 5 (Private VLAN (Community)). | |
trunkRange | text | e.g. 100-200,300,400-410 | |
ipSubnet | reference → IPRANGE | Associated IP range for this network segment | |
gateway | text | Gateway. | |
activePorts | number | Active Ports. Read only. |
Security Policy
| Field | Type | Required | Notes |
|---|---|---|---|
promiscuousMode | enum | Valid ids: 1 (Reject), 2 (Accept), 3 (Inherit). | |
macChanges | enum | Valid ids: 1 (Reject), 2 (Accept), 3 (Inherit). | |
forgedTransmits | enum | Valid ids: 1 (Reject), 2 (Accept), 3 (Inherit). |
Traffic Shaping
| Field | Type | Required | Notes |
|---|---|---|---|
trafficShapingEnabled | boolean | Traffic Shaping Enabled. | |
avgBandwidthKbps | number | Avg Bandwidth (Kbps). | |
peakBandwidthKbps | number | Peak Bandwidth (Kbps). | |
burstSizeKb | number | Burst Size (KB). |
Attachments and additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
vswitchpoints at aVSWITCHrecord;ipSubnetpoints at aIPRANGErecord. - Related lists:
COMPINVvia link.
Creating a Port Group via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "VPORTGROUP",
"level": 311,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"status": 1
}Listing Port Groups
GET /v1/entities/VPORTGROUP/SUB