Script library

Browse and download code samples or contribute your own scripts

  • 84 Topics
  • 426 Comments

84 Topics

Kseniya
Kseniya✨
posted in Script library

Script Library disclaimer

Veeam is not responsible nor can be held accountable for the accuracy and usability for code samples published in the Script Library.Scripts are licensed to you by the sample's author and fall under your responsibility.

1
haslund
2 years ago
Martin Weber
Martin WeberComes here often
posted in Script library

Pre-Check for update VEEAM to Version 12 using VMware

Hello together,before you update VEEAM to Version 12 using VMware vCenter/ESXi please check VMs HardDisks for duplicate UUID. In Version 11 this was never a problem. In the new Version VEEAM checks the UUID and backup will fail.VMware has no problem with that most time. But they know the Problem - https://kb.vmware.com/s/article/2006865This command will find any HardDisk with duplicate UUID - please note that this is VMware PowerCLI commandGet-VM | Get-HardDisk | Select @{N='VM';E={$_.Parent.Name}}, @{N='Uuid';E={$_.ExtensionData.Backing.Uuid}} | Group-Object -Property Uuid | ?{ $_.Count -gt 1 }As Service Provider such changes in VEEAM are a total disaster!!

33
BertrandFR
8 days ago
SteveHeart
SteveHeartVeeam MVP
posted in Script library

vbr-get-jobcfg.ps1 - Quickly show Veeam Backup Job Configuration Settings

Spring is here 💐 and with it comes another script. This time for Veeam Backup & Replication.The script shows different job configuration settings and can be used to quickly identify differences in job settings.The Readme and code lines can be found in GitHub:Bits & BytesMore to come depending on your feedback (I already got one related to NAS backup)

1
Chris.Childerhose
10 days ago
Martin Weber
Martin WeberComes here often
posted in Script library

VEEAM Maintenance Mode PowerShell Scripts

Yesterday, during the VEEAM User Group Germany someone was missing a Maintenance Mode for VEEAM. The main problem was to keep which job was enabled and which was disabled. I wrote a script some times ago which stopped all jobs and disable them but before the state is dumped into a JSON File. On leaving maintenence the JSON-File will be read and required jobs are set to enabled again and failed jobs are triggered to restart. The scripts (and more) can be found on our github repository: https://github.com/claranet/VeeamHub/ Here are these scripts:Enter-Maintenance.ps1param( [switch]$DryRun=$False)Import-Module Veeam.Backup.PowerShellFunction log($message) { $timestamp = Get-Date -Format "yyyy-MM-ss hh:mm:ss" Write-Host "$($timestamp) - $($message)"}if($DryRun) { log "DRY RUN - NOTHING WILL CHANGE" }$_FILE = "$PSScriptRoot/job_states.json"if( [System.IO.File]::Exists($_FILE) ) { log "State File already exists - remove it first!!" pause Exit 1}# Create new, empty state fileNew-Item -

15
Scott
10 days ago
L
louis_bab99New Here
asked in Script library

Veeam V12 PostgreSQL Config DB SQL Queries fail

Hello, we are monitoring the customer backups via PRTG.Till now, we had a SQL Skript, wich got the latest result and reported it to PRTG:SELECT latest_result FROM bjobs WHERE name = @prtg;That worked fine with MSSQL Express, but now with PostgreSQL we have to use a PostgreSQL Sensor in PRTG. Thats no problem, but it always failes with: “GSS/SSPI authentication but IntegratedSecurity not enabled” when I try to use the postgres user, or with: 28000: SSPI-Authentication for user Administrator failed”. For debugging I tried to change the access settings in the pg_hba.conf file but nothing seems to work.Is there a way I can still run queries to the config database? Or do I have to go via the PowerShell Snappin from Veeam?PS: We don’t use the Enterprise Manager, because you need the Enterprise Plus license for that and our customers don’t have that license. Thanks alot.

3
Chris.Childerhose
10 days ago
I
InfowhizNew Here
asked in Script library

Backup Eamil Notifications

Is that any way to trigger notification when backup job start?

6
D
11 days ago
B
BystanderNew Here
asked in Script library

Set a file list for backup in before job script

Hi,I need to write to the tape files created during previous day. I have a script which generates that list. How can I tell Veeam, which files to write?Do I need to write script creating a new job each day or it is possible to use “before job script” for that?Thanks in advance 

10
Rick Vanover
17 days ago
E
EdxHComes here often
posted in Script library

vCLI updates

Hi all, I just wanted to give you some updates on vCLI’s updates (up to 0.7.0-beta1):PUT and POST operations Default API updated to v12 VBR and v7 VB365 Enterprise Manager support Utility functions: VBR Job GET to POST converter Check for version updates  Job template featureVBR Job GET to POST converterThe VBR API Job object is slightly different to the POST object; the converter can take a GET object json file and convert it to a POST object json file. Job Template featureThe job template feature was put together to help with having to manage large VBR job objects. A job template can be created, forming the basis for any new jobs you want to create. For example, if you only need to modify the VMs, you only need to pass a relatively small object:type: Backupname: my jobdescription: Created by VCLI.isDisabled: falsevirtualMachines: includes: - type: VirtualMachine hostName: your-vmware-host name: your-vm-name objectId: vm-0001The command being:vcli job create abc-j

2
Chris.Childerhose
21 days ago
E
EdxHComes here often
posted in Script library

vcli - a universal Veeam CLI tool

Hi all, I’ve been toying around with the idea of a cli tool that works with everything and is related to the other post I put up today on the Go-Veeam-Auth that does authentication for all Veeam APIs. Anyway, I’ve come up with vcli a simple terminal app written in Go, allowing you to switch between APIs with minimal effort quickly. All the authentication is set up, so all you need to do is set some environmental variables, and off you go (no pun intended).The main output is JSON, but you can switch it over to YAML via a --yaml switch.The tool only does GET requests at the moment, as I wanted to gauge the interest before committing any more time to the project. Where the power really comes in when it is coupled with “nushell” which is a data-centric approach to shells. It makes manipulating json response objects a breeze and also allows conversion to other data formats. It also has a whole module system which I go into a bit on my GitHub. GitHub page: https://github.com/shapedthought/vc

9
vergoted
23 days ago
kristofpoppe
kristofpoppeVeeam Vanguard
asked in Script library

Remove-VBOEntityData via API

Hi all, most of us know the powerfull Remove-VBOEntityData cmdlet to remove objects from Veeam Backup for Microsoft 365 repo’s. I’ve been checking documentation and the swagger, but didn’t find any API alternative. Anybody already succeeded in calling this function via API ?

0
kristofpoppe
25 days ago
P
Praveen SharmaNew Here
asked in Script library

Stop VM Backup if any alert is received from Veeam One

Hi Team, The customer wants to setup ransomware alerts on Veeam One. And also wants that if any alert comes then backup should be stopped.I have checked the documentation and found that action option is available in alert setting where we have option to run script. can you please help me with the script.Thanks!!    

1
Cragdoo
25 days ago
Martin Weber
Martin WeberComes here often
posted in Script library

Veeam AHV Metrics Exporter for Prometheus

Hello together, I wrote a exporter to Collect VEEAM AHV Metrics for Prometheus: https://github.com/claranet/veeam-ahvproxy-exporter/ It now also Support API v4 for Veeam v12. Best regards,Martin

1
Chris.Childerhose
25 days ago
Chris.Arceneaux
Chris.ArceneauxVeeam MVP
posted in Script library

Veeam Collection for Ansible: v12 support

Support for the newly released v12 (VBR/EM/ONE) is now available in the Veeam Collection for Ansible!What enhancements can you expect?Support for Windows Server 2022 Full support for PostgreSQL when performing VBR/EM installs Including local & remote DBs A new module to apply PostgreSQL performance tuning Leverages the Set-VBRPSQLDatabaseServerLimits PowerShell cmdlet Automatic enabling of the PostgreSQL pg_stat_statements extension during PostgreSQL installation This assists in performance troubleshooting Additional sample v12-specific playbooks Upgraded dependencies leveraging the latest ansible collections for Windows: ansible.windows: 1.13.0 community.windows: 1.12.0  For those not familiar with this Ansible collection, please see this blog post for an introduction.

1
Chris.Childerhose
1 month ago
T
ThePlaneskeeperNot a newbie anymore
posted in Script library

Immutable Storage actual disk used per folder

Inherency:Since we bill by actual disk usage for our client utilizing CloudConnect, the existing reports are non-functional for reporting and billing (They report pre-deduplication/reflink data).  It took a while to figure out, but there is a way to calculate actual disk space used on a per directory on an immutable repository.Solution:Using: https://community.veeam.com/blogs-and-podcasts-57/check-reflink-and-spared-space-on-xfs-repositories-244 I have extrapolated a script that will give the disk usage of each folder (IE: client) on an immutable repo.  This isn't "Data used"; that is what Veeam reports.  This is "Disk Used".  The actual size on disk after reflinks (duplicated data is only counted once). A note about this script; it appears that the original blog entry is wrong on the size of a block.  They attribute it to 4096... which is true... on disk... but the utility used explicitly gives the information in block sizes of 512:https://linux.die.net/man/8/xfs_bmap"units of 512-byt

11
J
1 month ago
E
EdxHComes here often
posted in Script library

Go-Veeam-Auth - API authentication package for Go

Hi all, To all the API gurus out there that like Go I’ve put together a package that takes care of all the authentication for you.https://github.com/shapedthought/go-veeam-authReally easy to add to your project. Just put this into the terminal in your project directory:go get github.com/shapedthought/go-veeam-authMost of the APIs are covered:VBR VB AWS VB AZURE VB GCP VONE VB365Instructions are on the GitHub. Video:Note that this isn’t a full SDK like the one on VeeamHub, it just does the authentication, but there are some convenience functions to make calls a bit easier.If you have any recommendations or would like to contribute, feel free to raise an issue or send a pull request.All the best,Edx

2
JMeixner
1 month ago
SteveHeart
SteveHeartVeeam MVP
posted in Script library

vb365-exo-recovery.ps1 - A delicious recipe for many occasions

Hello Community,imagine you no longer have access to your most important Exchange Online mailboxes? Or you want to perform some checks, but you don't want to touch the productive mailboxes and your production Microsoft 365 tenant? What if a script and Veeam Backup for Microsoft 365 could help you?Down below is a simple recipe.IngredientsVeeam Backup for Microsoft 365 An Exchange Online backup job protecting the mailboxes A second Microsoft 365 tenant with already configured (target) mailboxes A configured Azure AD application in the second Microsoft 365 tenant A CSV file with the mailboxes to be copiedThe script with all information can be downloaded here: ScriptIf the destination mailbox is empty, all objects are restored. If the objects already exist, only missing objects will be restored.Please share what else could be achieved using this script. 

1
Chris.Childerhose
1 month ago
Chris.Arceneaux
Chris.ArceneauxVeeam MVP
posted in Script library

Exporting M365 Mailbox to PST

This script showcases just how easy it is to use Veeam PowerShell cmdlets to export an M365 mailbox. This script is designed to be executed on a Veeam Backup for Microsoft 365 (VB365) v6 server and it's interactive so no parameters are required. Upon execution, the script polls for information which culminates in the specified user mailbox being exported to a PST file.The code in this script could also be referenced to create a script to fully automate the mailbox export process.For more detailed information, please follow the VeeamHub link:https://github.com/VeeamHub/powershell/tree/master/VB365-ExportMailboxToPSTHere’s a screenshot of what it looks like in action: 

7
E
2 months ago
A
AlexeyGoncharovComes here often
asked in Script library

Allow unlicensed agents to consume instances - Powershell

Colleagues, Anyone knows how to enable that checkbox by Powershell? Trying to build 100% powershell deployment and can’t find how to enable that settings.Cheers,Alexey

2
A
2 months ago
skitch210
skitch210New Here
posted in Script library

Tape Media Move Script

A few times I have had partners/customers confused as to why their jobs failed when needing media and they have put media in the library. Well, the new media is in the Unrecognized Pool and needs to be moved. I created a Powershell script that can be used to automate this process to hopefully help this situation. https://github.com/VeeamHub/powershell/tree/master/BR-TapeMedia-FreePool

2
JMeixner
2 months ago
skitch210
skitch210New Here
posted in Script library

AIX Agent Auto Install

This is a Powershell Script that can be used to install and configure Veeam AIX Agent without needing to log into the AIX system. Can be because of lack of AIX expertise or a large number of AIX systems.  https://github.com/VeeamHub/powershell/tree/master/BR-AgentAIX-Install

2
JMeixner
2 months ago
SteveHeart
SteveHeartVeeam MVP
posted in Script library

vb365-exo-usage-report.ps1 - Script to report some Exchange Online numbers

Sometimes my customers ask for a more detailed capcity report regarding the stored Exchange Online backup data. Currently you only get the consumed capacity per repository and per organization. But how about calculating an average value from the stored backup data divided by the number of protected mailboxes?I wanted to hit two birds with one stone: Write a new script covering this topic and start to switch my existing scripts to modern authentication. Here you are: https://github.com/yetanothermightytool/powershell/tree/master/vbo/vb365-exo-usage-reportSoon I will publish a how-to guide with step by step instructions on how to create/update scripts using the modern authentication approach. Stay tuned. Happy weekend! Steve

1
Chris.Childerhose
2 months ago
k00laidIT
k00laidITVeeam Vanguard
posted in Script library

Revised kb3067.ps1 script

<#.SynopsisFor VB365 will migrate all data from one repository to another, based on the Veeam KB 3067. This version brings some sanity to the selection of proxies and repos while also providing information on what is to be moved (storage and user counts)..NotesVersion: 1.0Author: Jim Jones, @k00laidITModified Date: 5/23/2022.EXAMPLE.\iland-kb3067.ps1#>Import-Module Veeam.Archiver.PowerShell#Organization selection$orgs=Get-vboorganization | Sort-Object Namefor($i=0; $i -lt $orgs.count; $i++){write-host $i. $orgs[$i].name}$organisationNum = Read-Host "Enter organisation number"$vboOrg = $orgs[$organisationNum]$orgjobs = $vboOrg | get-vbojob[System.Collections.ArrayList]$orgrepos = @()foreach ($orgjob in $orgjobs) { $repo = $orgjob.repository $output = [PSCustomObject]@{ repoName = $repo } $orgrepos += $output }#Source Repository selection$sourcerepo = $orgreposfor($i=0; $i -lt $sourcerepo.count; $i++){write-host $i. $sourcerepo[$

4
k00laidIT
2 months ago
filipsmeets
filipsmeetsNew Here
posted in Script library

Powershell - Migrate VMs from Hyper-V to vSphere

[CmdletBinding()]param ( # CSv file tab delimited with name and Vlan [Parameter(Mandatory = $true)] [string[]] $CSV, # The datacenter where you want to move the workload to. [Parameter(Mandatory = $true)] [string] $Datacenter, # The Cluster where you want to move the workload to. [Parameter(Mandatory = $true)] [string] $Cluster, # Errorlog [Parameter()] [string] $ErrorLog = 'E:\Scripts\ErrorLog.txt', # Enable error logging [Parameter()] [switch] $LogErrors, # Enable error logging [Parameter()] [Int32] $HostIndex = 0)#$Global:ErrorLog = 'E:\Scripts\ErrorLog.txt'function Write-ToLog { [cmdletbinding()] Param ( [string] [parameter(ValueFromPipeline)] $Text ) if ($LogErrors) { $timestamp = Get-Date Write-Output "$timestamp :: $Text" | Tee-Object $ErrorLog -Append }}function Move-Workload { <# .SYNOPSIS Performs a migration of VMs running on Hyper-V to

12
A
2 months ago
SteveHeart
SteveHeartVeeam MVP
posted in Script library

vbr-nas-hashcompare.ps1 - Script to compare a hash value from an Instant File Share Recovery

Hello community!Some customers asked for it and here is it (a little X-mas present for the community):The NAS Hash Comparer. This script launches an Instant File Share Recovery for a specified file share backup job and compares the hash value using the given parameters. More details can be found on my GitHub page: https://github.com/yetanothermightytool/powershell/blob/master/vbr/vbr-nas-hashcompare/README.mdHappy HolidaysSteve

2
Chris.Childerhose
3 months ago
StefanZi
StefanZiVeeam MVP
posted in Script library

VB365-JobManager - Script to create and maintain SPO & Teams jobs

Guys, I've created a script to automatically create SPO and Teams jobs. Main features includeCreate jobs for all currently unprotected SPO sites and teams Build jobs based on a object-limit per job (incl. recurse option to cope with SP subsites) Distribute jobs over different repositories automatically (which includes proxy balancing of course) Add matching teams to the same job as the SP site as per BP Automatic scheduling with delays per job (configurable) All built on the VB365 API - so no M365 application or so required Include & excludes possible Can put objects in a job pointing to a repository which already contains backups of this objectThe script is available on VeeamHub: powershell/VB365-JobManager at master · VeeamHub/powershell (github.com) I already have two larger customers using versions of this script and am looking for more feedback of course.

2
Chris.Childerhose
3 months ago

Badge winners

Show all badges
Terms & Conditions