VIRTSWVER: Virtualisation Software Version
A software version or release of a virtualisation platform running on a hypervisor cluster, with lifecycle dates tracking general availability through end-of-life and end-of-support.
VIRTSWVER 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 VIRTSWVER.Entity properties
| Property | Value |
|---|---|
| Entity code | VIRTSWVER |
| Display name | Virtualisation Software Version |
| Plural | Virtualisation Software Versions |
| Level | 305 |
Use cases
A software version or release of a virtualisation platform running on a hypervisor cluster, with lifecycle dates tracking general availability through end-of-life and end-of-support.
VIRTSWVER tracks software versions for HYPCLUSTER. e.g. ESXi 8.0 Update 3, Proxmox VE 8.2, Hyper-V Server 2025 CU4. Structurally mirrors NWPLATSW (telecom platform software) and DPLATSW (IT platform software) but is a child of HYPCLUSTER via comboKey (SUB|HYPC). The four lifecycle dates (GA, EOL, EOS, EOSupport) are the critical fields for managing virtualisation currency and support expiry. The prereqs multi-objectLookup enables dependency chains (e.g. 'vCenter 8.0 U3 requires ESXi 8.0 U2+'). The Release panel captures change impact, testing, compliance, deployment, and post-deployment details for each version upgrade. important because hypervisor upgrades are high-risk operations affecting all hosted VMs.
Fields
Version Details
| Field | Type | Required | Notes |
|---|---|---|---|
name | text | Yes | Release Name. |
version | text | Version. | |
type | enum | Valid ids: major (Major), minor (Minor), patch (Patch / Update), hotfix (Hotfix), emergency (Emergency Fix). | |
status | enum | Yes | Valid ids: planned (Planned), testing (Testing), active (Active), deprecated (Deprecated), eol (End of Life), retired (Retired). |
cluster | reference → HYPCLUSTER | Yes | Hypervisor Cluster. |
component | enum | Which part of the virtualisation stack this version applies to Valid ids: hypervisor (Hypervisor (ESXi, Hyper-V, PVE)), management (Management (vCenter, SCVMM)), vsan (Storage (vSAN, Ceph)), nsx (Networking (NSX, ACI)), backup (Backup (Veeam, Zerto)), monitoring (Monitoring (vROps, Aria)), other (Other). | |
description | text (multi-line) | Description. |
Lifecycle Dates
| Field | Type | Required | Notes |
|---|---|---|---|
datega | date | General Availability. | |
dateeol | date | End of Life. | |
dateeos | date | End of Sale. | |
dateeosup | date | End of Support. |
Prerequisites & Dependencies
| Field | Type | Required | Notes |
|---|---|---|---|
prereqs | array of references → VIRTSWVER | Other virtualisation software versions required before this one can be deployed | |
minHwVersion | text | e.g. VM hardware version 20, Gen2 | |
compatibilityNotes | text (multi-line) | Known incompatibilities, required driver versions, etc. |
Planning
| Field | Type | Required | Notes |
|---|---|---|---|
dateplan | date | Planned Date. | |
dateactual | date | Actual Date. | |
rbackavail | boolean | Rollback Available. | |
rbackplan | text (multi-line) | Rollback Plan. |
Change & Impact
| Field | Type | Required | Notes |
|---|---|---|---|
changeFeatures | text (multi-line) | New Features. | |
changeFixes | text (multi-line) | Bug Fixes. | |
changeSecurityFixes | text (multi-line) | Security Fixes. | |
risk | enum | Valid ids: low (Low), medium (Medium), high (High), critical (Critical). | |
approvalstatus | enum | Valid ids: pending (Pending), approved (Approved), rejected (Rejected), deferred (Deferred). |
Testing
| Field | Type | Required | Notes |
|---|---|---|---|
teststatus | enum | Valid ids: notstarted (Not Started), inprogress (In Progress), passed (Passed), failed (Failed), blocked (Blocked). | |
testcases | number | Test Coverage (%). | |
testuat | enum | Valid ids: pending (Pending), passed (Passed), failed (Failed). | |
testLabValidated | boolean | Lab Validated. | |
testVmCompatibility | boolean | VM Compatibility Verified. | |
testsignoff | reference → user | Sign-off By. | |
testNotes | text (multi-line) | Test Notes. |
Deployment
| Field | Type | Required | Notes |
|---|---|---|---|
depMaintenanceWindow | text | Maintenance Window. | |
depMethod | enum | Valid ids: rolling (Rolling (host by host)), parallel (Parallel), lifecycle (Lifecycle Manager / VUM), manual (Manual), ansible (Ansible / Automation). | |
depVmsMigrated | boolean | VMs Migrated Pre-upgrade. | |
depDowntimeMinutes | number | Downtime (mins). | |
depNotes | text (multi-line) | Deployment Notes. |
Post-Deployment
| Field | Type | Required | Notes |
|---|---|---|---|
poststatus | enum | Valid ids: ok (OK), issues (Issues Found), rolledback (Rolled Back). | |
postissues | text (multi-line) | Issues. |
Attachments and additional panels
- Activity timeline panel attached.
Relationships
- Lookups:
clusterpoints at aHYPCLUSTERrecord;prereqspoints at multipleVIRTSWVERrecord.
Creating a Virtualisation Software Version via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "VIRTSWVER",
"level": 305,
"comboKey": "SUB:<your-sub-id>|ENT:",
"name": "Example name",
"status": "planned",
"cluster": ""
} Listing Virtualisation Software Versions
GET /v1/entities/VIRTSWVER/SUB