HYPCLUSTER: Hypervisor Cluster
A hypervisor cluster grouping physical hosts under a single management domain with shared storage, networking, and HA/DRS capabilities.
Default definition. This article describes the default
HYPCLUSTER 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 HYPCLUSTER.Entity properties
| Property | Value |
|---|---|
| Entity code | HYPCLUSTER |
| Display name | Hypervisor Cluster |
| Plural | Hypervisor Clusters |
| Level | 300 |
Use cases
HYPCLUSTER sits between physical servers (COMPINV) and virtual machines (COMPINV with assetType=Virtual Machine). It represents the management-plane cluster (vCenter cluster, SCVMM host group, Proxmox cluster, oVirt cluster) that orchestrates VM placement, live migration, HA failover, and resource balancing across member hosts. The General panel captures platform, version, and management endpoints.
Fields
Cluster Information
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Cluster Name. |
description | text (multi-line) | Description. | |
platform | enum | Yes | Valid ids: 1 (VMware vSphere), 2 (Microsoft Hyper-V), 3 (Proxmox VE), 4 (KVM / libvirt), 5 (Citrix Hypervisor (XenServer)), 6 (Nutanix AHV), 7 (Oracle VM), 8 (oVirt / RHV), 9 (Other). |
version | text | Platform Version. | |
status | enum | Yes | Valid ids: 1 (Active), 2 (Maintenance), 3 (Degraded), 4 (Failed), 5 (Provisioning), 6 (Decommissioned). |
environment | enum | Valid ids: 1 (Production), 2 (Staging), 3 (Development), 4 (Test), 5 (DR). | |
site | reference → SITE | Data centre site where this cluster resides | |
nwplatinst | reference → NWPLATINST | Telecom platform instance this cluster supports | |
dplat | reference → DPLAT | IT platform instance this cluster supports | |
currentSwVersion | reference → VIRTSWVER | Active virtualisation software version |
Management
| Field | Type | Required | Notes |
|---|---|---|---|
managementUrl | text (URL) | vCenter, Proxmox UI, oVirt Engine, etc. | |
apiEndpoint | text (URL) | API Endpoint. | |
managementServer | reference → COMPINV | vCenter appliance, SCVMM server, etc. | |
licenseModel | enum | Valid ids: 1 (Per Socket), 2 (Per Core), 3 (Per VM), 4 (Subscription), 5 (Open Source), 6 (Included (OEM)). | |
licenseKey | text | License Key / Ref. |
Capacity Summary
| Field | Type | Required | Notes |
|---|---|---|---|
hostCount | number | Hosts. | |
vmCount | number | Virtual Machines. | |
totalCpuCores | number | Total CPU Cores. | |
usedCpuCores | number | Allocated vCPUs. | |
totalMemoryGB | number | Total Memory (GB). | |
usedMemoryGB | number | Allocated Memory (GB). | |
totalStorageGB | number | Total Storage (GB). | |
usedStorageGB | number | Used Storage (GB). |
High Availability
| Field | Type | Required | Notes |
|---|---|---|---|
haEnabled | boolean | HA Enabled. | |
admissionControl | boolean | Prevent VM power-on if HA capacity insufficient | |
failoverCapacity | number | Number of host failures the cluster can tolerate | |
hostMonitoring | boolean | Host Monitoring. | |
vmMonitoring | boolean | VM Monitoring. | |
heartbeatDatastores | text | Datastores used for HA heartbeat |
Distributed Resource Scheduling
| Field | Type | Required | Notes |
|---|---|---|---|
drsEnabled | boolean | DRS Enabled. | |
drsAutomationLevel | enum | Valid ids: 1 (Manual), 2 (Partially Automated), 3 (Fully Automated). | |
drsMigrationThreshold | number | 1 = conservative, 5 = aggressive | |
dpmEnabled | boolean | Distributed Power Management - power off idle hosts | |
storagesDrsEnabled | boolean | Storage DRS Enabled. |
License Position
| Field | Type | Required | Notes |
|---|---|---|---|
totalSockets | number | Sum of physicalSockets across all hosts in this cluster | |
totalCores | number | Sum of physicalCores across all hosts | |
totalLicensedSockets | number | Sum of purchased per-socket licenses | |
totalLicensedCores | number | Sum of purchased per-core licenses | |
clusterComplianceStatus | enum | Valid ids: compliant (Compliant), overdeployed (Over-deployed), nearLimit (Near Limit), unknown (Unknown). | |
vmReclaimCandidates | number | VMs flagged as Idle or Underutilised |
Additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
sitepoints at aSITErecord;nwplatinstpoints at aNWPLATINSTrecord;dplatpoints at aDPLATrecord;currentSwVersionpoints at aVIRTSWVERrecord;managementServerpoints at aCOMPINVrecord. - Related lists:
COMPINV,COMPINV,DATASTORE(formatSUB|HYPCLUSTER),VSWITCH(formatSUB|HYPCLUSTER),RESOURCEPOOL(formatSUB|HYPCLUSTER),HYPLICENSE(formatSUB|HYPCLUSTER),VIRTSWVER(formatSUB|HYPCLUSTER).
Creating a Hypervisor Cluster via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "HYPCLUSTER",
"level": 300,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"platform": "1",
"status": "1",
"description": "..."
}Listing Hypervisor Clusters
# All records in your tenant
GET /v1/entities/HYPCLUSTER/SUB:<your-sub-id>