↓Skip to main content

VeeamNotify - Veeam B&R session notifications

·818 words·4 mins
Table of Contents

VeeamNotify sends Veeam Backup & Replication session summary notifications to Discord, Microsoft Teams, and Slack, detailing the session result, various statistics, and optionally alerting you via @mention when a job finishes in a warning or failed state.

VeeamNotify is a replacement for my previous VeeamDiscordNotifications project, and the respective Teams and Slack projects. You may have seen my previous blog post about VeeamDiscordNotifications.

VeeamNotify features improvements across the board and support for all the aforementioned messaging services in one place.

VeeamNotify Compatibility
#

Supported Notification Services:

  • Discord
  • Slack
  • Microsoft Teams

Please create a feature request if your preferred service isn’t listed here.

Supported Veeam Job Types:

  • VM Backup
  • VM Replication
  • Windows & Linux Agent Backup jobs*

Due to limitations in Veeam, only some types of Agent jobs are supported:

  • Supported jobs are referred to as “Agent Backup” or “Managed by backup server”.
  • Unsupported jobs are referred to as “Agent policy” or “Managed by agent”.
See the spoilered illustration below if this isn’t clear to you.
Agent job types
Note: Linux Agent Backup jobs are also supported, this image is only an example.

You can read about the difference between these two Agent job types here.

Unfortunately, even supported Agent jobs return a reduced amount of session information, so you won’t see as much detail in the notification (see the example screenshots at the top).

I’ve included as much relevant information as I’ve been able to discover in the notifications, but I welcome any suggestions for improvement in this area.

Manual Install Instructions
#

If you’re not here for manual installation instructions, I suggest you have a look at some simpler installation methods in the VeeamNotify wiki.

I will keep these instructions updated and in-line with current release as much as possible, but if something is out of date then please submit an issue in the GitHub repository.

Requirements
#

  • Veeam Backup & Replication 11 or higher.
  • PowerShell 5.1 or higher.

Preparation
#

Before you do anything else, I suggest you prepare the notification service(s) you wish to use. The process is different for all of them, so I’ve provided some basic steps in the VeeamNotify wiki.

At the time of writing, v1.0 is the latest version, so that’s what we’ll install. There may be more recent releases by the time you’re reading this, so take a look and replace the version number in the following commands if necessary.

The install directory is C:\VeeamScripts by default. You can use any directory you wish, but the user under which Veeam runs must have read/write access to it.

Firstly, open PowerShell as administrator and leave it open. We’ll be using it through the process.

Now we need to create the install directory. Run the following command to do this:

New-Item 'C:\VeeamScripts' -Type Directory

Download VeeamNotify
#

The first command, in simple terms, instructs PowerShell to use TLS 1.2 for web requests. It uses TLS 1.0 by default, which GitHub no longer accepts.

The second command downloads the VeeamNotify v1.0 release ZIP.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Invoke-WebRequest -Uri https://github.com/tigattack/VeeamNotify/releases/download/v1.0/VeeamNotify-v1.0.zip -OutFile C:\VeeamScripts\VeeamNotify-v1.0.zip

Extract and Clean Up
#

You can now extract the release and remove the downloaded ZIP:

Expand-Archive 'C:\VeeamScripts\VeeamNotify-v1.0.zip' -DestinationPath 'C:\VeeamScripts'
Rename-Item 'C:\VeeamScripts\VeeamNotify-v1.0' 'C:\VeeamScripts\VeeamNotify'
Remove-Item 'C:\VeeamScripts\VeeamNotify-v1.0.zip'

Windows typically blocks execution of downloaded scripts, so we need to unblock all the script files for this project:

Get-ChildItem -Path 'C:\VeeamScripts\VeeamNotify' -Filter '*.ps*' -Recurse | Unblock-File

Configure VeeamNotify
#

Open the configuration file:

notepad.exe C:\VeeamScripts\VeeamNotify\config\conf.json
Old versions of Notepad don’t support Unix-style line endings, so this file may look pretty fucked up. Try using another editor if Notepad is proving too difficult.

The primary points of configuration here are webhooks, so make sure you add the webhook(s) of the service(s) you wish to notify.
I’ll provide no specific instructions beyond that; how you configure VeeamNotify is entirely your choice.

If you need some help, check out the configuration reference.

Configure Veeam
#

Firstly, we must generate the launch command to ensure you provide Veeam with the correct path to the PowerShell executable.

Run the following command:

"$((Get-Command -Name 'powershell.exe' -ErrorAction Stop).Path) -NoProfile -ExecutionPolicy Bypass -File 'C:\VeeamScripts\VeeamNotify\Bootstrap.ps1'"

This should return something like this:

C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe -NoProfile -ExecutionPolicy Bypass -File 'C:\VeeamScripts\VeeamNotify\Bootstrap.ps1'

Copy that output, then repeat the following steps for each job that you want to be notified about:

  1. Right-click the job, then select “Edit”

  2. Go to the “Storage” tab

  3. Select “⚙️ Advanced”

  4. Go to the “Scripts” tab and configure like this:

    • Check “Run the following script after the job”.
    • Paste the launch command we generated above.
    • Ensure “Run scripts every X backup session” is set to 1.
      Veeam-config

  5. Click “OK”, then click “Finish”.

Fin.
#

All done! Start a job to test your installation.

Here are some example notifications:

If you have any problems with the script, please open an issue on the GitHub project.

I always welcome feedback on my posts; please contact me if you have any.
I’m also happy to answer any related questions if I know the answer.

tigattack
Author
tigattack