[KVM] Allow passing the OS type machine for KVM XML domains through VM setting by nvazquez · Pull Request #11569 · apache/cloudstack

nvazquez · 2025-09-03T15:18:39Z

Description

This PR allows passing the OS type machine for KVM XML domains through the VM setting with name: kvm.guest.os.machine.type.

Fixes: #11512

Documentation PR: apache/cloudstack-documentation#559

Specifically, this allows fixing UUID retrieval of Windows VMs on Ubuntu 24 when passing the machine type = 'pc-i440fx-8.0' (see #11512 and https://gitlab.com/libvirt/libvirt/-/issues/807#note_2724045702)

# virsh dumpxml 108 | grep machine
    <partition>/machine</partition>
    <type arch='x86_64' machine='pc-i440fx-8.0'>hvm</type>

Types of changes

Breaking change (fix or feature that would cause existing functionality to change)
New feature (non-breaking change which adds functionality)
Bug fix (non-breaking change which fixes an issue)
Enhancement (improves an existing feature and functionality)
Cleanup (Code refactoring and cleanup, that may add test cases)
build/CI
test (unit or integration test code)

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Major
Minor

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

Tested on Ubuntu 24 KVM host - deploying Windows VM and retrieving the UUID through the wmic command

How did you try to break this feature and the system with this change?

codecov · 2025-09-03T15:29:12Z

Codecov Report

❌ Patch coverage is 0% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.36%. Comparing base (3d6ec29) to head (3c1064b).
⚠️ Report is 29 commits behind head on main.

Files with missing lines	Patch %	Lines
...ervisor/kvm/resource/LibvirtComputingResource.java	0.00%	1 Missing and 1 partial ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               main   #11569      +/-   ##
============================================
- Coverage     17.36%   17.36%   -0.01%     
+ Complexity    15237    15236       -1     
============================================
  Files          5888     5888              
  Lines        525741   525743       +2     
  Branches      64164    64165       +1     
============================================
- Hits          91274    91270       -4     
- Misses       424167   424172       +5     
- Partials      10300    10301       +1

Flag	Coverage Δ
uitests	`3.63% <ø> (ø)`
unittests	`18.39% <0.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

nvazquez · 2025-09-03T15:59:27Z

@blueorangutan package

blueorangutan · 2025-09-03T16:00:04Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

github-actions · 2025-09-03T16:19:35Z

This pull request has merge conflicts. Dear author, please fix the conflicts and sync your branch with the base branch.

nvazquez · 2025-09-03T16:21:27Z

@blueorangutan package

blueorangutan · 2025-09-03T16:22:04Z

@nvazquez a [SL] Jenkins job has been kicked to build packages. It will be bundled with KVM, XenServer and VMware SystemVM templates. I'll keep you posted as I make progress.

blueorangutan · 2025-09-03T17:28:08Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✖️ debian ✔️ suse15. SL-JID 14836

blueorangutan · 2025-09-03T17:41:07Z

Packaging result [SF]: ✔️ el8 ✔️ el9 ✔️ el10 ✔️ debian ✔️ suse15. SL-JID 14837

nvazquez · 2025-09-03T19:20:24Z

@blueorangutan test

blueorangutan · 2025-09-03T19:22:04Z

@nvazquez a [SL] Trillian-Jenkins test job (ol8 mgmt + kvm-ol8) has been kicked to run smoke tests

weizhouapache · 2025-09-03T19:24:00Z

@nvazquez
maybe machine.type, not type.machine

Can it be set by regular user ?

weizhouapache · 2025-09-03T20:22:10Z

@nvazquez
should the target branch be 4.20 ?

nvazquez · 2025-09-04T10:48:02Z

Thanks @Pearl1594 I'll create a doc PR for that.

@weizhouapache as discussed offline let's keep it targeted to main branch to avoid feature loss on upgrade to 4.21

yadvr · 2025-09-04T11:05:42Z

@nvazquez is this worth raising the PR for 4.20 branch, could you check & change the base branch?

yadvr

LGTM; ideally the machine type could be detected automatically though?

blueorangutan · 2025-09-04T11:34:06Z

[SF] Trillian test result (tid-14206)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 55385 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr11569-t14206-kvm-ol8.zip
Smoke tests completed. 141 look OK, 0 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File

jmgsky · 2025-09-04T12:45:36Z

This looks like it will fix my issue with booting a Juniper VSRX on cloudstack, but I think an option to set other parameters on the underlying qemu virtual machine would be more sustainable.

Specifically, you can set smbios-entry-point-type on the machine (even newer i440fx-8.2 and beyond) and have it still use the older 32-bit smbios 2.x interface. Here is the best example I can find of it's usage with qemu.

api/src/main/java/com/cloud/vm/VmDetailConstants.java

weizhouapache · 2025-09-04T13:18:07Z

@nvazquez is this worth raising the PR for 4.20 branch, could you check & change the base branch?

@rohityadavcloud
I have discussed with @nvazquez , our concern is, when users upgrade from 4.20.2 (assume this PR is included) to 4.21.0 (released already), the setting will be gone.

my opinion is, unless very necessary, let's not introduce new api params, api responses, settings or db changes in minor versions.

nvazquez · 2025-09-04T14:10:44Z

Hi @jmgsky thanks for your input. I think that can be addressed on a separate PR.
I couldn't find references for this attribute on the libvirt documentation, but seems it should be wrapped as a feature on the XML domain. Can you please confirm if this snippet looks correct for a running domain?

<type arch='x86_64' machine='pc-i440fx-8.0'>hvm</type>
<features>
   <sm-bios-entry-point-type value='32'/>
</features>

jmgsky · 2025-09-04T16:18:32Z

@nvazquez - I'm actually not sure if that's right or not. I was trying to do it with extraconfig and qemu:args, but my VM wouldn't even start at that point. I switched to testing using virsh edit manually, and it doesn't like that xml snippet or qemu:args, so I'm honestly not even sure if there's a way to achieve that with libvirt.

nvazquez · 2025-09-04T16:35:17Z

@jmgsky thanks, the extraconfig will attempt to append the snippet as well on the XML domain, should have similar results than editing the XML directly. I couldn't find it mentioned on: https://libvirt.org/formatdomain.html, however checking the example you mentioned can you try the following?

<type arch='x86_64' machine='pc-i440fx-8.0' sm-bios-entry-point-type='32'>hvm</type>

harikrishna-patnala

code LGTM

harikrishna-patnala · 2025-09-10T04:15:24Z

Would it make sense to have a documentation PR - adding a note on the limitation with retrieving UUID on a Windows VM, and how it can be mitigated using this @nvazquez.

@nvazquez can you please raise the doc PR as suggested here

nvazquez · 2025-09-11T01:45:50Z

Hi @harikrishna-patnala @Pearl1594 I have created the documentation PR: apache/cloudstack-documentation#559

DaanHoogland

clgtm

weizhouapache · 2025-09-16T10:42:09Z

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java

                }
            }
            guest.setIothreads(customParams.containsKey(VmDetailConstants.IOTHREADS));
+            if (customParams.containsKey(VmDetailConstants.KVM_GUEST_OS_MACHINE_TYPE)) {


can this be set by every user ?

nvazquez requested review from DaanHoogland, Pearl1594 and weizhouapache September 3, 2025 15:18

boring-cyborg bot added the component:kvm label Sep 3, 2025

Pearl1594 reviewed Sep 3, 2025

View reviewed changes

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java Outdated Show resolved Hide resolved

Pearl1594 reviewed Sep 3, 2025

View reviewed changes

...ypervisors/kvm/src/main/java/com/cloud/hypervisor/kvm/resource/LibvirtComputingResource.java Outdated Show resolved Hide resolved

nvazquez force-pushed the 420-ub24-fix-uuid-winvm branch from cd9929f to 019c925 Compare September 3, 2025 15:52

boring-cyborg bot added the component:api label Sep 3, 2025

nvazquez marked this pull request as ready for review September 3, 2025 15:59

nvazquez changed the title ~~[KVM] Fix for UUID retrieval of Windows VMs on Ubuntu 24~~ [KVM] Allow passing the OS type machine for KVM XML domains through VM setting Sep 3, 2025

[KVM] Allow passing OS type machine to XML domains

7140bed

nvazquez force-pushed the 420-ub24-fix-uuid-winvm branch from 019c925 to 7140bed Compare September 3, 2025 16:19

boring-cyborg bot added component:agent component:build component:integration labels Sep 3, 2025

github-actions bot added the status:has-conflicts label Sep 3, 2025

nvazquez changed the base branch from 4.20 to main September 3, 2025 16:19

nvazquez requested a review from harikrishna-patnala September 3, 2025 16:19

github-actions bot removed the status:has-conflicts label Sep 3, 2025

weizhouapache added this to the 4.20.2 milestone Sep 3, 2025

yadvr changed the base branch from main to 4.20 September 4, 2025 11:05

yadvr changed the base branch from 4.20 to main September 4, 2025 11:05

yadvr approved these changes Sep 4, 2025

View reviewed changes

weizhouapache reviewed Sep 4, 2025

View reviewed changes

api/src/main/java/com/cloud/vm/VmDetailConstants.java Outdated Show resolved Hide resolved

Address review comment

3c1064b

weizhouapache modified the milestones: 4.20.2, 4.22.0 Sep 5, 2025

harikrishna-patnala approved these changes Sep 10, 2025

View reviewed changes

harikrishna-patnala added this to Apache CloudStack 4.22.0 Sep 10, 2025

harikrishna-patnala moved this to In Progress in Apache CloudStack 4.22.0 Sep 10, 2025

nvazquez mentioned this pull request Sep 11, 2025

Add documentation for Instance setting for machine type on KVM apache/cloudstack-documentation#559

Merged

DaanHoogland approved these changes Sep 15, 2025

View reviewed changes

harikrishna-patnala merged commit 96cabf7 into apache:main Sep 16, 2025
25 of 26 checks passed

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.22.0 Sep 16, 2025

harikrishna-patnala deleted the 420-ub24-fix-uuid-winvm branch September 16, 2025 10:19

harikrishna-patnala mentioned this pull request Sep 16, 2025

Unable to retrieve UUID of windows VM using wmic command #11512

Closed

weizhouapache reviewed Sep 16, 2025

View reviewed changes

weizhouapache mentioned this pull request Jan 13, 2026

server: add options for kvm.guest.os.machine.type #12414

Merged

14 tasks

Conversation

nvazquez commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Types of changes

Feature/Enhancement Scale or Bug Severity

Feature/Enhancement Scale

Bug Severity

Screenshots (if appropriate):

How Has This Been Tested?

How did you try to break this feature and the system with this change?

Uh oh!

codecov bot commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

nvazquez commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

github-actions bot commented Sep 3, 2025

Uh oh!

nvazquez commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

nvazquez commented Sep 3, 2025

Uh oh!

blueorangutan commented Sep 3, 2025

Uh oh!

weizhouapache commented Sep 3, 2025

Uh oh!

weizhouapache commented Sep 3, 2025

Uh oh!

nvazquez commented Sep 4, 2025

Uh oh!

yadvr commented Sep 4, 2025

Uh oh!

yadvr left a comment

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Sep 4, 2025

Uh oh!

jmgsky commented Sep 4, 2025

Uh oh!

Uh oh!

weizhouapache commented Sep 4, 2025

Uh oh!

nvazquez commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jmgsky commented Sep 4, 2025

Uh oh!

nvazquez commented Sep 4, 2025

Uh oh!

harikrishna-patnala left a comment

Choose a reason for hiding this comment

Uh oh!

harikrishna-patnala commented Sep 10, 2025

Uh oh!

nvazquez commented Sep 11, 2025

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

weizhouapache Sep 16, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

nvazquez commented Sep 3, 2025 •

edited

Loading

codecov bot commented Sep 3, 2025 •

edited

Loading

nvazquez commented Sep 4, 2025 •

edited

Loading