Skip to content

Update Viridian instructions #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update Viridian instructions #416

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 9 additions & 14 deletions docs/vms/vms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,20 +340,15 @@ Viridian extensions —referred to as "Viridian enlightenments" by Microsoft—

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

To enable Viridian enlightenments for other non-Windows VM templates, you need to:

1. **Enable Viridian**. To do this, run `xe vm-param-set uuid=<vm uuid> platform:viridian=true` in your VM.
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:

```
"device_id": "0002", // ID used by XCP-ng to detect Windows VMs
"viridian": "true",
"viridian_time_ref_count": "true",
"viridian_reference_tsc": "true",
"viridian_apic_assist": "true",
"viridian_crash_ctl": "true",
"viridian_stimer": "true"
```
To enable Viridian enlightenments for other non-Windows VM templates, simply run the following command:

```
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
```

:::warning
Do not set the device ID on VMs with Xen PV drivers installed.
Copy link
Collaborator

@thomas-dkmt thomas-dkmt Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if the user does it? What is the risk we're warning against?

:::

:::

Expand Down