Veeam plugin fails when Enterprise Manager and Veeam B&R are on separate hosts (Get-VBRJob over SSH not available)
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 48/100
- Issue type
- Bug
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- java, powershell
- Domain
- backend, infrastructure
Research direction
Start with VeeamClient.java, especially getRepositoryNameFromJob and cloneVeeamJob, and the Veeam plugin configuration and documentation. Trace how the Enterprise Manager URL is also used as the SSH target, then check the plugin tests and supported Veeam version notes. Done means the separate-host setup can complete instance assignment, with a clear error when PowerShell is unavailable.
Written by the indexing model from the issue text.
Description
Summary
The Veeam B&R backup plugin uses the host from backup.plugin.veeam.url both for the Enterprise Manager REST API and for an SSH session in which it runs Veeam B&R PowerShell commands (e.g. Get-VBRJob). This implicitly requires Enterprise Manager and Veeam Backup & Replication (with its PowerShell module) to be installed on the same host.
A common Veeam architecture runs Enterprise Manager on a dedicated server that manages several backup servers. In this setup the REST part of the plugin works, but every operation that needs PowerShell fails, because the Veeam PowerShell module is not available on the Enterprise Manager host. As a result, instances cannot be assigned to a backup offering.
Environment
- Apache CloudStack 4.23.0.0, VMware vSphere (vCenter) zone
- Veeam Backup & Replication 13.1.1.18 (Windows Server), two backup servers on two sites
- Veeam Backup Enterprise Manager 13.1.1.18 on a separate Windows Server (central management node for both backup servers)
- OpenSSH Server installed on the Enterprise Manager host
- No Veeam B&R console / Veeam PowerShell module on the Enterprise Manager host
Configuration
backup.framework.enabled= truebackup.framework.provider.plugin= veeambackup.plugin.veeam.url= https://enterprise-manager-host:9398/api/backup.plugin.veeam.validate.ssl= falseintegration.veeam.control.enabled= false
Steps to reproduce
- Install Veeam Backup Enterprise Manager on a dedicated server, separate from the Veeam Backup & Replication server(s), and add the backup server(s) to it.
- Install and enable OpenSSH Server on the Enterprise Manager host and create a service account with the Portal Administrator role in Enterprise Manager.
- Configure the
backup.plugin.veeam.*settings in CloudStack with the Enterprise Manager URL and the service account. - In Veeam B&R, create a template backup job (targeting an unused vCenter tag, no schedule).
- In CloudStack, import the template job as a Backup Offering. This works and the jobs are listed.
- Assign a VMware instance to the imported Backup Offering.
Expected result
The template job is cloned, the instance is added to the cloned job, and the instance is assigned to the Backup Offering.
Actual result
Failed to add Instance to backup offering (errorcode 530)
- The REST connection to Enterprise Manager (TCP 9398) works: jobs are listed and the offering can be imported.
- The SSH session to the Enterprise Manager host is accepted (OpenSSH log:
Accepted password for <service-account>). - The PowerShell command sent over SSH fails, because the Veeam B&R PowerShell module is not present on the Enterprise Manager host.
cloneVeeamJobcannot get the repository of the template job and the assignment fails.
Relevant management server log:
ERROR [c.c.u.s.SshHelper] SSH execution of command PowerShell Import-Module Veeam.Backup.PowerShell -WarningAction SilentlyContinue;$ProgressPreference='SilentlyContinue';$Job = Get-VBRJob -name 'CS-Template-Test';$Job.GetBackupTargetRepository() ^| select Name ^| Format-List has an error status code in return. Result output: Import-Module : The specified module 'Veeam.Backup.PowerShell' was not loaded because no valid module file was found in any module directory.
Get-VBRJob : The term 'Get-VBRJob' is not recognized as the name of a cmdlet, function, script file, or operable program.
You cannot call a method on a null-valued expression.
WARN [o.a.c.b.v.VeeamClient] Exception caught while trying to clone Veeam job: com.cloud.utils.exception.CloudRuntimeException: Failed to get Repository Name from Job [name: CS-Template-Test].
at org.apache.cloudstack.backup.veeam.VeeamClient.getRepositoryNameFromJob(VeeamClient.java:434)
at org.apache.cloudstack.backup.veeam.VeeamClient.listBackupRepository(VeeamClient.java:411)
at org.apache.cloudstack.backup.veeam.VeeamClient.cloneVeeamJob(VeeamClient.java:524)
at org.apache.cloudstack.backup.VeeamBackupProvider.assignVMToBackupOffering(VeeamBackupProvider.java:171)
ERROR [o.a.c.b.VeeamBackupProvider] Failed to clone pre-defined Veeam job (backup offering) for backup offering [...] but will check the list of jobs again if it was eventually succeeded.
DEBUG [o.a.c.b.v.VeeamClient] Response received in GET request is: HTTP/1.1 200 OK ... for URL: [https://<enterprise-manager-host>:9398/api//jobs]
ERROR [o.a.c.b.BackupManagerImpl] Failed to assign Instance [...] to the Backup Offering [...] using provider [name: veeam, class: VeeamBackupProvider], due to: [Failed to assign the Instance to the Backup Offering, please try removing the assignment and try again.]
Proposed improvements
- Allow the SSH / PowerShell target to be configured separately from the Enterprise Manager REST URL (for example a new setting such as
backup.plugin.veeam.powershell.host), or use the Veeam B&R REST API for the operations that currently need PowerShell (e.g. reading the repository of a job and cloning a job). - Document clearly that the current implementation requires Enterprise Manager and Veeam B&R (with its PowerShell module) on the same host.
- Confirm support for Veeam Backup & Replication v13. The plugin documentation mentions testing with versions 11 and 12 only.
- Return a more specific error message when the PowerShell command fails (e.g. "Veeam PowerShell module not found on "), instead of the generic
Failed to add Instance to backup offering.
- Dominant language
- Java
- Stars
- 3.1k
- Forks
- 1.4k
- Avg merge
- 7d 4h
- Merged PRs (30d)
- 13
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/cloudstack
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
apache/cloudstack#14719 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
apache/cloudstack#14715 ·
Maintainers usually reply within 1 day
-
resizeVolume of a running system VM's volume is accepted but the VM never sees the new sizePossibly taken @bhouse-nexthop claimed this 7 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/cloudstack#14645 · 1 comment ·
Maintainers usually reply within 1 day
-
VR reports a load balancer change as applied when haproxy.cfg cannot be replacedPossibly taken @bhouse-nexthop claimed this 7 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/cloudstack#14633 · 1 comment ·
Maintainers usually reply within 1 day
-
restartNetwork reports a ResourceUnavailableException as an unexpected error (530), unlike restartVPC (534)Possibly taken @bhouse-nexthop claimed this 7 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
apache/cloudstack#14631 · 1 comment ·
Maintainers usually reply within 1 day
All issues in apache/cloudstack
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
SAP/ai-sdk-java#1206 ·
Maintainers usually reply within 1 day
-
enhancement good first issue insight-module
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
sdlc-pro/spring-lens#606 ·
Maintainers usually reply within 1 day
-
quality-assurance
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Paul-Austin-Oswego-CSC480-HCI521/gift-app#252 ·
Maintainers usually reply within 1 day
-
backlog kind/bug
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
TencentBlueKing/bk-job#4627 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
openrocket/openrocket#3460 ·
Maintainers usually reply within 1 day