Support for custom SSH port for KVM hosts from the host url on add host and the configuration by sureshanaparti · Pull Request #12571 · apache/cloudstack

sureshanaparti · 2026-02-03T09:53:37Z

Description

This PR support custom SSH port for KVM hosts from the host url while adding the host and the configuration 'kvm.host.discovery.ssh.port'. The port is used during

KVM host discovery to connect to the Host during Add Host command
Any other operations on host using SSH

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?

…m.host.discovery.ssh.port' - Use the custom SSH port for KVM host discovery to connect to the Host during Add Host command - and any other operations on host using SSH

sureshanaparti · 2026-02-03T09:55:16Z

@blueorangutan package

blueorangutan · 2026-02-03T09:58:04Z

@sureshanaparti 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-02-03T10:01:43Z

Codecov Report

❌ Patch coverage is 44.82759% with 16 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.25%. Comparing base (ce42ce5) to head (c5b915d).
⚠️ Report is 15 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...che/cloudstack/backup/NetworkerBackupProvider.java	0.00%	8 Missing ⚠️
...rvisor/kvm/discoverer/LibvirtServerDiscoverer.java	0.00%	6 Missing ⚠️
...n/java/com/cloud/resource/ResourceManagerImpl.java	0.00%	0 Missing and 1 partial ⚠️
...rc/main/java/com/cloud/utils/ssh/SSHCmdHelper.java	0.00%	1 Missing ⚠️

Additional details and impacted files

@@             Coverage Diff              @@
##               4.20   #12571      +/-   ##
============================================
- Coverage     16.26%   16.25%   -0.01%     
+ Complexity    13428    13427       -1     
============================================
  Files          5660     5662       +2     
  Lines        499959   500165     +206     
  Branches      60707    60733      +26     
============================================
- Hits          81326    81322       -4     
- Misses       409560   409759     +199     
- Partials       9073     9084      +11

Flag	Coverage Δ
uitests	`4.15% <ø> (-0.01%)`	⬇️
unittests	`17.11% <44.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-02-03T10:58:57Z

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

sureshanaparti · 2026-02-03T11:55:27Z

@blueorangutan test

blueorangutan · 2026-02-03T11:56:05Z

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

engine/components-api/src/main/java/com/cloud/agent/AgentManager.java

blueorangutan · 2026-02-04T05:05:47Z

[SF] Trillian test result (tid-15362)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 58847 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12571-t15362-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

engine/components-api/src/main/java/com/cloud/agent/AgentManager.java

…er.java

DaanHoogland

clgtm

…that port if passed, other fall back to config 'kvm.host.discovery.ssh.port')

sureshanaparti · 2026-02-10T06:42:49Z

@blueorangutan package

blueorangutan · 2026-02-10T06:44:04Z

@sureshanaparti 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.

sureshanaparti · 2026-02-10T08:56:57Z

@blueorangutan package

blueorangutan · 2026-02-10T08:58:04Z

@sureshanaparti 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-02-10T10:07:33Z

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

sureshanaparti · 2026-02-10T10:47:42Z

@blueorangutan test

blueorangutan · 2026-02-10T10:50:04Z

@sureshanaparti 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/command/admin/host/AddHostCmd.java

nvazquez · 2026-02-11T01:35:35Z

engine/orchestration/src/main/java/com/cloud/agent/manager/AgentManagerImpl.java

+        String hostPort = host.getDetail(Host.HOST_SSH_POST);
+        int sshPort;
+        if (StringUtils.isBlank(hostPort)) {
+            sshPort = KVMHostDiscoverySshPort.valueIn(host.getClusterId());


Just to double check, in case the setting does not have a value on the cluster, will this method return the global set value, or the default value? It should honor the global value, only in case it is not set either, then use default value (22)

yes @nvazquez, when cluster config is not set, it picks from global (which is defaulted to 22).

Looks good, thanks @sureshanaparti

nvazquez · 2026-02-11T01:40:30Z

engine/orchestration/src/main/java/com/cloud/agent/manager/AgentManagerImpl.java

+            return KVMHostDiscoverySshPort.value();
+        }
+
+        _hostDao.loadDetails(host);


Should there be any check for the host hypervisor type? I think this should be only for KVM

this method is called for KVM hypervisor only now, anyways added check to return default ssh port as 22 for other hypervisors.

Great, thanks

blueorangutan · 2026-02-11T01:48:24Z

[SF] Trillian test result (tid-15428)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 51023 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12571-t15428-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

sureshanaparti · 2026-02-11T12:44:07Z

@blueorangutan package

blueorangutan · 2026-02-11T12:46:05Z

@sureshanaparti 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-02-11T13:42:17Z

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

nvazquez · 2026-02-11T13:48:56Z

@blueorangutan test

blueorangutan · 2026-02-11T13:50:04Z

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

winterhazel

CLGTM

api/src/main/java/com/cloud/host/Host.java

engine/orchestration/src/main/java/com/cloud/agent/manager/AgentManagerImpl.java

blueorangutan · 2026-02-12T05:36:20Z

[SF] Trillian test result (tid-15439)
Environment: kvm-ol8 (x2), zone: Advanced Networking with Mgmt server ol8
Total time taken: 53900 seconds
Marvin logs: https://github.com/blueorangutan/acs-prs/releases/download/trillian/pr12571-t15439-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

sureshanaparti · 2026-02-12T08:19:17Z

@blueorangutan package

blueorangutan · 2026-02-12T08:20:04Z

@sureshanaparti 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-02-12T09:12:57Z

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

kiranchavala

LGTM

Tested manually

Tested the api addhost with url ip : port , the kvm host got added successfully

2026-02-16 12:50:25,538 WARN  [c.c.a.d.ParamGenericValidationWorker] (qtp1390913202-19:[ctx-fca077bb, ctx-d8ee5606]) (logid:658e4ef7) Received unknown parameters for command addHost. Unknown parameters : clustertype
2026-02-16 12:50:25,542 INFO  [c.c.r.ResourceManagerImpl] (qtp1390913202-19:[ctx-fca077bb, ctx-d8ee5606]) (logid:658e4ef7) Trying to add a new host at http://10.0.35.126:223 in data center Zone {"id": "1", "name": "kvmssh", "uuid": "52e92b81-d48c-4413-bdff-257dea9102b9"}

Tested the api addhost with default ssh port 22 url , the kvm host got added successfully

logs

2026-02-16 12:55:03,580 INFO  [c.c.r.ResourceManagerImpl] (qtp1390913202-18:[ctx-fbcec23e, ctx-f96519af]) (logid:babac2c9) Trying to add a new host at http://10.0.33.72 in data center Zone {"id": "1", "name": "kvmssh", "uuid": "52e92b81-d48c-4413-bdff-257dea9102b9"}

Set the setting at cluster level "kvm.host.discovery.ssh.port” to some 223 > but the host is running the ssh service on default 22 port

An exception is thrown by cloudstack

The host.ssh.port details are stored in the database

mysql> select * from host_details;
+----+---------+----------------------------------------------------+------------------------------------------------------+
| id | host_id | name                                               | value                                                |
+----+---------+----------------------------------------------------+------------------------------------------------------+
|  1 |       1 | Host.OS.Kernel.Version                             | 5.4.17-2136.309.5.1.el8uek.x86_64                    |
|  2 |       1 | com.cloud.network.Networks.RouterPrivateIpStrategy | HostLocal                                            |
|  3 |       1 | Host.OS.Version                                    | 8.6                                                  |
|  4 |       1 | host.volume.encryption                             | true                                                 |
|  5 |       1 | host.instance.conversion                           | false                                                |
|  6 |       1 | secured                                            | true                                                 |
|  7 |       1 | Host.OS                                            | Red Hat Enterprise Linux                             |
| 13 |       1 | host.uefi.enable                                   | true                                                 |
| 17 |       1 | password                                           | efdkl3cPYRqbHBZCJf9HcS2okuhCvhkoJ7yjxUEWZS/pag26msTg |
| 20 |       1 | host.ssh.port                                      | 223                                                  |
| 26 |       1 | username                                           | root                                                 |
| 27 |       4 | Host.OS.Kernel.Version                             | 5.4.17-2136.309.5.1.el8uek.x86_64                    |
| 28 |       4 | com.cloud.network.Networks.RouterPrivateIpStrategy | HostLocal                                            |
| 29 |       4 | Host.OS.Version                                    | 8.6                                                  |
| 30 |       4 | host.volume.encryption                             | true                                                 |
| 31 |       4 | host.instance.conversion                           | false                                                |
| 32 |       4 | secured                                            | true                                                 |
| 33 |       4 | Host.OS                                            | Red Hat Enterprise Linux                             |
| 39 |       4 | host.uefi.enable                                   | true                                                 |
| 43 |       4 | password                                           | s5u+ztkYJmSBRkpcH39bDLvLyhbzuBiAsZ1SnUF42jSMa+P0vV9V |
| 51 |       4 | username                                           | root                                                 |
+----+---------+----------------------------------------------------+------------------------------------------------------+
21 rows in set (0.00 sec)

The list host api response also contains the details of the ssh port

(localcloud) 🐱 > list hosts filter=details,
{
  "count": 4,
  "host": [
    {
      "details": {
        "Host.OS": "Red Hat Enterprise Linux",
        "Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
        "Host.OS.Version": "8.6",
        "com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
        "host.ssh.port": "223",
        "host.uefi.enable": "true",
        "secured": "true"
      }
    },
    {},
    {},
    {
      "details": {
        "Host.OS": "Red Hat Enterprise Linux",
        "Host.OS.Kernel.Version": "5.4.17-2136.309.5.1.el8uek.x86_64",
        "Host.OS.Version": "8.6",
        "com.cloud.network.Networks.RouterPrivateIpStrategy": "HostLocal",
        "host.ssh.port": "22",
        "host.uefi.enable": "true",
        "secured": "true"
      }
    }
  ]
}

Performed operations on the host like all the operations succeded

Maintenance mode, migration of vm on the host , force recoonect

weizhouapache · 2026-02-17T12:49:06Z

looks perfect, thanks @kiranchavala

can you test (1) enable host maintenance; (2) cancel host maintenance ? if host.ssh.port is not 22.

kiranchavala · 2026-02-18T11:31:27Z

looks perfect, thanks @kiranchavala

can you test (1) enable host maintenance; (2) cancel host maintenance ? if host.ssh.port is not 22.

Thanks @weizhouapache Tested the maintenance related api calls and it worked fine if the host.ssh.port is not 22.

Support for custom SSH port for KVM hosts using the configuration 'kv…

9692e29

…m.host.discovery.ssh.port' - Use the custom SSH port for KVM host discovery to connect to the Host during Add Host command - and any other operations on host using SSH

boring-cyborg bot added component:agent component:backup component:kvm component:orchestration labels Feb 3, 2026

sureshanaparti added this to the 4.20.3 milestone Feb 3, 2026

sureshanaparti requested review from DaanHoogland and nvazquez February 3, 2026 09:54

sureshanaparti requested a review from abh1sar February 3, 2026 09:59

sureshanaparti added the status:needs-testing label Feb 3, 2026

RosiKyu self-assigned this Feb 3, 2026

winterhazel reviewed Feb 3, 2026

View reviewed changes

engine/components-api/src/main/java/com/cloud/agent/AgentManager.java Show resolved Hide resolved

sureshanaparti commented Feb 4, 2026

View reviewed changes

engine/components-api/src/main/java/com/cloud/agent/AgentManager.java Outdated Show resolved Hide resolved

Update engine/components-api/src/main/java/com/cloud/agent/AgentManag…

2e49b0c

…er.java

DaanHoogland approved these changes Feb 4, 2026

View reviewed changes

nvazquez removed the status:needs-testing label Feb 4, 2026

RosiKyu removed their assignment Feb 5, 2026

nvazquez marked this pull request as draft February 5, 2026 14:19

Pick discovery/ssh port from host url while adding KVM host (and use …

5f4bc91

…that port if passed, other fall back to config 'kvm.host.discovery.ssh.port')

boring-cyborg bot added the component:api label Feb 10, 2026

sureshanaparti marked this pull request as ready for review February 10, 2026 06:41

review changes

fa48e90

nvazquez reviewed Feb 11, 2026

View reviewed changes

review comments

9308f02

winterhazel approved these changes Feb 11, 2026

View reviewed changes

api/src/main/java/com/cloud/host/Host.java Outdated Show resolved Hide resolved

engine/orchestration/src/main/java/com/cloud/agent/manager/AgentManagerImpl.java Outdated Show resolved Hide resolved

review and some unit tests

c5b915d

abh1sar modified the milestones: 4.20.3, 4.20.4 Feb 16, 2026

kiranchavala approved these changes Feb 17, 2026

View reviewed changes

nvazquez approved these changes Feb 18, 2026

View reviewed changes

DaanHoogland merged commit 9dd93ce into apache:4.20 Feb 18, 2026
25 of 26 checks passed

DaanHoogland modified the milestones: 4.20.4, 4.20.3 Feb 18, 2026

DaanHoogland deleted the kvm-custom-ssh-port-support branch February 18, 2026 19:12

Conversation

sureshanaparti commented Feb 3, 2026 • 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!

sureshanaparti commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

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

Uh oh!

Codecov Report

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

sureshanaparti commented Feb 3, 2026

Uh oh!

blueorangutan commented Feb 3, 2026

Uh oh!

Uh oh!

blueorangutan commented Feb 4, 2026

Uh oh!

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

sureshanaparti commented Feb 10, 2026

Uh oh!

blueorangutan commented Feb 10, 2026

Uh oh!

sureshanaparti commented Feb 10, 2026

Uh oh!

blueorangutan commented Feb 10, 2026

Uh oh!

blueorangutan commented Feb 10, 2026

Uh oh!

sureshanaparti commented Feb 10, 2026

Uh oh!

blueorangutan commented Feb 10, 2026

Uh oh!

Uh oh!

nvazquez Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

sureshanaparti Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Feb 11, 2026

Uh oh!

sureshanaparti commented Feb 11, 2026

Uh oh!

blueorangutan commented Feb 11, 2026

Uh oh!

blueorangutan commented Feb 11, 2026

Uh oh!

nvazquez commented Feb 11, 2026

Uh oh!

blueorangutan commented Feb 11, 2026

Uh oh!

winterhazel left a comment

Choose a reason for hiding this comment

sureshanaparti commented Feb 3, 2026 •

edited

Loading

codecov bot commented Feb 3, 2026 •

edited

Loading

kiranchavala left a comment •

edited

Loading