Script library

Browse and download code samples or contribute your own scripts

93 Topics
462 Comments

k00laidITVeeam Vanguard

posted in Script library

Get-VeeamDistroSvc.ps1

#Requires -Version 5.1 -PSEdition Desktop<#.SynopsisReports on a given list of AD servers if they have the VeeamDistributionSvc running and it's startType. This is in response to Veeam KB4288, https://www.veeam.com/kb4288.NotesVersion: 1.0Author: Jim Jones, @k00laidITModified Date: 3/13/2022.EXAMPLE.\Get-VeeamDistroSvc.ps1#>$svcName = "VeeamDistributionSvc"$servers = Get-ADComputer -filter * | where {$_.Name -like "*veeam*" -or $_.Name -like "*backup*" -or $_.Name -like "*whatever*"}[System.Collections.ArrayList]$mySvcInfo = @()foreach ($server in $servers) { $svcstatus = get-service -ComputerName $server.name -Name $svcName | select name, status, startType $quickInfo = New-Object psobject -Property @{ server = $server.name service = $svcstatus.Name status = $svcstatus.status startType = $svcstatus.startType } $mySvcInfo += $quickInfo}$mySvcInfo | select server, service, status, startType

SteveHeartVeeam MVP

posted in Script library

Powershell - Veeam Backup for Microsoft Azure Worker "Tagger"

You want to tag your Veeam Backup for Microsoft Azure Workers? Here's a script that will help you:https://github.com/yetanothermightytool/powershell/tree/master/vbazure/vbazure-workertag

ldasilvaNew Here

asked in Script library

Enable encryption for all existing backup jobs using powershell

Hi guys, I was wondering if it is possible to enable the encrypt option for all backup jobs using powershell. I already have created the encryption key/password. Your help would be appriciated.

SteveHeartVeeam MVP

posted in Script library

Powershell - VBO Audit Item Configurator

Another week, another script Today I’m sharing a Powershell script to configure the audited items (user) and set the audit notification settings. More details about the enhanced audit item functionality can be found here:https://www.veeam.com/blog/next-gen-office-365-backup-security-auditing-and-reporting.htmlThe read me and the code can be found on github:https://github.com/yetanothermightytool/powershell/tree/master/vbo/vbo-auditcfg

Pasqual DöhringNot a newbie anymore

posted in Script library

Measure the changed data in your VMware environment

The problemHave you ever needed to know how much data you need to backup incrementally from your VMware environment? Because you need to design a new backup storage? Because you need to know, if your WAN is capable of transferring everything into the cloud or from your branch office? Because you need to know the change rates of your VMs? The solutionNow you can track these data changes with a simple script! Let me introduce you to GetChangedBlocksV2! It is a PowerShell script which uses the VMware PowerCLI to read the changes from your VMware disks each time it is run and saves it as CSV. It keeps track of the changes between each run, between each day and between each week. In order to get good results, you need to run this tool on a regular basis, e.g., with the Task Scheduler.There is even a basic Excel file included to analyze the results for you. But if you have better tools feel free to utilize them. Where to get it?https://github.com/turboPasqual/GetChangedBlocksV2 Other stuffWh

EdxHComes here often

posted in Script library

Veeam Easy Connect - making REST APIs a bit easier

Hi thereI’ve been working on a module to make connecting to Veeam APIs a bit easier when using Python (yes I am a big fan).https://github.com/shapedthought/veeam-easy-connectComments, issues and pull requests welcome.Cheers, Ed

SteveHeartVeeam MVP

posted in Script library

Powershell - VBO OneDrive for Business File Restore Checker

Another check script for OneDrive for Business data, protected by VBO. The script downloads a specific file and compares the hash value with the value specified by the user. Feedback welcome!Download Linkhttps://github.com/yetanothermightytool/powershell/tree/master/vbo/vbo-odrestore-checker Outlook upcoming scriptsI have a script ready that uploads the detected file hashes/the files to a cloud-based detection and prevention solution and returns the result of the scan.

SteveHeartVeeam MVP

posted in Script library

Powershell - VBO Exchange Mailbox Item Restore Content Checker

During my presentations on VBO to customers and partners, people sometimes ask whether the recoverability of data can be checked automatically (Our Veeam Backup & Replication customers love SureBackup). However, this functionality is not available.Since I have now been told this "wish" several times, I thought "New Year, New Luck!"First, I share the Powershell script to check backed up Exchange Online restore data. With this script it is possible to save an email from a mailbox to a local directory and check if a certain pattern can be read.More functions will be added soon. Please give me feedback what can be improved or added.A script for checking OneDrive for Business data will also be available soon. The script can be found here:https://github.com/yetanothermightytool/powershell/tree/master/vbo/vbo-exrestore-checker And don't forget: Always post feature requests in our R&D forum!

Chris.ArceneauxVeeam MVP

posted in Script library

Identifying Cloud Connect Orphaned Backups

Here’s a sample PowerShell script to identify Cloud Connect backups that are no longer tied to an active Backup Job. It also includes functionality to only show restore points older than XX days.Further background info on this script... When a Copy Job (or Backup Job) is deleted that was sending its backups to a (Cloud Connect) Cloud Repository, the backup files are not deleted by default. This behavior is great as it enables a backup administrator to hold on to the backups according to their company's retention policy. Sometimes, though, these backups are forgotten which results in additional storage consumed in the Cloud Repository which translates to higher storage costs. This script provides an automated method of identifying these backups so they aren't forgotten.NOTE: This script is designed to be executed on a Veeam Backup & Replication server that sends backups to a Cloud Repository. It will not work if executed on a Cloud Connect server.For more detailed information, pleas

SteveHeartVeeam MVP

posted in Script library

Powershell - VBO Health Check

Update Jan 13th - Latest version available on https://github.com/yetanothermightytool/powershell/tree/master/vbo/vbo-health-checker***It's always recommended to open a support case as soon you're facing an issue with Veeam Backup for Microsoft Office 365. But as systems engineers, we somehow always want to know what happens under the hood That's why I started writing a VBO Health Check script which quickly gives some useful information about the health of a Veeam Backup for Microsoft 365 setup. The script checks and reports possible issues/misconfigurations: - Backup Job Status per Job / Number of failed job - License expiration date - Check logs if throtthling occured on MS side - Possible slow backup due to slow backup repository - Proxy stuff (min. recommended CPU and Memory) - Check Windows event log for low memory conditions - Logfile with the findingsLogfile gets stored in “C:\Scripts\Veeam\vbo\vbo_healthcheck_<computername>.log”Note: The script is

7Ryan7New Here

asked in Script library

Automatically remove machines from Job

Hey All,I’ve tried to get some automation for the backup of my Citrix base images. I have a script that adds a machine to the backup job based on the name. Of course, these machines get created and deleted like flies, and I was wanting to automatically remove them if they’ve been removed from vCenter. I guess I could use tags, but then I’d have to rely on my Citrix admin to use the tags, and if it’s forgotten then there’s no backup, so I’ve decided a script is the way to go. So adding machines to the jobs works wonderfully, but I can’t seem to nail the way to remove the machines that aren’t in vCenter inventory. I also have the auto delete from backups turned on to prune the base images after x days. Here’s the snippet of powershell causing issues:#Searches the backup job to find any VM that don't have a size associated with the VM and assigns it to the variable ie. VM is still in the job but the VM is deleted.$NullVM = Get-VBRJobObject -job $Citrixbackupjob | Where-Object -Prope

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

bp4JCVeeam Legend

posted in Script library

Validator Script

Hi, all I made a simple script that will allow you to run the backup validator and receive a report. echocd C:\Program Files\Veeam\Backup and Replication\BackupVeeam.Backup.Validator.exe /backup:"BackupName" /report:"C:\VeeamReports"rem May have to specify name(s) of VMs being backed up in jobrem If there are multiple backup jobs, you must create a new line for each job --> Veeam.Backup.Validator.exe /backup:"BackupName" /report:"C:\VeeamReports"

txmlawrenceNew Here

asked in Script library

Veeam CLI command to globally enable encrytion

I’ve been searching and trying different commands to set the flag to “enable backup file encryption” within the VBR “Configuration Backup Settings”.While I can see how to create the password with the API with the Add-VRBEncryptionKey shown below, I don’t see a command to set the flag above. Any help would be greatly appreciated...

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

Chris.ArceneauxVeeam MVP

posted in Script library

Enforce Backup Job Basic Retention

Here’s a sample PowerShell script to enforce Restore Point configuration for both VMware Backup Jobs & vCloud Backup Jobs. The script retrieves the job’s current retention setting (Restore Points), compares it against the standard defined in a CSV file, and adjusts the configuration where needed. For more detailed information, please follow the VeeamHub link:https://github.com/VeeamHub/powershell/tree/master/BR-EnforceJobRetention

CptAmericaComes here often

posted in Script library

Enable/Disable Health Checks for Multiple Jobs

Hello again, everyone! Just sharing another useful PowerShell script to enable/disable Health Checks for multiple jobs. It’s handy whenever you have a large number of jobs which all need to be adjusted and would take a significant amount of time to do so. Usually I wouldn’t share such a short script, but the way to locate and adjust this particular option in a job via PowerShell can be a little confusing if you’re a PowerShell novice.I decided to provide multiple examples for editing various job types and not just an all-or-nothing approach. I hope someone finds these useful! If I missed anything, please let me know and I’ll include it.NOTE: These are all examples of how to disable Health Checks. To flip it around to have it enable Health Checks, simply change $false to $true. For ALL jobs:Add-PSSnapin -Name VeeamPSSnapIn -ErrorAction SilentlyContinueforeach ($job in Get-VBRJob) { $options = Get-VBRJobOptions -Job $job $options.GenerationPolicy.EnableRechek = $false Set-VBRJob

CptAmericaComes here often

posted in Script library

Restore Most Recent SQL Database From Backup Job

Not too long ago I had a customer who only had a Standard license which meant he didn’t have access to SureBackup, but had a need to validate a highly critical SQL database’s backups on a near daily basis. I figured it wouldn’t be too hard to write up a PS script that’d take some basic information about the source job name and database and where it needed to be restored and quickly sort by most recent and selecting it and kicking off the restore. That way he could just fire up the script when necessary. He ended up setting up a scheduled task where each day his DBAs would have the previous day’s backup restored next to the production database and they could do whatever verifications they needed. Easy peasy!Note: Tested and working in v10 & v11 (Should work just fine in v9.x as well, but not tested)<### Un-comment to enable debug output when troubleshooting script ###>#$DebugPreference = "Continue"<### Included for backward compatibility for servers still running pre-v10. #

AnucNew Here

asked in Script library

How to get a restore job id for the VM using PowerShell command?

We are not getting restore job Id while running the below PowerShell command in Veeam 11, but for versions below 11, we are getting the restore job id.I checked the Veeam11 commands document but couldn’t find anything helpful regarding VM restore job id.Let us know if there is any particular command to fetch the job id. Running command using Veeam11:$latest_backup_copy = Get-VBRBackup -Name 'backup_job_0'| Get-VBRRestorePoint -Name 'oracle_smallest' | Sort-Object -Property CreationTime -Descending | Select -First 1 ;; Start-VBRRestoreVM -RestorePoint $latest_backup_copy -ToOriginalLocation -StoragePolicyAction Default -PowerUp:$True -RunAsync Restore Type VM Name State Start Time End Time Description------------ ------- ----- ---------- -------- -----------RestoreVm oracle_smallest Starting 5/28/2021 12:17:24 PM 1/1/1900 12:00:00 AM Running

MattMComes here often

posted in Script library

NAS Backup Copy to Tape via Instant File Share Recovery

Since the introduction of NAS backup capability with v10 of Veeam Backup & Replication there have been many requests for tape support. But as we all know, Veeam’s NAS backup doesn’t support tape (yet?), neither as a primary nor as secondary (backup copy or archive) target.With v11 we got the new feature called “instant file share recovery” which lets us publish file shares directly from the backups previously created with NAS backup jobs. My colleague Uwe Groening recently came up with the idea to use these shares, published by instant file share recovery, as a source for file to tape jobs within Veeam. This way, it should be possible to create tape copies directly from existing file share backups. This makes a huge difference to other solutions that involve either reading data from the production share again or staging a restore on some (extra) storage prior to using “file to tape” from there.We discussed this idea in more detail and created a process (for a single NAS backup job)

Chris.ArceneauxVeeam MVP

posted in Script library

Veeam Usage Report for VMware Cloud Director

The PowerShell script to retrieve Veeam backup usage for VMware Cloud Director (VCD) Organizations is now available on VeeamHub! Below is a brief description of its functionality. For more detailed information, please follow the VeeamHub link.For each organization, the following is provided:Total number of VMs in backups Total amount of space used in repositoriesThe usage data can be aggregated on the Organization-level or the Org VDC-level. This is useful when backups for different Org VDCs are billed differently.The scope of the usage returned is also customizable. It can be limited to self-service backups, created by the Veeam Self-Service Portal (VSSP) for VCD, or it can also include backups created directly on the backup server by the provider.NOTE: Before using this script in a production environment, I recommend you verify that numbers match up to your environment. This script uses undocumented API calls that are subject to change.https://github.com/VeeamHub/powershell/tree/mast

Link StateVeeam Legend

posted in Script library

How to atomate & schedule Veeam.Backup.Validator.exe

Doc Veeam validatorKB2086: How to Use the Veeam Backup ValidatorVeeam Backup Validator - Veeam Backup Guide for vSphere It is essential to verify the status of the backups at the CRC level on the storage and the possibility of restoring them via Surebackup.During the wizard for creating a backup job you can enable "Storage backup files healt check (detect and auto-heals corruption. https://helpcenter.veeam.com/docs/backup/vsphere/backup_health_check.html?ver=110I prefer to automate the validation process to have a detailed report every 2 weeksCopy past and save .ps1 format <#.SYNOPSIS Performs a validation of all server backups.DESCRIPTION .NOTES File Name : veeam_validator.ps1 Author : Me and my colleague Prerequisite : PowerShell V2 , VeeamPSSnapIn installed#>#------------------------------------------ VARIABLES TO CHANGE -------------------------$email_infoTO = "yourmail@yourdomain.com"$email_infoFrom = "$($env:COMPUTERNAME)@ yourdomain.com "$email_

Chris.ArceneauxVeeam MVP

posted in Script library

Automated Upgrade to Veeam Backup & Replication v11

The PowerShell script to automate the upgrade for Veeam Backup & Replication & Enterprise Manager to v11 is now available on VeeamHub! Here’s a blog post with more detailed information: https://www.arsano.ninja/2021/03/09/veeam-unattended-upgrade-v11/ If you're a VCSP, the script can also be used for Cloud Connect environment upgrades.

Chris.ArceneauxVeeam MVP

posted in Script library

Veeam Collection for Ansible: v11 support

Support for Veeam Availability Suite v11 (VBR/EM/ONE) is now available in the Veeam Collection for Ansible! Here’s a blog post outlining changes made and improvements: https://www.arsano.ninja/2021/03/03/veeam-ansible-collection-v11/ For those not familiar with this Ansible collection, please see this blog post for an introduction.

CptAmericaComes here often

posted in Script library

Restore Same Folder/Files From Multiple Backups

First time sharing, so feedback is much appreciated, but please excuse my code if it’s not up to par with those who have a lot more experience with Powershell than I. I recently had a client who -- for legal purposes -- needed to restore the same folder from two month’s worth of backups. Running 61 File Level Restores in the GUI seemed like a nightmare, so he opened a case asking if there was an easier way. Unfortunately, through the GUI there’s really not an easier way, but this sounded like a perfect scenario for leveraging some Veeam PowerShell cmdlets. I soon discovered that the FLR cmdlets don’t have functionality that supports a ‘Copy To’ feature like you’d get in the GUI, so I had to leverage what Veeam cmdlets we do have and then add in some good old basic PowerShell commands to then pull the data from the mount point (C:\VeeamFLR\ by default) and move it to the target, then loop through n-number of times based on the user input.Here’s what I came up with. I’m still working on

1
2
3
4

Page 3 / 4