VSWITCH: Virtual Switch
A virtual switch providing layer-2 network connectivity within a hypervisor cluster, with uplink policies and port groups.
VSWITCH 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 VSWITCH.Entity properties
| Property | Value |
|---|---|
| Entity code | VSWITCH |
| Display name | Virtual Switch |
| Plural | Virtual Switches |
| Level | 310 |
Use cases
A virtual switch providing layer-2 network connectivity within a hypervisor cluster, with uplink policies and port groups.
VSWITCH represents the virtual networking layer inside a hypervisor cluster. vSphere Standard/Distributed vSwitch, Hyper-V Virtual Switch, Open vSwitch in KVM/Proxmox, etc. It is a child of HYPCLUSTER via comboKey (SUB|HYPC). Each vSwitch has one or more VPORTGROUP children that define VLAN segments and security/traffic policies. The Uplinks section captures physical NIC teaming (active-standby, LACP) that connects virtual networking to the physical fabric. The Port Groups related list shows child VPORTGROUP records. This entity bridges the gap between physical network ports (COMPPORTINV on host NICs) and the virtual networks that VMs connect to.
Fields
Switch Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Switch Name. |
description | text (multi-line) | Description. | |
cluster | reference → HYPCLUSTER | Cluster. | |
switchType | enum | Yes | Valid ids: 1 (Standard vSwitch), 2 (Distributed vSwitch), 3 (Hyper-V Virtual Switch), 4 (Open vSwitch), 5 (Linux Bridge), 6 (Other). |
status | enum | Yes | Valid ids: 1 (Active), 2 (Inactive), 3 (Error). |
Configuration
| Field | Type | Required | Notes |
|---|---|---|---|
mtu | number | Maximum Transmission Unit (default 1500, jumbo frames 9000) | |
numberOfPorts | number | Number of Ports. | |
cdpEnabled | boolean | Cisco Discovery Protocol or Link Layer Discovery Protocol | |
netflowEnabled | boolean | NetFlow Enabled. | |
version | text | Distributed vSwitch version or OVS version |
Uplinks & NIC Teaming
| Field | Type | Required | Notes |
|---|---|---|---|
uplinkCount | number | Uplink Count. | |
uplinkPolicy | enum | Valid ids: 1 (Active-Standby), 2 (Active-Active), 3 (LACP), 4 (IP Hash), 5 (Source MAC Hash), 6 (Source Port ID). | |
failoverOrder | text | Active/standby uplink names | |
failback | boolean | Return to primary uplink when it recovers | |
notifySwitches | boolean | Send RARP on failover to update physical switch MAC tables |
Attachments and additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
clusterpoints at aHYPCLUSTERrecord. - Related lists:
VPORTGROUPvia comboKey (format:SUB|HYPCLUSTER|VSWITCH).
Creating a Virtual Switch via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "VSWITCH",
"level": 310,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"switchType": 1,
"status": 1
}Listing Virtual Switches
GET /v1/entities/VSWITCH/SUB