Skip to content

Commit a7c7163

Browse files
committed
Update Viridian instructions
Borrow Citrix's instructions to set all Viridian flags and device ID in one command. Signed-off-by: Tu Dinh <ngoc-tu.dinh@vates.tech>
1 parent 2154a58 commit a7c7163

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

docs/vms/vms.md

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -340,20 +340,15 @@ Viridian extensions —referred to as "Viridian enlightenments" by Microsoft—
340340

341341
Viridian enlightenments are enabled by default on Windows VM templates included with XCP-ng.
342342

343-
To enable Viridian enlightenments for other non-Windows VM templates, you need to:
344-
345-
1. **Enable Viridian**. To do this, run `xe vm-param-set uuid=<vm uuid> platform:viridian=true` in your VM.
346-
2. **Enable the extra Viridian parameters** necessary for your template to run optimally with Windows. To do this, run the same `xe` command in your VM, but change the arguments with the following:
347-
348-
```
349-
"device_id": "0002", // ID used by XCP-ng to detect Windows VMs
350-
"viridian": "true",
351-
"viridian_time_ref_count": "true",
352-
"viridian_reference_tsc": "true",
353-
"viridian_apic_assist": "true",
354-
"viridian_crash_ctl": "true",
355-
"viridian_stimer": "true"
356-
```
343+
To enable Viridian enlightenments for other non-Windows VM templates, simply run the following command:
344+
345+
```
346+
xe vm-param-set uuid=<vm-uuid> platform:device_id=0002 platform:viridian=true platform:viridian_time_ref_count=true platform:viridian_reference_tsc=true platform:viridian_apic_assist=true platform:viridian_crash_ctl=true platform:viridian_stimer=true
347+
```
348+
349+
:::warning
350+
Do not set the device ID on VMs with Xen PV drivers installed.
351+
:::
357352

358353
:::
359354

0 commit comments

Comments
 (0)