Support for custom SSH port for KVM hosts using 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 using the configuration 'kvm.host.discovery.ssh.port', 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 33.33333% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 16.26%. Comparing base (ce42ce5) to head (2e49b0c).
⚠️ Report is 1 commits behind head on 4.20.

Files with missing lines	Patch %	Lines
...che/cloudstack/backup/NetworkerBackupProvider.java	0.00%	2 Missing ⚠️
...rvisor/kvm/discoverer/LibvirtServerDiscoverer.java	0.00%	1 Missing ⚠️
...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.26%           
  Complexity    13428    13428           
=========================================
  Files          5660     5660           
  Lines        499959   499964    +5     
  Branches      60707    60708    +1     
=========================================
+ Hits          81326    81331    +5     
+ Misses       409560   409559    -1     
- Partials       9073     9074    +1

Flag	Coverage Δ
uitests	`4.16% <ø> (ø)`
unittests	`17.12% <33.33%> (+<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

winterhazel · 2026-02-03T12:11:56Z

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

            "This timeout overrides the wait global config. This holds a comma separated key value pairs containing timeout (in seconds) for specific commands. " +
                    "For example: DhcpEntryCommand=600, SavePasswordCommand=300, VmDataCommand=300", false);

+    ConfigKey<Integer> KVMHostDiscoverySshPort = new ConfigKey<>(ConfigKey.CATEGORY_ADVANCED, Integer.class,


Wouldn't it be better to have this as a parameter on host addition/edit to allow configuring it on a host-level?

I think we can, but do we really want to allow to use a different ssh port for all hosts within a cluster? seems a bit overkill.

I don't see a problem allowing it. Maybe a single host needs to use a different port for SSH connection.

ok, a bit of an edge case, only applicable to smaller installations I’d guess (in my ignorance). You are not asking to remove a higher level setting are you? just to add a per host parameter..

the config is applicable for the kvm hosts on the entire cloudstack installation, mainly for large deployments where the custom port is used for all the hosts. it doesn't provide flexibility to set few hosts on one port, and few hosts on the other. it's always better to have all these hosts accessible on the same port. a new host parameter (that can be updated through add or update host call) can provide flexibility, but it's mostly NULL/empty (when not defined or default port is used) and is not applicable for VMware hosts.

@DaanHoogland @weizhouapache I prefer the host-level configuration too

Hi guys, sorry but I don't see what the issue is defining this setting at cluster level, I think trying to scope the setting/detail to host level may not be necessary. Currently the host discovery port is hardcoded to be port 22 globally. This PR will give operators flexibility to set a custom port (in case its needed) for hosts to be added on a cluster (if we scope it to cluster). What do you think? @winterhazel @weizhouapache @sureshanaparti @DaanHoogland

just an example, how to solve this ?

host A: port 2222

host B: port 2223

actually in the AddHost, the name of the parameter is url (the host URL)
it indicates that port should be supported, no API parameter changes needed (+ no UI, no global config changes)

what we can do

parse the host and port from the URL (java.net.URI can be used)

connect to host using the port (use default port 22 if not found)

@weizhouapache I like the idea, however instead of parsing the URL can we simply add a new parameter/UI and keep the setting as a fallback to not rely on the hardcoded value?

@nvazquez
I think it is fine to hardcode the default SSH port as 22, which is allocated by IANA
if user want to use a custom port, pass it as part of host url (host:port), it is more flexible

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

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

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

Conversation

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

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!

winterhazel Feb 3, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nvazquez Feb 4, 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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

blueorangutan commented Feb 4, 2026

Uh oh!

Uh oh!

DaanHoogland left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

codecov bot commented Feb 3, 2026 •

edited

Loading

winterhazel Feb 3, 2026 •

edited

Loading

nvazquez Feb 4, 2026 •

edited

Loading