Capabilities

Set up backup monitoring.

Backup monitoring is one scheduled task that reads your Veeam Backup & Replication server and records what it finds on the computers that server protects. This page walks through the setup using the labels you see on screen. What it looks like afterwards is on Backup monitoring.

Before you start

VeeamVeeam Backup & Replication on a Windows server. Version 12 and version 13 are both supported. On version 13 the server also needs PowerShell 7 installed, because that is the only place Veeam’s version 13 module will load; the installer for it is a free download from Microsoft. A way inOctotor reaches the Veeam server over WinRM or SSH, the same two ways it reaches any Windows machine. If the server is only reachable through a bastion, attach a Jump Host to the asset and the connection goes through it. A credentialA Windows account on the Veeam server that may load the Veeam PowerShell module. The Veeam role Backup Viewer is enough, because the collector only ever reads. It never starts, stops, edits or deletes a backup job. The server as an assetThe Veeam server has to exist in Octotor as a computer asset. If it is not there yet, add it before step 1. LicenceBackup monitoring is part of the Pro and Enterprise plans. Existing Pro and Enterprise licence files keep working; nothing has to be reissued. VersionOctotor v3.3.7 or later. Veeam 13 support arrived in v3.3.9.

Step by step

1Tell Octotor which machine is the backup server

Open Assets, open the Veeam server, and go to its Attributes tab. In the BACKUP group, set Veeam Backup Server to Yes using the edit pencil on that attribute card.

Everything else depends on this one setting. The task you build in step 2 finds your server by it, so you never have to type a server name into a task. If you add a second backup server later, set the same attribute on it and the task picks it up on its next run, with no further changes. If the machine runs Veeam Backup for Microsoft 365 instead, set Veeam M365 Backup Server to Yes in the same group; that is a separate feature and is not covered on this page.

2Schedule the collector

Open Scheduler and click + New task. Fill it in like this:

FieldWhat to putWhy
NameSomething you will recognise, for example BACKUP-VEEAM-COLLECTIt is how you find the task and its run history later.
Task typeScriptThe default.
Scriptwindows/veeam-vbr-collect.ps1 The Veeam collector that comes with Octotor. You do not need to copy it to the server or change it.
ScheduleA time after your backup window closes, for example 30 6 * * * (06:30 daily)So the task reads completed backup runs rather than running ones. Many sites add a second run in the afternoon.
Target ▸ Asset typecomputer, with no specific assetThe target is the backup server, not the machines being backed up.
Attribute filtersVeeam Backup Server | Include | equals | true This is what narrows the task down to the server you set in step 1, and to nothing else.
Execution ▸ ProtocolAuto Each server is then reached the way its own record says, so one task can cover a WinRM server and an SSH server together.
Execution ▸ Timeout (sec)240 for an ordinary server, 900 for one holding years of history The script reads the whole job history. If the time limit stops a run before it finishes, no results are recorded at all, so set this one with care.
Run options ▸ EnabledtickedThe task starts running on its schedule as soon as you save. Leave Run once off, because this task is meant to repeat.

Click Save. The task runs next at the scheduled time. You can also run it once by hand from the task list if you want results straight away.

3Check that the first run worked

Wait for the task to run once, or run it by hand from the task list. Then check two places.

On the backup server itself. Open it in Assets. Its Backup jobs tab should now list your Veeam jobs, when each one last ran and how it ended. Its Attributes tab should show a BACKUP group holding the totals: how many jobs there are, how many failed, and how many machines are protected.

On one of the protected computers. Open any machine that the server backs up. It should now have a Backup jobs tab of its own, and its BACKUP attribute group should show when its last successful backup finished, how its most recent run ended, and which job protects it.

If either place is still empty, open the task in Scheduler, open its run history, and read the output of the run. It says what the script could not do.

4Decide who gets told

Six backup alert rules come with Octotor, and they are switched on already. Three of them watch the backup server as a whole, and three watch each protected computer on its own.

RuleSeverityIt is raised when
Backup job failed recently on serverCritical A job on the backup server failed at some point in the last day, even if a later run succeeded. This is the rule that catches a failure you would otherwise miss, because the job went green again.
Backup job failed on serverCritical A job on the backup server is in a failed state now.
Backup job warning on serverWarning A job finished, but Veeam reported a warning about it.
Last backup of this computer failedCritical The most recent backup of one machine failed.
Last backup of this computer ended with a warningWarning One machine was backed up, but Veeam reported a warning for that run.
Backup overdue for this computerWarning A machine has gone longer without a successful backup than its own job schedule allows. This is how you find out that a backup stopped happening at all, rather than failing loudly.

To be told about them, add a notification channel to each rule. Out of the box these rules raise the alert inside Octotor, on the Alert Center page, but they send nothing out. Open Alerts Admin ▸ Rules, click Edit on a rule, and type the name of a channel into its Notify channels box. Channels are email destinations, Telegram or webhooks, and you create them on the Channels tab of the same page. Do this on each rule you want to hear about: setting a channel on one rule does not change the others.

Rules only apply to machines whose Threshold alert switch is on. Octotor switches it on for every computer the task finds and for the backup server itself, so you do not have to visit each machine. If you would rather decide per computer, set Settings ▸ Backup Collector ▸ Switch on threshold alerts for the computers the collector finds to No before the first run.