HYPLICENSE: Hypervisor License
A purchased hypervisor software license entitlement with metric type, quantity, and compliance tracking against deployed infrastructure.
Default definition. This article describes the default
HYPLICENSE 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 HYPLICENSE.Entity properties
| Property | Value |
|---|---|
| Entity code | HYPLICENSE |
| Display name | Hypervisor License |
| Plural | Hypervisor Licenses |
| Level | 302 |
Use cases
HYPLICENSE models purchased hypervisor license entitlements. the legal right to run a hypervisor product on specific hardware. It is a child of HYPCLUSTER via comboKey (SUB|HYPC), tying entitlements to the cluster they cover.
Fields
Entitlement
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Entitlement Name. |
cluster | reference → HYPCLUSTER | Yes | Cluster. |
vendor | reference → VEN | Yes | Vendor. |
product | enum | Yes | Valid ids: vsphere (VMware vSphere), vsan (VMware vSAN), nsx (VMware NSX), vcenter (VMware vCenter), hyperv (Microsoft Hyper-V), winsvr (Windows Server (Datacenter/Standard)), proxmox (Proxmox VE), rhev (Red Hat Virtualisation), nutanix (Nutanix AHV/AOS), xenserver (Citrix Hypervisor), oraclevm (Oracle VM), other (Other). |
edition | enum | Valid ids: essentials (Essentials), essplus (Essentials Plus), standard (Standard), enterprise (Enterprise), entplus (Enterprise Plus), datacenter (Datacenter), foundation (Foundation), advanced (Advanced), pro (Professional), community (Community / Free), other (Other). | |
status | enum | Yes | Valid ids: active (Active), expired (Expired), pending (Pending Activation), suspended (Suspended), cancelled (Cancelled). |
License Metric & Quantity
| Field | Type | Required | Notes |
|---|---|---|---|
metric | enum | Yes | What unit the license is measured in Valid ids: persocket (Per Socket (CPU)), percore (Per Core), pervm (Per VM), perhost (Per Host), percpu (Per Physical CPU), peross (Per OS Environment), subscription (Subscription (unlimited)), sitelicense (Site License). |
purchased | number | Yes | Number of license units purchased |
consumed | number | Calculated from infrastructure: sockets, cores, VMs, or hosts in cluster | |
balance | number | Purchased minus Consumed. Negative = non-compliant | |
complianceStatus | enum | Valid ids: compliant (Compliant), overdeployed (Over-deployed), nearLimit (Near Limit (>80%)), underutilised (Under-utilised), unknown (Unknown). | |
compliancePercent | number | Consumed / Purchased as percentage |
License Keys
| Field | Type | Required | Notes |
|---|---|---|---|
licenseKeys | text (multi-line) | One key per line | |
activationDate | date | Activation Date. | |
serialNumber | text | Contract / Serial Number. |
Commercial
| Field | Type | Required | Notes |
|---|---|---|---|
purchaseDate | date | Purchase Date. | |
purchaseOrder | reference → PO | Purchase Order. | |
purchaseCost | number | Purchase Cost. | |
annualSupportCost | number | Annual Support & Subscription (SnS) renewal cost | |
costPerUnit | number | Purchase cost divided by purchased quantity | |
supportExpiry | date | When vendor support/subscription expires | |
autoRenew | boolean | Auto-Renew. | |
perpetual | boolean | License does not expire (support may still expire) |
Reseller / Agreement
| Field | Type | Required | Notes |
|---|---|---|---|
reseller | reference → VEN | Reseller / Partner. | |
agreementType | enum | Valid ids: ela (Enterprise License Agreement (ELA)), ea (Enterprise Agreement (EA)), select (Select / Select Plus), oem (OEM), direct (Direct), mpsa (MPSA), csp (CSP), other (Other). | |
agreementNumber | text | Agreement Number. |
Audit History
| Field | Type | Required | Notes |
|---|---|---|---|
lastAuditDate | date | Last Vendor Audit. | |
lastAuditResult | enum | Valid ids: pass (Compliant), minor (Minor Shortfall), major (Major Shortfall), notaudited (Not Yet Audited). | |
auditShortfall | number | Number of units over-deployed at last audit | |
auditTrueUpCost | number | Cost paid to resolve audit shortfall | |
nextAuditDate | date | Next Expected Audit. | |
auditNotes | text (multi-line) | Audit Notes. |
Audit Evidence
| Field | Type | Required | Notes |
|---|---|---|---|
auditToolUsed | text | e.g. VMware vCenter License Report, RVTools, MAP Toolkit | |
lastSnapshotDate | date | When license position was last verified against infrastructure | |
snapshotBy | reference → user | Verified By. |
Additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
clusterpoints at aHYPCLUSTERrecord;vendorpoints at aVENrecord;purchaseOrderpoints at aPOrecord;resellerpoints at aVENrecord;snapshotBypoints at a user. - Related lists:
COMPINV,COMPINV.
Creating a Hypervisor License via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "HYPLICENSE",
"level": 302,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example",
"cluster": "",
"vendor": "",
"product": "vsphere"
} Listing Hypervisor Licenses
# All records in your tenant
GET /v1/entities/HYPLICENSE/SUB:<your-sub-id>