[VMware to KVM] Add guest OS for importing VM based on the source VM OS by nvazquez · Pull Request #12802 · apache/cloudstack

nvazquez · 2026-03-12T18:07:00Z

Description

This PR allows identifying and passing the guest OS for VMware VMs to be migrated to KVM

The guestOsIdenfier is retrieved from the source VM along with the host hypervisor version
CloudStack checks existing guest OS mappings for VMware matching the hypervisor version and the OS identifier
- If no entries are retrieved: then the guest OS of the default import template will be used
- If entries are retrieved: a list of matching guest OS mappings are displayed for users to select one.

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?

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

nvazquez · 2026-03-12T18:08:23Z

@blueorangutan package

blueorangutan · 2026-03-12T18:10: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.

codecov · 2026-03-12T18:16:32Z

Codecov Report

❌ Patch coverage is 11.82796% with 82 lines in your changes missing coverage. Please review.
✅ Project coverage is 17.60%. Comparing base (e93ae1a) to head (83caf10).
⚠️ Report is 2 commits behind head on 4.22.

Files with missing lines	Patch %	Lines
...in/java/com/cloud/server/ManagementServerImpl.java	0.00%	18 Missing and 1 partial ⚠️
...in/java/com/cloud/hypervisor/vmware/mo/BaseMO.java	7.14%	13 Missing ⚠️
...dstack/api/response/UnmanagedInstanceResponse.java	0.00%	12 Missing ⚠️
.../org/apache/cloudstack/vm/UnmanagedInstanceTO.java	0.00%	12 Missing ⚠️
...src/main/java/com/cloud/api/ApiResponseHelper.java	0.00%	6 Missing and 3 partials ⚠️
.../src/main/java/com/cloud/vm/UserVmManagerImpl.java	0.00%	4 Missing ⚠️
...e/cloudstack/api/command/admin/vm/ImportVmCmd.java	0.00%	3 Missing ⚠️
...udstack/api/command/user/guest/ListGuestOsCmd.java	0.00%	3 Missing ⚠️
...ain/java/com/cloud/storage/dao/GuestOSDaoImpl.java	0.00%	3 Missing ⚠️
...com/cloud/hypervisor/vmware/util/VmwareHelper.java	80.00%	2 Missing ⚠️
... and 2 more

Additional details and impacted files

@@             Coverage Diff              @@
##               4.22   #12802      +/-   ##
============================================
- Coverage     17.61%   17.60%   -0.01%     
+ Complexity    15661    15660       -1     
============================================
  Files          5917     5917              
  Lines        531430   531462      +32     
  Branches      64973    64973              
============================================
- Hits          93586    93549      -37     
- Misses       427288   427362      +74     
+ Partials      10556    10551       -5

Flag	Coverage Δ
uitests	`3.70% <ø> (-0.01%)`	⬇️
unittests	`18.67% <11.82%> (-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.

blueorangutan · 2026-03-12T19:21:11Z

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

nvazquez · 2026-03-12T20:05:35Z

@blueorangutan test

blueorangutan · 2026-03-12T20:06:03Z

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

api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceResponse.java

blueorangutan · 2026-03-13T13:23:17Z

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

Test	Result	Time (s)	Test File
ContextSuite context=TestListIdsParams>:teardown	`Error`	1.17	test_list_ids_parameter.py
test_01_snapshot_root_disk	`Error`	5.04	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	49.59	test_snapshots.py
test_02_list_snapshots_with_removed_data_store	`Error`	49.60	test_snapshots.py
ContextSuite context=TestSnapshotStandaloneBackup>:teardown	`Error`	32.77	test_snapshots.py
test_01_snapshot_usage	`Error`	29.00	test_usage.py
test_01_vpn_usage	`Error`	1.10	test_usage.py

nvazquez · 2026-03-13T13:41:46Z

@blueorangutan package

blueorangutan · 2026-03-13T14:57:57Z

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

DaanHoogland · 2026-03-16T07:18:16Z

@blueorangutan test ol9 vmware-82u3

blueorangutan · 2026-03-16T07:20:04Z

@DaanHoogland [SL] unsupported parameters provided. Supported mgmt server os are: suse15, alma10, ol10, rocky10, alma9, centos7, centos6, rocky9, alma8, ubuntu18, ol9, ol8, ubuntu22, debian12, ubuntu20, rocky8, ubuntu24. Supported hypervisors are: kvm-centos6, kvm-centos7, kvm-rocky8, kvm-rocky9, kvm-rocky10, kvm-ol8, kvm-ol9, kvm-ol10, kvm-alma8, kvm-alma9, kvm-alma10, kvm-ubuntu18, kvm-ubuntu20, kvm-ubuntu22, kvm-ubuntu24, kvm-debian12, kvm-suse15, vmware-55u3, vmware-60u2, vmware-65u2, vmware-67u3, vmware-70u1, vmware-70u2, vmware-70u3, vmware-80, vmware-80u1, vmware-80u2, vmware-80u3, vmware-80u3e, xenserver-65sp1, xenserver-71, xenserver-74, xenserver-84, xcpng74, xcpng76, xcpng80, xcpng81, xcpng82, xcpng83

DaanHoogland · 2026-03-16T10:28:03Z

@blueorangutan test ol9 vmware-80u3

blueorangutan · 2026-03-16T10:30:04Z

@DaanHoogland a [SL] Trillian-Jenkins test job (ol9 mgmt + vmware-80u3) has been kicked to run smoke tests

rajujith · 2026-03-17T04:23:44Z

@nvazquez

Error in importing

2026-03-17 04:18:46,510 ERROR [c.c.a.ApiServer] (qtp1513608173-368:[ctx-97245118, ctx-bbd84f7a]) (logid:bd327073) unhandled exception executing api command: [Ljava.lang.String;@10db9cad java.lang.NullPointerException: Cannot invoke "org.apache.cloudstack.api.EntityReference.value()" because the return value of "java.lang.Class.getAnnotation(java.lang.Class)" is null
        at com.cloud.api.dispatch.ParamProcessWorker.translateUuidToInternalId(ParamProcessWorker.java:522)
        at com.cloud.api.dispatch.ParamProcessWorker.setFieldValue(ParamProcessWorker.java:433)
        at com.cloud.api.dispatch.ParamProcessWorker.processParameters(ParamProcessWorker.java:208)
        at com.cloud.api.dispatch.ParamProcessWorker.handle(ParamProcessWorker.java:90)
        at com.cloud.api.dispatch.DispatchChain.dispatch(DispatchChain.java:37)
        at com.cloud.api.ApiServer.queueCommand(ApiServer.java:806)

blueorangutan · 2026-03-17T10:57:08Z

[SF] Trillian test result (tid-15664)
Environment: vmware-80u3 (x2), zone: Advanced Networking with Mgmt server ol9
Total time taken: 85447 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12802-t15664-vmware-80u3.zip
Smoke tests completed. 146 look OK, 3 have errors, 0 did not run
Only failed and skipped tests results shown below:

Test	Result	Time (s)	Test File
test_list_vms_metrics_admin	`Error`	3620.72	test_metrics_api.py
test_list_vms_metrics_history	`Error`	3627.84	test_metrics_api.py
test_list_volumes_metrics_history	`Error`	3620.84	test_metrics_api.py
test_01_vpn_usage	`Error`	1.08	test_usage.py
test_01_create_volume	`Failure`	1358.62	test_volumes.py

nvazquez · 2026-03-17T15:02:24Z

@blueorangutan package

blueorangutan · 2026-03-17T15:04:05Z

@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 · 2026-03-17T16:01:52Z

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

DaanHoogland · 2026-03-19T10:29:49Z

server/src/main/java/org/apache/cloudstack/vm/UnmanagedVMsManagerImpl.java

        if (host != null) {
            response.setHostId(host.getUuid());
            response.setHostName(host.getName());
+            if (host.getHypervisorType() != null) {
+                response.setHypervisor(host.getHypervisorType().toString());
+            }
+            response.setHypervisorVersion(host.getHypervisorVersion());
+        } else {
+            // In case the unmanaged instance is on an external host
+            if (instance.getHostName() != null) {
+                response.setHostName(instance.getHostName());
+            }
+            if (instance.getHostHypervisorVersion() != null) {
+                response.setHypervisorVersion(instance.getHostHypervisorVersion());
+            }
+            if (instance.getHypervisorType() != null) {
+                response.setHypervisor(instance.getHypervisorType());
+            }
        }


new method, willbe usable in ApiResponseHelperL5342 as well.

Fixed, actually reusing the one from ApiResponseHelper

nvazquez · 2026-03-20T02:22:06Z

@blueorangutan package

blueorangutan · 2026-03-20T02:24: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 · 2026-03-20T03:43:36Z

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

nvazquez · 2026-03-20T04:08:31Z

@blueorangutan package

blueorangutan · 2026-03-20T04:10: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 · 2026-03-20T05:33:58Z

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

nvazquez · 2026-03-20T13:09:05Z

@blueorangutan test

blueorangutan · 2026-03-20T13:10:04Z

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

blueorangutan · 2026-03-21T05:03:40Z

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

Test	Result	Time (s)	Test File

rajujith

LGTM
Tested , working as expected.

nvazquez added 2 commits March 12, 2026 15:04

[VMware to KVM] Add guest OS for importing VM based on the source VM OS

f82e4e4

Merge branch '4.22' into 422-vmware-to-kvm-guestos

64c6a7b

nvazquez added this to the 4.22.1 milestone Mar 12, 2026

nvazquez requested review from DaanHoogland, Pearl1594, harikrishna-patnala, kiranchavala, rajujith, shwstppr, sureshanaparti, vishesh92 and weizhouapache March 12, 2026 18:07

nvazquez added component:vmware component:migration enhancement labels Mar 12, 2026

boring-cyborg bot added component:api component:management-server component:storage component:UI labels Mar 12, 2026

sureshanaparti reviewed Mar 13, 2026

View reviewed changes

api/src/main/java/org/apache/cloudstack/api/response/UnmanagedInstanceResponse.java Outdated Show resolved Hide resolved

Add hypervisor type to response and fix VMs listing guest OS

1db51ba

boring-cyborg bot added the component:kvm label Mar 13, 2026

sureshanaparti added this to Apache CloudStack 4.22.1 Mar 14, 2026

sureshanaparti moved this to In Progress in Apache CloudStack 4.22.1 Mar 14, 2026

nvazquez added 2 commits March 17, 2026 11:36

Merge branch '4.22' into 422-vmware-to-kvm-guestos

46cdc27

Add missing entity type

d9928c5

DaanHoogland reviewed Mar 19, 2026

View reviewed changes

Refactor

83caf10

rajujith approved these changes Mar 24, 2026

View reviewed changes

sureshanaparti merged commit 7107d28 into apache:4.22 Mar 24, 2026
25 of 26 checks passed

github-project-automation bot moved this from In Progress to Done in Apache CloudStack 4.22.1 Mar 24, 2026

sureshanaparti deleted the 422-vmware-to-kvm-guestos branch March 24, 2026 09:36

nvazquez mentioned this pull request Mar 25, 2026

Improve VMware to KVM migration docs apache/cloudstack-documentation#635

Merged

Conversation

nvazquez commented Mar 12, 2026

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!

nvazquez commented Mar 12, 2026

Uh oh!

blueorangutan commented Mar 12, 2026

Uh oh!

codecov bot commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Mar 12, 2026

Uh oh!

nvazquez commented Mar 12, 2026

Uh oh!

blueorangutan commented Mar 12, 2026

Uh oh!

Uh oh!

blueorangutan commented Mar 13, 2026

Uh oh!

nvazquez commented Mar 13, 2026

Uh oh!

blueorangutan commented Mar 13, 2026

Uh oh!

DaanHoogland commented Mar 16, 2026

Uh oh!

blueorangutan commented Mar 16, 2026

Uh oh!

DaanHoogland commented Mar 16, 2026

Uh oh!

blueorangutan commented Mar 16, 2026

Uh oh!

rajujith commented Mar 17, 2026

Uh oh!

blueorangutan commented Mar 17, 2026

Uh oh!

nvazquez commented Mar 17, 2026

Uh oh!

blueorangutan commented Mar 17, 2026

Uh oh!

blueorangutan commented Mar 17, 2026

Uh oh!

DaanHoogland Mar 19, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Mar 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nvazquez commented Mar 20, 2026

Uh oh!

blueorangutan commented Mar 20, 2026

Uh oh!

blueorangutan commented Mar 20, 2026

Uh oh!

nvazquez commented Mar 20, 2026

Uh oh!

blueorangutan commented Mar 20, 2026

Uh oh!

blueorangutan commented Mar 20, 2026

Uh oh!

nvazquez commented Mar 20, 2026

Uh oh!

blueorangutan commented Mar 20, 2026

Uh oh!

blueorangutan commented Mar 21, 2026

Uh oh!

rajujith left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

codecov bot commented Mar 12, 2026 •

edited

Loading

nvazquez Mar 20, 2026 •

edited

Loading