Events
Groups
Leaderboard

Community
Community
Script library

Script library

Browse and download code samples or contribute your own scripts

123 Topics
617 Comments

When you subscribe we will email you when there is a new topic in this category

123 Topics

Recently active

Most replies Most views Newest first

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 -

InfowhizNew Here

asked in Script library

Backup Eamil Notifications

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

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

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

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

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 ?

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

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

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.

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

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.

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:

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

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

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

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

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

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

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.

ddomaskVeeam MVP

posted in Script library

List Source Region/Subscription Information for Restore Points from External Repo Backup Copies

So, this is definitely a deep edge case if you could not tell from the title, if you could even figure out the situation from the title :)But since I went down this rabbit hole for a case, figured I’d share it for people getting deep into automation and the Veeam Public Cloud Backups who are following 3-2-1 rule and making Backup Copies of these from their External Repositories. Even if you never need to solve this particular use case, I suppose it’s a good example of what you can actually learn about a backup and how to properly parse data without nasty string munging.Issue: Backup Copies sourced from External Backups don’t have a UI field to associate the Restore Points with the original backed up machine’s public cloud information like Subscription, Region, etc.Where this likely becomes an issue is when you heavily automate regional deployments and may have identical infrastructures set up uniquely for individual regions. (e.g., you deploy machines with same names for regions that o

Chris.ArceneauxVeeam MVP

posted in Script library

VSPC Sample Usage Report

One of the first scripts I wrote after I joined Veeam was one that produced a license usage report using the Veeam Availability Console API. Since then, a lot has changed! The product was rebranded to Veeam Service Provider Console (VSPC) and it’s API was greatly updated in a complete rewrite!That change occurred a couple years ago... As such, it was definitely long overdue for this script to be reworked so it could leverage this amazing new API! This script uses minimal API calls to retrieve current point in time license usage for every company in VSPC. On top of that, if the company is managed by a reseller, reseller information will be included in the output.Developer’s notes...This script is meant to be a stepping stone as the framework can easily be used in other automations. I tried to keep most of the code modular by design so folks can use the script as-is or take the pieces you need for your custom Veeam integration. It can also serve as a reference on how to use Asynchronous

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.

ScottVeeam Legend

posted in Script library

Script to remove data from a share monthly.

I have a lot of users that require a location accessible to everyone to share files on a temporary basis. (non confidential type info) My issue is that nobody likes to delete anything here… EVER! After having to clean it out multiple times I figured I’d run a scheduled task for a PowerShell script to clean the folder out on the first of every month. The issue is now people wondering why the files were deleted event though it was explained and called Temporary_Data_Transfer. lol I created a folder titled “_Instructions” at the top that won’t be removed by the script and the underscore keeps it at the top. There is a document in it so users can review the date the folder is cleaned out and states that files will be deleted monthly. This has really helped clear things up with people not knowing their files will be removed. The script omits clean up of that folder by increasing the date to make it appear as a new file. The also script keeps a log of deleted files so when someone is ask

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

RK99Experienced User

asked in Script library

How Application Aware Image Processing Will VMWARE(Virtual Domain Controller) Configured on Top Veeam will take Backup

Incase of Multiple VMs available on top of Veeam how AAIP will help and Support

1
2
3
4
5

Page 3 / 5

Badge winners

lohoueshas earned the badge Veeam University Freshman
kamiljhas earned the badge Veeam University Freshman
HangTen416has earned the badge Webinar Presenter
TylerJurgenshas earned the badge Webinar Presenter
kirststoner12has earned the badge Veeam University Freshman

Show all badges

Powered by Gainsight

Terms & Conditions

Sign up

Already have an account? Login

Log in with your Veeam account

Login to the community

Log in with your Veeam account

Enter your username or e-mail address. We'll send you an e-mail with instructions to reset your password.

Username or e-mail

Back to overview

Scanning file for viruses.

Sorry, we're still checking this file's contents to make sure it's safe to download. Please try again in a few minutes.

OK

This file cannot be downloaded

Sorry, our virus scanner detected that this file isn't safe to download.

OK