Script library

Browse and download code samples or contribute your own scripts

84 Topics
426 Comments

84 Topics

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

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

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

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

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!

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

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

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

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

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.

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); } }}

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"

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.

k00laidITVeeam Vanguard

posted in Script library

VSPC API v3 Storage Report

<#.Synopsis Generates report of all repositories known to a given Veeam Service Provider Console Server. Uses the new v3 API so your milage may vary..Notes Version: 1.0 Author: Jim Jones Modified Date: 8/21/2020 If running for the first time a new computer You will need to run to store the credentials $credpath='c:\creds\myadmincred.xml' GET-CREDENTIAL –Credential (Get-Credential) | EXPORT-CLIXML $credpath.EXAMPLE .\VACStorageReport.ps1 -vacServer 'vac.mydomain.com' -authPath 'c:\creds\myadmincred.xml'#>[CmdletBinding()]Param ( [string]$vacserver = "vac.mydomain.com", [string]$authpath = "c:\creds\myadmincred.xml")#Email Variables$date = Get-Date$sgToken = "SendGridToken"$fromAddress = "myvac@mydomain.com"$fromName = "US VAC"$toName = "NetOps"$toAddress = "me@me.com"$emailBody = "See attached VSPC Repository Usage Report for $date"$emailSubject = "VSPC Repository Usage Report for $date"$Credentials = IMPORT-CLIXML -path $a

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

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

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

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

jorge.delacruzCommunity Manager

posted in Script library

[Bash Shell Script] How to Secure your Veeam Backup for AWS v2 instance with a Let’s Encrypt SSL certificate

Hello everyone, today I bring you one more step on how to correctly secure our instance of Veeam Backup for AWS v2.To do this we will rely on Let’s Encrypt, the famous open-source project that allows us to generate free SSL certificates.NOTE: This process is not officially supported by Veeam, and any consequence of following the steps incorrectly, or any incidence derived from these steps will leave us without support. We will have to deploy the appliance again, keep that in mind!Where shall I run this Script?My recommendation will be to run it from a Linux VM, Container, or similar that you have already on your on-prem, or in the Cloud. As a last alternative, not supported of course, is to follow these steps inside the Veeam Backup for AWS appliance itself.Installation of system requirementsTo make it all work we’re going to need a couple of packages to do all this automatically:jq The necessary Let’s Encrypt packagesTo install jq, we will launch the following command:sudo apt-get ins

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_

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

Chris.ChilderhoseVeeam Legend, Veeam Vanguard

posted in Script library

Veeam Service Providers - Check Ransomguard

This is a simple oneliner for the MSPs out there if you are needing to check if Ransomguard is enabled for your VCC tenants this will output it on the screen for you from Powershell - Get-VBRCloudTenant | sort-object | FT Name, BackupProtectionEnabled, BackupProtectionPeriod You can also output this to a file that could be emailed as well.

1
2
3
4

Page 3 / 4