A custom sensor for monitoring Veeam Backup & Recovery (B&R) with PRTG, created by mycloudrevolution.com. It solves integration issues between Veeam's 64-bit PowerShell Plugin and PRTG's 32-bit environment using the PSx64 tool. The sensor reports repository usage and backup statistics.
DISCLAIMER: This CUSTOM SENSOR and its underlying script was made by http://mycloudrevolution.com/. We ONLY translated the how-to into English. For any question to this approach, please get in contact with https://github.com/mycloudrevolution/Advanced-PRTG-Sensors/
| Note: There is a known issue when upgrading to Veeam v10. For more information or updates, see the GitHub page. |
Veeam PRTG sensor reloaded
Thanks for all the feedback on my PRTG – Veeam B & R Monitoring article. It’s become clear to me that Veeam Enterprise Server and its RESTful API isn’t as widespread as I thought. So, I’ve created a new version of my PRTG Veeam Advanced Sensor – the Veeam PRTG Sensor Reloaded.
Requirements for the new sensor:
- Use the Veeam Powershell Snapin
- Take the target server (Veeam B&R server) as a parameter
- Report on repository usage
- Simple to extend
I quickly ran into a fundamental problem when using the Veeam Powershell Snapin in conjunction with PRTG:
The Veeam PowerShell Plugin is 64-bit only, but PRTG runs all scripts on the probe in 32-bit only.
After some research and testing, I found the PSx64 tool from PRTG Tools Family (@prtgtoolsfamily), which has proven to be a good and robust solution.
Veeam PRTG sensor reloaded – configuration
The PSx64 tool is added to PRTG as an EXE/Script Advanced sensor
You can also include parameters, for example, the FQDN of the Veeam B&R server
Parameters for the PSx64.exe:
-f= PowerShell Script
-p= Parameter für das Script – z.B. „-BRHost veeam01.lan.local“Since the script requires powershell session credentials to set up the connection to the Veeam Backup & Recovery Server, these credentials need to be entered into PRTG, and then you need to use the option “use Windows credentials of parent device”.
The script
Note: The script below is cut-and-paste from GitHub. To get a copy of the most recent version, use this GitHub Gist
<#
.SYNOPSIS
PRTG Veeam Advanced Sensor
.DESCRIPTION
Advanced Sensor will Report Statistics about Backups during last 24 Hours and Actual Repository usage.
.EXAMPLE
PRTG-VeeamBRStats.ps1 -BRHost veeam01.lan.local
.EXAMPLE
PRTG-VeeamBRStats.ps1 -BRHost veeam01.lan.local -reportmode "Monthly" -repoCritical 80 -repoWarn 70 -Debug
.Notes
NAME: PRTG-VeeamBRStats.ps1
LASTEDIT: 08/09/2016
VERSION: 1.3
KEYWORDS: Veeam, PRTG
.Link
http://mycloudrevolution.com/
#Requires PS -Version 3.0
#Requires -Modules VeeamPSSnapIn
#>
[cmdletbinding()]
param(
[Parameter(Position=0, Mandatory=$false)]
[string] $BRHost = "veeam01.lan.local",
[Parameter(Position=1, Mandatory=$false)]
$reportMode = "24", # Weekly, Monthly as String or Hour as Integer
[Parameter(Position=2, Mandatory=$false)]
$repoCritical = 10,
[Parameter(Position=3, Mandatory=$false)]
$repoWarn = 20
)
# Big thanks to Shawn, creating a awsome Reporting Script:
# http://blog.smasterson.com/2016/02/16/veeam-v9-my-veeam-report-v9-0-1/
#region: Start Load VEEAM Snapin (if not already loaded)
if (!(Get-PSSnapin -Name VeeamPSSnapIn -ErrorAction SilentlyContinue)) {
if (!(Add-PSSnapin -PassThru VeeamPSSnapIn)) {
# Error out if loading fails
Write-Error "`nERROR: Cannot load the VEEAM Snapin."
Exit
}
}
#endregion
#region: Functions
Function Get-vPCRepoInfo {
[CmdletBinding()]
param (
[Parameter(Position=0, ValueFromPipeline=$true)]
[PSObject[]]$Repository
)
Begin {
$outputAry = @()
Function Build-Object {param($name, $repohost, $path, $free, $total)
$repoObj = New-Object -TypeName PSObject -Property @{
Target = $name
RepoHost = $repohost
Storepath = $path
StorageFree = [Math]::Round([Decimal]$free/1GB,2)
StorageTotal = [Math]::Round([Decimal]$total/1GB,2)
FreePercentage = [Math]::Round(($free/$total)*100)
}
Return $repoObj | Select Target, RepoHost, Storepath, StorageFree, StorageTotal, FreePercentage
}
}
Process {
Foreach ($r in $Repository) {
# Refresh Repository Size Info
[Veeam.Backup.Core.CBackupRepositoryEx]::SyncSpaceInfoToDb($r, $true)
If ($r.HostId -eq "00000000-0000-0000-0000-000000000000") {
$HostName = ""
}
Else {
$HostName = $($r.GetHost()).Name.ToLower()
}
$outputObj = Build-Object $r.Name $Hostname $r.Path $r.info.CachedFreeSpace $r.Info.CachedTotalSpace
}
$outputAry += $outputObj
}
End {
$outputAry
}
}
#endregion
#region: Start BRHost Connection
Write-Output "Starting to Process Connection to $BRHost ..."
$OpenConnection = (Get-VBRServerSession).Server
if($OpenConnection -eq $BRHost) {
Write-Output "BRHost is Already Connected..."
} elseif ($OpenConnection -eq $null ) {
Write-Output "Connecting BRHost..."
Connect-VBRServer -Server $BRHost
} else {
Write-Output "Disconnection actual BRHost..."
Disconnect-VBRServer
Write-Output "Connecting new BRHost..."
Connect-VBRServer -Server $BRHost
}
$NewConnection = (Get-VBRServerSession).Server
if ($NewConnection -eq $null ) {
Write-Error "`nError: BRHost Connection Failed"
Exit
}
#endregion
#region: Convert mode (timeframe) to hours
If ($reportMode -eq "Monthly") {
$HourstoCheck = 720
} Elseif ($reportMode -eq "Weekly") {
$HourstoCheck = 168
} Else {
$HourstoCheck = $reportMode
}
#endregion
#region: Collect and filter Sessions
# $vbrserverobj = Get-VBRLocalhost # Get VBR Server object
# $viProxyList = Get-VBRViProxy # Get all Proxies
$repoList = Get-VBRBackupRepository # Get all Repositories
$allSesh = Get-VBRBackupSession # Get all Sessions (Backup/BackupCopy/Replica)
# $allResto = Get-VBRRestoreSession # Get all Restore Sessions
$seshListBk = @($allSesh | ?{($_.CreationTime -ge (Get-Date).AddHours(-$HourstoCheck)) -and $_.JobType -eq "Backup"}) # Gather all Backup sessions within timeframe
$seshListBkc = @($allSesh | ?{($_.CreationTime -ge (Get-Date).AddHours(-$HourstoCheck)) -and $_.JobType -eq "BackupSync"}) # Gather all BackupCopy sessions within timeframe
$seshListRepl = @($allSesh | ?{($_.CreationTime -ge (Get-Date).AddHours(-$HourstoCheck)) -and $_.JobType -eq "Replica"}) # Gather all Replication sessions within timeframe
#endregion
#region: Collect Jobs
# $allJobsBk = @(Get-VBRJob | ? {$_.JobType -eq "Backup"}) # Gather Backup jobs
# $allJobsBkC = @(Get-VBRJob | ? {$_.JobType -eq "BackupSync"}) # Gather BackupCopy jobs
# $repList = @(Get-VBRJob | ?{$_.IsReplica}) # Get Replica jobs
#endregion
#region: Get Backup session informations
$totalxferBk = 0
$totalReadBk = 0
$seshListBk | %{$totalxferBk += $([Math]::Round([Decimal]$_.Progress.TransferedSize/1GB, 0))}
$seshListBk | %{$totalReadBk += $([Math]::Round([Decimal]$_.Progress.ReadSize/1GB, 0))}
#endregion
#region: Preparing Backup Session Reports
$successSessionsBk = @($seshListBk | ?{$_.Result -eq "Success"})
$warningSessionsBk = @($seshListBk | ?{$_.Result -eq "Warning"})
$failsSessionsBk = @($seshListBk | ?{$_.Result -eq "Failed"})
$runningSessionsBk = @($allSesh | ?{$_.State -eq "Working" -and $_.JobType -eq "Backup"})
$failedSessionsBk = @($seshListBk | ?{($_.Result -eq "Failed") -and ($_.WillBeRetried -ne "True")})
#endregion
#region: Preparing Backup Copy Session Reports
$successSessionsBkC = @($seshListBkC | ?{$_.Result -eq "Success"})
$warningSessionsBkC = @($seshListBkC | ?{$_.Result -eq "Warning"})
$failsSessionsBkC = @($seshListBkC | ?{$_.Result -eq "Failed"})
$runningSessionsBkC = @($allSesh | ?{$_.State -eq "Working" -and $_.JobType -eq "BackupSync"})
$IdleSessionsBkC = @($allSesh | ?{$_.State -eq "Idle" -and $_.JobType -eq "BackupSync"})
$failedSessionsBkC = @($seshListBkC | ?{($_.Result -eq "Failed") -and ($_.WillBeRetried -ne "True")})
#endregion
#region: Preparing Replicatiom Session Reports
$successSessionsRepl = @($seshListRepl | ?{$_.Result -eq "Success"})
$warningSessionsRepl = @($seshListRepl | ?{$_.Result -eq "Warning"})
$failsSessionsRepl = @($seshListRepl | ?{$_.Result -eq "Failed"})
$runningSessionsRepl = @($allSesh | ?{$_.State -eq "Working" -and $_.JobType -eq "Replica"})
$failedSessionsRepl = @($seshListRepl | ?{($_.Result -eq "Failed") -and ($_.WillBeRetried -ne "True")})
$RepoReport = $repoList | Get-vPCRepoInfo | Select @{Name="Repository Name"; Expression = {$_.Target}},
@{Name="Host"; Expression = {$_.RepoHost}},
@{Name="Path"; Expression = {$_.Storepath}},
@{Name="Free (GB)"; Expression = {$_.StorageFree}},
@{Name="Total (GB)"; Expression = {$_.StorageTotal}},
@{Name="Free (%)"; Expression = {$_.FreePercentage}},
@{Name="Status"; Expression = {
If ($_.FreePercentage -lt $repoCritical) {"Critical"}
ElseIf ($_.FreePercentage -lt $repoWarn) {"Warning"}
ElseIf ($_.FreePercentage -eq "Unknown") {"Unknown"}
Else {"OK"}}} | `
Sort "Repository Name"
#endregion
#region: XML Output for PRTG
Write-Host "<prtg>"
$Count = $successSessionsBk.Count
Write-Host "<result>"
"<channel>Successful-Backups</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
$Count = $warningSessionsBk.Count
Write-Host "<result>"
"<channel>Warning-Backups</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxWarning>0</LimitMaxWarning>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $failsSessionsBk.Count
Write-Host "<result>"
"<channel>Failes-Backups</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxError>0</LimitMaxError>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $failedSessionsBk.Count
Write-Host "<result>"
"<channel>Failed-Backups</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxError>0</LimitMaxError>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $runningSessionsBk.Count
Write-Host "<result>"
"<channel>Running-Backups</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
$Count = $successSessionsBkC.Count
Write-Host "<result>"
"<channel>Successful-BackupCopys</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
$Count = $warningSessionsBkC.Count
Write-Host "<result>"
"<channel>Warning-BackupCopys</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxWarning>0</LimitMaxWarning>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $failsSessionsBkC.Count
Write-Host "<result>"
"<channel>Failes-BackupCopys</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxError>0</LimitMaxError>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $failedSessionsBkC.Count
Write-Host "<result>"
"<channel>Failed-BackupCopys</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxError>0</LimitMaxError>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $runningSessionsBkC.Count
Write-Host "<result>"
"<channel>Running-BackupCopys</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
$Count = $IdleSessionsBkC.Count
Write-Host "<result>"
"<channel>Idle-BackupCopys</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
$Count = $successSessionsRepl.Count
Write-Host "<result>"
"<channel>Successful-Replications</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
$Count = $warningSessionsRepl.Count
Write-Host "<result>"
"<channel>Warning-Replications</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxWarning>0</LimitMaxWarning>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $failsSessionsRepl.Count
Write-Host "<result>"
"<channel>Failes-Replications</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxError>0</LimitMaxError>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $failedSessionsRepl.Count
Write-Host "<result>"
"<channel>Failed-Replications</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMaxError>0</LimitMaxError>"
"<LimitMode>1</LimitMode>"
"</result>"
$Count = $runningSessionsRepl.Count
Write-Host "<result>"
"<channel>Running-Replications</channel>"
"<value>$Count</value>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
Write-Host "<result>"
"<channel>TotalBackupRead</channel>"
"<value>$totalReadBk</value>"
"<unit>Custom</unit>"
"<customUnit>GB</customUnit>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
Write-Host "<result>"
"<channel>TotalBackupTransfer</channel>"
"<value>$totalxferBk</value>"
"<unit>Custom</unit>"
"<customUnit>GB</customUnit>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"</result>"
foreach ($Repo in $RepoReport){
$Name = "REPO - " + $Repo."Repository Name"
$Free = $Repo."Free (%)"
Write-Host "<result>"
"<channel>$Name</channel>"
"<value>$Free</value>"
"<unit>Percent</unit>"
"<showChart>1</showChart>"
"<showTable>1</showTable>"
"<LimitMinWarning>20</LimitMinWarning>"
"<LimitMinError>10</LimitMinError>"
"<LimitMode>1</LimitMode>"
"</result>"
}
Write-Host "</prtg>"
#endregion
#region: Debug
if ($DebugPreference -eq "Inquire") {
$RepoReport | ft * -Autosize
$SessionObject = [PSCustomObject] @{
"Successful Backups" = $successSessionsBk.Count
"Warning Backups" = $warningSessionsBk.Count
"Failes Backups" = $failsSessionsBk.Count
"Failed Backups" = $failedSessionsBk.Count
"Running Backups" = $runningSessionsBk.Count
"Warning BackupCopys" = $warningSessionsBkC.Count
"Failes BackupCopys" = $failsSessionsBkC.Count
"Failed BackupCopys" = $failedSessionsBkC.Count
"Running BackupCopys" = $runningSessionsBkC.Count
"Idle BackupCopys" = $IdleSessionsBkC.Count
"Successful Replications" = $successSessionsRepl.Count
"Warning Replications" = $warningSessionsRepl.Count
"Failes Replications" = $failsSessionsRepl.Count
"Failed Replications" = $failedSessionsRepl.Count
"Running Replications" = $RunningSessionsRepl.Count
}
$SessionResport += $SessionObject
$SessionResport
}
#endregionSpecial thanks
Many thanks to Shawn Masterson (@smasterson24) for creating this fantastic Veeam Report, which I used as the basis for this sensor.
New versions
Version 1.2 – 09.08.2016
- New: BackupCopy Sessions
- Improvement: Exclude unused data
- Improvement: PS Region definitions
- Improvement: PS Required definitions
- Tested with Veeam B&R Version 9 Update 1 und Update 2
Version 1.3 – 03.11.2016
- New: Debug
- New: additional parameters “-reportmode -repoCritical -repoWarn”
- Improvement: reorganize the regions
Here is also a retrospective about the Veeam Sensors: https://mycloudrevolution.com/2020/01/27/prtg-veeam-sensor-retrospective/
GitHub repository
I’ve created a GitHub Repository with the most current scripts. I invite you to take part in this project. Whether it’s a pull request, bug report or feature request – all input and participation is welcome.
DISCLAIMER: This CUSTOM SENSOR and its underlying script was made by http://mycloudrevolution.com/. We ONLY translated the how-to into English. For any question to this approach, please get in contact with https://github.com/mycloudrevolution/Advanced-PRTG-Sensors/
Disclaimer:
The information in the Paessler Knowledge Base comes without warranty of any kind. Use at your own risk. Before applying any instructions please exercise proper system administrator housekeeping. You must make sure that a proper backup of all your data is available.
