Files

T

kyleandClaude Opus 5.5 9ae93cfbc2 Report Veeam backup copy job sessions

VBR 12+ backup copy jobs showed as Unknown. Get-VBRJob returns the copy
(policy) job, but Get-VBRBackupSession only returns sessions of its
hidden worker jobs, whose JobId matches no listed job, so they were
dropped. Confirmed on a VBR 13.0.2 server with the new diagnostics
script.

- File worker sessions under their policy job via
  Session.GetJob().PolicyJobId (looked up once per worker job), and
  record the source job in details.copied_from
- Add Get-VeeamCollectorDiagnostics.ps1, a read-only report of jobs,
  unmatched sessions and their link properties
- Mock: backup copy policy/worker case and a session from a deleted job

Co-Authored-By: Claude Opus 5.5 <[email protected]>

2026-10-07 14:01:56 -06:00

3.8 KiB

Raw Blame History

Veeam Backup & Replication collector

A PowerShell script that runs on each client's VBR server and reports job results to the dashboard. It covers jobs returned by Get-VBRJob: VM backup, replication and backup copy jobs.

Install (on the VBR server, as an administrator)

On the dashboard host, create a key for this server:
```
python manage.py create-key veeam-acme
```
Copy this folder to the VBR server and run:
```
.\Install-VeeamCollector.ps1 -ApiUrl https://backups.example.com -Tenant "Acme Corp"
```
It prompts for the key, then:
- writes C:\ProgramData\BackupDashboard\veeam-collector.json (readable only by SYSTEM and Administrators)
- copies the script to C:\Program Files\BackupDashboard\
- registers the scheduled task Backup Dashboard - Veeam collector (SYSTEM, every 15 minutes)

Preview the payloads, then backfill 30 days so the history view is populated straight away:

& 'C:\Program Files\BackupDashboard\Send-VeeamBackupStatus.ps1' -DryRun
& 'C:\Program Files\BackupDashboard\Send-VeeamBackupStatus.ps1' -LookbackHours 720

Re-run the installer to change settings or update the script. To remove the collector, delete the scheduled task and both BackupDashboard folders.

What it sends

Dashboard	Veeam
Company	`Tenant` from the config
Job	Job name. The job's GUID is the ID, so renaming a job in Veeam doesn't duplicate it
Status	Session result (Success / Warning / Failed). Any state other than Stopped is Running. A session that stopped with no result (e.g. cancelled) is reported as Warning
Started / finished	Session `CreationTime` / `EndTime`
Next scheduled	Job's next run. Sent as empty for disabled jobs and chained ("run after") jobs, so those are never flagged Overdue
Message	Session reason, each VM or object that didn't succeed, and warning/error lines from the session log
Size	`BackupStats.BackupSize`

Backup copy jobs (VBR 12+): Veeam records their sessions under hidden per-source "worker" jobs. The collector files each worker session under its copy job (via the worker's PolicyJobId), so a copy job gets one run per source job it copies, with the source in copied_from.

Each run covers the last 48 hours (LookbackHours), so a few missed runs (server rebooting, API down) fill in automatically. Sessions already delivered are recorded in veeam-collector.state.json. Running sessions are re-sent until they finish.

Troubleshooting

Log: C:\ProgramData\BackupDashboard\veeam-collector.log (rotates at 5 MB).
Exit codes: 0 OK, 1 some jobs failed to send (they're retried next run), 2 setup failed (config, Veeam module, or Veeam connection).
API key rejected: the key was revoked or mistyped. Re-run the installer with a new key.
A job shows Unknown on the dashboard: the collector sent the job but matched no sessions to it. Run .\Get-VeeamCollectorDiagnostics.ps1 (read-only). It lists sessions whose job ID matches no job, plus the type and link properties of the jobs left without sessions.
Get-VBRBackupSession loads every session in the VBR database. On a server with years of history, this can make each run take a minute or more. The task's 30-minute limit and "don't start if already running" setting keep that safe.

Testing without Veeam

tests/MockVeeam.ps1 defines stand-in Get-VBRJob / Get-VBRBackupSession cmdlets with a mix of success, warning, failed, running and disabled jobs:

. ./tests/MockVeeam.ps1
./Send-VeeamBackupStatus.ps1 -ConfigPath ./my-test-config.json -DryRun

Not covered yet

Veeam Agent jobs managed by VBR (Get-VBRComputerBackupJob), tape jobs, and SureBackup.
Veeam Backup for Microsoft 365, which has its own PowerShell module.

3.8 KiB Raw Blame History