Script library

Browse and download code samples or contribute your own scripts

84 Topics
426 Comments

vNote42Veeam Legend, Veeam Vanguard

posted in Script library

[PowerShell, PowerCLI] Check for VMs that are not being backuped

If you do not run VeeamONE, it can be challenging to check if every VM that should be backed up, is really backed up. Therefore I wrote a small PowerShell script. Basically this script looks for each VM if there is a restore point for this VM. If not, it gets listed. Extra feature: Script connects to every vCenter that is registered in B&R server. There is a Blocklist included: when VMs should not be backuped, just place their name in the blocklist and they will not be shown in the list. So you can exclude VMs without editing the script.Notes:CredObject.xml is used for stored, encrypted credentials. Script connects to local B&R server, so it should run there if not changed. # Load Plugin and moduleAdd-PSSnapin VeeamPSSnapinImport-Module VMware.VimAutomation.Core# Configure for multiple vCenter ConnectionsSet-PowerCLIConfiguration -DefaultVIServerMode Multiple -Scope Session -Confirm:$falseSet-PowerCLIConfiguration -InvalidCertificateAction Ignore -Scope Session -Confirm:$false#

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)

vNote42Veeam Legend, Veeam Vanguard

posted in Script library

PowerShell Script to show running Veeam jobs at point or period of time

Recently I had to troubleshoot a Veeam Backup & Replication (B&R) problem. There the question popped up which are the running Veeam jobs at point or period of time. The GUI is not a big help to answer this question. Therefore I wrote a small script that show these jobs.The following PowerShell script snippet is quite simple. First, start- (tStart) and end-date/time (tEnd) are asked for input. The following query selects all running Veeam jobs at point or period of time that matches input dates.# Ask for start- and end-date and timeWrite-Host "Enter date in format " ($(get-date).ToString("dd.MM.yyyy HH:mm"))$tStart = Read-Host "Enter start-time (Enter for now)"$tEnd = Read-Host "Enter end-time (Enter for equal to start-time)"if ($tStart -eq '') {$tStart = get-date -Format "dd.MM.yyyy HH:mm"}if ($tEnd -eq '') {$tEnd = $tStart}# Check input datatry {$tStart = [DateTime]::Parse($tStart)}catch {Write-Host "start-time wrong input"; continue}try {$tEnd = [DateTime]::Parse($tEnd)}cat

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

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_

Markus.K1985Veeam Vanguard

posted in Script library

[PowerShell] Get All Backup Repositories Advanced

[Array]$RepoList = Get-VBRBackupRepository | Where-Object {$_.Type -ne "SanSnapshotOnly"} [Array]$ScaleOuts = Get-VBRBackupRepository -ScaleOutif ($ScaleOuts) { foreach ($ScaleOut in $ScaleOuts) { $Extents = Get-VBRRepositoryExtent -Repository $ScaleOut foreach ($Extent in $Extents) { $RepoList = $RepoList + $Extent.repository } }}$RepoList | Select-Object Name, Path, `@{Name="CachedTotalSpaceGB"; Expression= {[Math]::Round([Decimal]$_.info.CachedTotalSpace/1GB,2)}}, `@{Name="CachedFreeSpaceGB"; Expression= {[Math]::Round([Decimal]$_.info.CachedFreeSpace/1GB,2)}} | Format-Table -AutoSize

k00laidITVeeam Vanguard

posted in Script library

Restart-VSS.ps1 Script

One thing I’ve found as a Veeam customer is you often have to restart the VSS services on your SQL and other VSS aware servers. Here’s a script I wrote to do just that.# Name: Restart-VSS.ps1# Description: Restarts list of services in an array on VMs with a given vSphere tag. Helpful for Veeam B&R processing# For more info on Veeam VSS services that may cause failure see https://www.veeam.com/kb2041Import-Module VMware.PowerCLI$vcenter = "vcenter.domain.com"$services = @("SQLWriter","VSS")$tag = "myAwesomeTag"Connect-VIServer $vcenter$vms = Get-VM |where {$_.Tag -ne $tag}ForEach ($vm in $vms){ ForEach ($service in $services){ If (Get-Service -ComputerName $vm -Name $service -ErrorAction SilentlyContinue) { Write-Host $service "on computer" $vm "restarting now." Restart-Service -InputObject $(Get-Service -Computer $vm -Name $service); } }}

MildurInfluencer

posted in Script library

Verify access to the protected Teams API

Update from @Chris.Arceneaux (Nov 7th, 2022):Chris has created a new script to automate the commands described in my topic. Thank you very much. :)https://github.com/VeeamHub/powershell/tree/master/VB365-CheckTeamsProtectedAPI______________________ My code has the added benefit of not requiring parameters (TenantID/AppId/CertThumbprint) to be specified as long as the script is executed on the VB365 server. It also automagically installs required PowerShell module(s). This script is about KB4322 (Using Microsoft Graph Export API for Teams) Recently, we were asked in the R&D forum, how much time Microsoft will take, until they inform you, that you have been granted to access to the protected API’s.Unfortunately, it seems that Microsoft will not inform you per Mail about the successful approvement. In Microsoft Docs, their statement is to use your application to verify if your request has been approved. Microsoft will only write you an email, if they have more questions about the requ

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

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.

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.

SteveHeartVeeam MVP

posted in Script library

Powershell - Exclude Teams object(s) from VBO Backup Job

Last year Veeam Backup for Microsoft Office 365 v5 added purpose-built backup and recovery for Microsoft Teams. Since then many customer and partners asked me "How can we protect all of our teams and exclude specific teams objects based on names automatically?".As there is no filter logic within the UI for the Backup Job object exclusion list, I solved this "problem" using the script down below. First we store the credentials (encrypted) in a txt file:$credential = Get-Credential$credential.Password | ConvertFrom-SecureString | Set-Content <path to secure.txt>And here's the script. Just change the values for the following variables: $organizationname Name of the tenant - Only needed if more than one is configured$backupjob Name of existing the Backup Job$filter Name of the team that needs to be excluded. Regular expressions can be used$userName Username for retrieving the existing Teams in M365$passwordText Path to the secure.txt fil

falkobVeeam Legend, Veeam Vanguard

posted in Script library

Automatically create vSphere roles to use with Veeam Backup & Replication

Since I was tired to click roles together in vCenter server, I wrote a simple script on creating a vCenter role for Veeam with PowerCLI.This PowerShell / PowerCLI script lets you create a new vCenter server role with all the cumulative privileges and permissions to use them with Veeam Backup & Replication V10.The privileges used are based on the recommendations out of the Veeam Help Center which you can find here: Cumulative Permission for VMware vSphere – Veeam Help CenterSimply execute the script and follow the steps to fill in the relevant data like your vCenter server name, the username and your password. The script will then ask you to choose a name for your new role and automatically creates it. The script in actionThe script was successfully tested against:VMware vCenter 6.5 VMware vCenter 6.7 VMware vCenter 7.0You can read about this on my blog:https://www.virtualhome.blog/2020/04/22/creating-a-vcenter-role-for-veeam-with-powercli/The script is online at github: https://git

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

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:

jorge.delacruzCommunity Manager

posted in Script library

[PowerShell] Veeam ONE notifications via MS Teams and Slack

Veeam ONE is a complete monitoring system for VMware, Hyper-V, Veeam and even at the application level being able to monitor VM services and processes running Microsoft Windows, without the need to install any agent, and all through API.As @Rick Vanover usually says, Veeam ONE will surely tell us more than one thing about our environment that we don't know, and Rick is right, with several hundred metrics that Veeam ONE collects, added to the several dozen reports that are included by default, Veeam ONE is that co-worker that we all would like to have in our IT team.Veeam ONE allows you to create notifications for each predetermined alarm or alarms that we create ourselves. While it is true that email notifications are the most basic and the ones we probably configure by default, sadly, it is true that email has become a tool overloaded with daily content, and most likely if a critical alarm falls in a folder or inbox along with 150 other emails, it will not pay the attention it require

k00laidITVeeam Vanguard

posted in Script library

VeeamHub?

Not to be a negative nelly, but don’t we already have github.com/veeamhub as a repository that is purpose built for this type of content, managed by people who know code? Can we not push community script additions there rather than turning them into effectively forum posts?

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.

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!!

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.

Markus.K1985Veeam Vanguard

posted in Script library

[PowerShell] vSphere Tag and vSphere SPBM Examples with Veeam Backup & Replication

#region: Add Veeam PSSnapin and ConnectAdd-PSSnapin VeeamPSSnapin$VeeamCred = Get-Credential -Message "Veeam Credential"Connect-VBRServer -Server "192.168.3.100" -Credential $VeeamCredFind-VBRViEntity#endregion#region: VMware Module and vCenter ConnectionGet-Module -ListAvailable -Name VMware* | Import-ModuleSet-PowerCLIConfiguration -DefaultVIServerMode Single -InvalidCertificateAction Ignore -Scope Session -Confirm:$false$vCenterCred = Get-Credential -Message "vCenter Credential"Connect-VIServer -Server "192.168.3.101" -Credential $vCenterCred#endregion#region: List Objects in Backup Jobs$VBRJobs = (Get-VBRJob).where({$_.JobType -eq "Backup" -and $_.Name -like "*Location*"})## List Backup Jobs that match the filter$VBRJobs | Select Name, JobType, SourceType | ft$VBRJobToLocationA = Get-VBRJob -Name "Backup to LocationA"## list Objects in Job$VBRJobToLocationA.GetObjectsInJob().GetObject() | Select ViType, Name, ObjectId | ft#endregion#region: Get Veeam Tag Details## Veeam Inventory(F

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. #

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

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

Chris.ArceneauxVeeam MVP

posted in Script library

VB365 Restore Portal Setup Scripts

Here’s a collection of scripts that can be used to automate the setup and configuration of the Veeam Backup for Microsoft 365 Restore Portal. These scripts can be used for VB365 environments protecting a single Microsoft 365 Organization and for those with multiple Microsoft 365 Organizations in a multi-tenant setup (like in a Service Provider scenario).For more detailed information, please follow the VeeamHub link:https://github.com/VeeamHub/powershell/tree/master/VB365-RestorePortalSetup

1
2
3
4

Page 1 / 4