Veeam Backup 7 Powershell

Veeam Backup & Replication PowerShell
Version 7.0
User Guide
November, 2013
Important!
2013 Veeam Software. All rights reserved. All trademarks are the property of their respective owners. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form by any means, without written permission from Veeam Software Inc (Veeam). The information contained in this document represents the current view of Veeam on the issue discussed as of the date of publication and is subject to change without notice. Veeam shall not be liable for technical or editorial errors or omissions contained herein. Veeam makes no warranties, express or implied, in this document. Veeam may have patents, patent applications, trademark, copyright, or other intellectual property rights covering the subject matter of this document. All other trademarks mentioned herein are the property of their respective owners. Except as expressly provided in any written license agreement from Veeam, the furnishing of this document does not give you any license to these patents, trademarks, copyrights, or other intellectual property. Please read the End User Software License Agreement before using the accompanying software program(s). Using any part of the software indicates that you accept the terms of the End User Software License Agreement.
2 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3
CONTENTS
CONTENTS............................................................................................................................................ 3 CONTACTING VEEAM SOFTWARE....................................................................................................... 8 ABOUT THIS GUIDE.............................................................................................................................. 9 GETTING STARTED............................................................................................................................. 10 EXAMPLES OF USE .................................................................................................................................................................13 POWERSHELL REMOTING ......................................................................................................................................................18 INTERACTIVE POWERSHELL HELP .........................................................................................................................................19 VEEAM BACKUP & REPLICATION CMDLETS ..................................................................................... 21 ADD-HP3SNAPSHOT ............................................................................................................................................................35 ADD-HP3STORAGE ..............................................................................................................................................................37 ADD-HP4SNAPSHOT ............................................................................................................................................................39 ADD-HP4STORAGE ..............................................................................................................................................................41 ADD-VBRBACKUPJOB ..........................................................................................................................................................43 ADD-VBRBACKUPREPOSITORY............................................................................................................................................45 ADD-VBRCOPYJOB ..............................................................................................................................................................48 ADD-VBRCREDENTIALS........................................................................................................................................................51 ADD-VBRESX .......................................................................................................................................................................53 ADD-VBRESXI ......................................................................................................................................................................56 ADD-VBRHVBACKUPCOPYJOB ...........................................................................................................................................58 ADD-VBRHVBACKUPJOB.....................................................................................................................................................61 ADD-VBRHVCLUSTER ..........................................................................................................................................................63 ADD-VBRHVHOST................................................................................................................................................................65 ADD-VBRHVJOBOBJECT......................................................................................................................................................67 ADD-VBRHVPROXY..............................................................................................................................................................69 ADD-VBRHVREPLICAJOB.....................................................................................................................................................71 ADD-VBRHVSCVMM ............................................................................................................................................................73 ADD-VBRJOBOBJECT ...........................................................................................................................................................75 ADD-VBRLINUX ....................................................................................................................................................................77 ADD-VBRREPLICAJOB ..........................................................................................................................................................79 ADD-VBRSMBV3CLUSTER...................................................................................................................................................82 ADD-VBRSMBV3HOST ........................................................................................................................................................85 ADD-VBRTAPEFILESJOB ......................................................................................................................................................87 ADD-VBRTAPEMEDIAPOOL ................................................................................................................................................90 ADD-VBRTAPEVMJOB.........................................................................................................................................................92 ADD-VBRVCENTER ...............................................................................................................................................................95 ADD-VBRVCLOUD ................................................................................................................................................................97 ADD-VBRVCLOUDBACKUPCOPYJOB..................................................................................................................................99 ADD-VBRVCLOUDJOB ...................................................................................................................................................... 102 ADD-VBRVCLOUDVC ....................................................................................................................................................... 104 ADD-VBRVIBACKUPCOPYJOB.......................................................................................................................................... 107 ADD-VBRVIBACKUPJOB ................................................................................................................................................... 110 ADD-VBRVIJOBOBJECT .................................................................................................................................................... 112 ADD-VBRVIPROXY ............................................................................................................................................................ 114 ADD-VBRVIREPLICAJOB ................................................................................................................................................... 116
ADD-VBRWANACCELERATOR ......................................................................................................................................... 119 ADD-VBRWINSERVER ....................................................................................................................................................... 121 ADD-VSBAPPLICATIONGROUP......................................................................................................................................... 123 ADD-VSBHVAPPLICATIONGROUP ................................................................................................................................... 125 ADD-VSBHVJOB ................................................................................................................................................................ 127 ADD-VSBHVVIRTUALLAB ................................................................................................................................................. 130 ADD-VSBJOB ..................................................................................................................................................................... 132 ADD-VSBVIAPPLICATIONGROUP ..................................................................................................................................... 135 ADD-VSBVIRTUALLAB....................................................................................................................................................... 137 CLEAR-VBRWANCACHE .................................................................................................................................................. 139 CONNECT-VSBHVVIRTUALLAB......................................................................................................................................... 141 CONNECT-VSBVIRTUALLAB .............................................................................................................................................. 143 COPY-VBRJOB.................................................................................................................................................................... 145 DISABLE-VBRHVPROXY .................................................................................................................................................... 147 DISABLE-VBRJOB ............................................................................................................................................................... 149 DISABLE-VBRJOBGUESTFSINDEXING .............................................................................................................................. 151 DISABLE-VBRJOBSCHEDULE ............................................................................................................................................. 153 DISABLE-VBRJOBVSSINTEGRATION ................................................................................................................................ 155 DISABLE-VBRVIPROXY ...................................................................................................................................................... 157 EJECT-VBRTAPEDRIVE....................................................................................................................................................... 159 EJECT-VBRTAPEMEDIUM .................................................................................................................................................. 161 ENABLE-VBRHVPROXY ..................................................................................................................................................... 163 ENABLE-VBRJOB ................................................................................................................................................................ 165 ENABLE-VBRJOBGUESTFSINDEXING ............................................................................................................................... 167 ENABLE-VBRJOBSCHEDULE .............................................................................................................................................. 169 ENABLE-VBRJOBVSSINTEGRATION.................................................................................................................................. 171 ENABLE-VBRVIPROXY ....................................................................................................................................................... 173 ERASE-VBRTAPEMEDIUM ................................................................................................................................................. 175 EXPORT-VBRBACKUP ........................................................................................................................................................ 177 EXPORT-VBRCONFIGURATION .......................................................................................................................................... 179 EXPORT-VBRLOGS ............................................................................................................................................................. 180 EXPORT-VBRTAPEMEDIUM .............................................................................................................................................. 183 FIND-VBRDATASTORE ....................................................................................................................................................... 185 FIND-VBRHVENTITY .......................................................................................................................................................... 187 FIND-VBROBJECT .............................................................................................................................................................. 189 FIND-VBRRESOURCEPOOL................................................................................................................................................ 191 FIND-VBRTAPECATALOG .................................................................................................................................................. 192 FIND-VBRTAPECATALOGVERSION ................................................................................................................................... 193 FIND-VBRVCLOUDENTITY ................................................................................................................................................. 195 FIND-VBRVIDATASTORE ................................................................................................................................................... 198 FIND-VBRVIENTITY ............................................................................................................................................................ 200 FIND-VBRVIFOLDER .......................................................................................................................................................... 203 FIND-VBRVIRESOURCEPOOL ............................................................................................................................................ 205 FIND-VSBHVVIRTUALLAB ................................................................................................................................................. 207 FIND-VSBVIRTUALLAB ...................................................................................................................................................... 209 GET-HP3SNAPSHOT .......................................................................................................................................................... 211 GET-HP3STORAGE............................................................................................................................................................. 213
GET-HP3VOLUME .............................................................................................................................................................. 214 GET-HP4CLUSTER ............................................................................................................................................................. 216 GET-HP4SNAPSHOT .......................................................................................................................................................... 218 GET-HP4STORAGE............................................................................................................................................................. 220 GET-HP4VOLUME .............................................................................................................................................................. 222 GET-VBRBACKUP ............................................................................................................................................................... 224 GET-VBRBACKUPREPOSITORY.......................................................................................................................................... 226 GET-VBRBACKUPSESSION ................................................................................................................................................ 228 GET-VBRCREDENTIALS ...................................................................................................................................................... 230 GET-VBRFILESINRESTOREPOINT ...................................................................................................................................... 231 GET-VBRHVPROXY ............................................................................................................................................................ 233 GET-VBRINSTANTRECOVERY ............................................................................................................................................ 235 GET-VBRJOB ...................................................................................................................................................................... 236 GET-VBRJOBOBJECT ......................................................................................................................................................... 238 GET-VBRJOBOBJECTVSSOPTIONS ................................................................................................................................... 240 GET-VBRJOBOPTIONS ....................................................................................................................................................... 242 GET-VBRJOBPROXY .......................................................................................................................................................... 244 GET-VBRJOBSCHEDULEOPTIONS..................................................................................................................................... 246 GET-VBRJOBVSSOPTIONS ............................................................................................................................................... 248 GET-VBRLOCALHOST ........................................................................................................................................................ 250 GET-VBRREPLICA ............................................................................................................................................................... 251 GET-VBRRESTOREPOINT ................................................................................................................................................... 252 GET-VBRRESTORESESSION ............................................................................................................................................... 254 GET-VBRSERVER ................................................................................................................................................................ 256 GET-VBRTAPEBACKUP ...................................................................................................................................................... 258 GET-VBRTAPEDRIVE.......................................................................................................................................................... 260 GET-VBRTAPEJOB ............................................................................................................................................................. 262 GET-VBRTAPELIBRARY ...................................................................................................................................................... 264 GET-VBRTAPEMEDIAPOOL .............................................................................................................................................. 266 GET-VBRTAPEMEDIUM ..................................................................................................................................................... 268 GET-VBRTASKSESSION...................................................................................................................................................... 271 GET-VBRTOOLKITDOCUMENTATION ............................................................................................................................... 273 GET-VBRVIPROXY ............................................................................................................................................................. 274 GET-VBRWANACCELERATOR .......................................................................................................................................... 276 GET-VSBAPPLICATIONGROUP.......................................................................................................................................... 278 GET-VSBHVVIRTUALLAB .................................................................................................................................................. 280 GET-VSBJOB ...................................................................................................................................................................... 282 GET-VSBJOBOPTIONS ....................................................................................................................................................... 284 GET-VSBJOBSCHEDULEOPTIONS ..................................................................................................................................... 286 GET-VSBSESSION ............................................................................................................................................................... 288 GET-VSBTASKSESSION ...................................................................................................................................................... 290 GET-VSBVIRTUALLAB ........................................................................................................................................................ 292 IMPORT-VBRBACKUP......................................................................................................................................................... 294 IMPORT-VBRCONFIGURATION .......................................................................................................................................... 296 IMPORT-VBRTAPEMEDIUM ............................................................................................................................................... 298 MOVE-VBRTAPEMEDIUM ................................................................................................................................................. 300 NEW-VBRJOBOPTIONS ..................................................................................................................................................... 302
NEW-VBRJOBSCHEDULEOPTIONS ................................................................................................................................... 304 NEW-VBRJOBVSSOPTIONS............................................................................................................................................... 305 NEW-VBRVCLOUDVAPPRESTORESETTINGS ................................................................................................................... 307 NEW-VSBJOBOPTIONS ..................................................................................................................................................... 310 REMOVE-HP3SNAPSHOT .................................................................................................................................................. 312 REMOVE-HP3STORAGE ..................................................................................................................................................... 314 REMOVE-HP4SNAPSHOT .................................................................................................................................................. 316 REMOVE-HP4STORAGE ..................................................................................................................................................... 318 REMOVE-VBRBACKUP ....................................................................................................................................................... 320 REMOVE-VBRBACKUPREPOSITORY .................................................................................................................................. 322 REMOVE-VBRBACKUPSESSION ......................................................................................................................................... 324 REMOVE-VBRCREDENTIALS .............................................................................................................................................. 326 REMOVE-VBRHVPROXY .................................................................................................................................................... 327 REMOVE-VBRJOB ............................................................................................................................................................... 329 REMOVE-VBRJOBOBJECT.................................................................................................................................................. 331 REMOVE-VBRREPLICA ....................................................................................................................................................... 332 REMOVE-VBRRESTOREPOINT ........................................................................................................................................... 334 REMOVE-VBRRESTORESESSION ........................................................................................................................................ 336 REMOVE-VBRSERVER ......................................................................................................................................................... 338 REMOVE-VBRTAPEMEDIAPOOL ....................................................................................................................................... 340 REMOVE-VBRVIPROXY ...................................................................................................................................................... 342 REMOVE-VBRWANACCELERATOR .................................................................................................................................. 344 REMOVE-VSBAPPLICATIONGROUP .................................................................................................................................. 346 REMOVE-VSBHVVIRTUALLAB ........................................................................................................................................... 348 REMOVE-VSBJOB ............................................................................................................................................................... 350 REMOVE-VSBSESSION ....................................................................................................................................................... 352 REMOVE-VSBVIRTUALLAB ................................................................................................................................................ 354 RESET-HVVMCHANGETRACKING ...................................................................................................................................... 356 RESET-VBRJOBOPTIONS ................................................................................................................................................... 358 RESET-VBRJOBSCHEDULEOPTIONS ................................................................................................................................. 360 RESET-VBRJOBVSSOPTIONS ............................................................................................................................................. 362 RESET-VSBJOBOPTIONS.................................................................................................................................................... 364 RESTART-VBRINSTANTRECOVERY..................................................................................................................................... 366 SET-VBRCREDENTIALS....................................................................................................................................................... 368 SET-VBRJOBADVANCEDBACKUPOPTIONS ...................................................................................................................... 370 SET-VBRJOBADVANCEDHVOPTIONS .............................................................................................................................. 374 SET-VBRJOBADVANCEDNOTIFICATIONOPTIONS ........................................................................................................... 376 SET-VBRJOBADVANCEDOPTIONS .................................................................................................................................... 378 SET-VBRJOBADVANCEDSTORAGEOPTIONS .................................................................................................................... 382 SET-VBRJOBADVANCEDVIOPTIONS ................................................................................................................................ 384 SET-VBRJOBOBJECTVSSOPTIONS .................................................................................................................................... 387 SET-VBRJOBOPTIONS ....................................................................................................................................................... 390 SET-VBRJOBPROXY ........................................................................................................................................................... 392 SET-VBRJOBSCHEDULE ..................................................................................................................................................... 395 SET-VBRJOBSCHEDULEOPTIONS ..................................................................................................................................... 399 SET-VBRJOBVSSOPTIONS ................................................................................................................................................. 401 SET-VSBJOBOPTIONS........................................................................................................................................................ 403
SET-VSBJOBSCHEDULE ..................................................................................................................................................... 405 SET-VSBJOBSCHEDULEOPTIONS...................................................................................................................................... 409 START-VBRHVINSTANTRECOVERY ................................................................................................................................... 411 START-VBRHVINSTANTRECOVERYMIGRATION ............................................................................................................... 414 START-VBRHVREPLICAFAILBACK ..................................................................................................................................... 416 START-VBRHVRESTOREVM .............................................................................................................................................. 418 START-VBRINSTANTRECOVERY......................................................................................................................................... 421 START-VBRJOB .................................................................................................................................................................. 424 START-VBRQUICKMIGRATION .......................................................................................................................................... 426 START-VBRREPLICAFAILOVER .......................................................................................................................................... 429 START-VBRRESTOREVM ................................................................................................................................................... 431 START-VBRRESTOREVMFILES .......................................................................................................................................... 433 START-VBRTAPECATALOG................................................................................................................................................ 435 START-VBRTAPEINVENTORY ............................................................................................................................................. 437 START-VBRTAPERESTORE ................................................................................................................................................. 439 START-VBRTAPERESTOREFILES ........................................................................................................................................ 441 START-VBRVCLOUDINSTANTRECOVERY .......................................................................................................................... 444 START-VBRVCLOUDRESTOREVAPP ................................................................................................................................. 447 START-VBRVCLOUDRESTOREVM ..................................................................................................................................... 450 START-VBRVIREPLICAFAILBACK ....................................................................................................................................... 453 START-VBRVIREPLICAFAILOVER ....................................................................................................................................... 455 START-VBRWINDOWSFILERESTORE................................................................................................................................. 458 START-VBRZIP ................................................................................................................................................................... 460 START-VSBJOB ................................................................................................................................................................... 463 STOP-VBRINSTANTRECOVERY .......................................................................................................................................... 465 STOP-VBRJOB .................................................................................................................................................................... 467 STOP-VBRREPLICAFAILOVER ............................................................................................................................................ 469 STOP-VBRVIREPLICAFAILBACK ........................................................................................................................................ 471 STOP-VBRWINDOWSFILERESTORE .................................................................................................................................. 473 STOP-VSBJOB .................................................................................................................................................................... 474 SYNC-HP3STORAGE .......................................................................................................................................................... 476 SYNC-HP3VOLUME ........................................................................................................................................................... 478 SYNC-HP4STORAGE .......................................................................................................................................................... 480 SYNC-HP4VOLUME ........................................................................................................................................................... 482 SYNC-VBRBACKUPCOPYJOB ............................................................................................................................................ 484 SYNC-VBRBACKUPREPOSITORY ....................................................................................................................................... 486
CONTACTING VEEAM SOFTWARE

At Veeam Software we value the feedback from our customers. It is important not only to help you quickly with your technical issues, but it is our mission to listen to your input, and build products that incorporate your suggestions.
Customer Support
Should you have a technical concern, suggestion or question, please visit our Customer Center Portal at cp.veeam.com to open a case, search our knowledge base, reference documentation, manage your license or obtain the latest product release.
Company Contacts
For the most up to date information about company contacts and offices location, please visit www.veeam.com/contacts.html.
Online Support
If you have any questions about Veeam Backup & Replication, you can use the following resources: Full documentation set: www.veeam.com/vmware-esx-backup/resources.html Community forum at www.veeam.com/forums
ABOUT THIS GUIDE

This reference provides information about Veeam Backup PowerShell extension a snap-in to Microsoft Windows PowerShell. The document applies to version 6.5 and all subsequent versions until it is replaced with a new edition.
Intended Audience
The reference is intended for anyone who wants to use the PowerShell extension in Veeam Backup & Replication. It is primarily aimed at administrators of the virtual environment, consultants, analysts and any other IT professionals who use Veeam Backup PowerShell.
Related Documentation
The complete set of Veeam Backup & Replication documentation can be found on the product resources web page at www.veeam.com/vmware-esx-backup/resources.html.
Conventions
In order to help you get the most out of this guide, we have used the following formatting conventions, terms and abbreviations in the document: Style Used f
Style Boldface Italics Hyperlink Description User interface elements (names of dialog windows, buttons and so on). Titles, special terms and general emphasis, file paths, names of files and folders. Cross reference links and external hyperlinks
Additionally, important information, notes and tips are provided in the following format: Note This type of formatting is used for tips, notes and important information the user should pay attention to.
Document Revision History

Revision # Revision 1 Revision 2 Revision 3 Date 8/15/2013 8/19/2013 11/10/2013 Description of Changes Initial version of the document for Veeam Backup PowerShell Reference 7.0 Updated list of cmdlets for tapes Added descriptions for managing SMB3 hosts and configuration backup
GETTING STARTED
Veeam Backup & Replication comes with PowerShell extension a snap-in to Microsoft Windows PowerShell 2.0. Windows PowerShell is a powerful command-line tool that allows administrators to automate some Veeam Backup & Replication activities. Veeam extends functionality of Windows PowerShell 2.0, and now administrators may use PowerShell to automate Veeam backup, replication and copy job creation and editing, VMs restores, replica failover and other operations. Before installing Veeam PowerShell snap-in, make sure that Microsoft Windows PowerShell 2.0 is installed on the Veeam Backup & Replication console. To download Microsoft Windows PowerShell, use the following link: http://support.microsoft.com/kb/968929. To open Veeam PowerShell, select PowerShell in the Veeam Backup & Replication main menu. PowerShell uses cmdlets simple single-function commands that can be run in the command-line shell. Cmdlets are specialized .NET classes that implement specific actions. Veeam PowerShell provides a set of its own cmdlets which correspond to actions you can perform via Veeam Backup & Replication UI. Please keep in mind that actions performed with PowerShell have the same force as actions performed via Veeam Backup & Replication (for example, if you delete some job with PowerShell scripts, the job will be removed from the Veeam Backup & Replication database, and you will not be able undo changes). Note: Veeam Support team does not write PowerShell scripts on demand. Working with Veeam PowerShell cmdlets and scripts in many respects depends on your imagination, skills and expertise in Windows PowerShell 2.0. To learn more about Windows PowerShell 2.0 and its basics, use the book by Dr. Tobias Weltner: Microsoft Master-PowerShell. Cmdlets operate with objects which they can accept and return. Every object has properties describing it, and methods that can be performed on it. For example, the Get-VBRJob cmdlet has the following output:
You can filter and sort results at your discretion using the Where and Sort commands (to learn more about these commands, please refer to Windows PowerShell documentation). PS C:\Administrator> Get-VBRJob | Where {$_.Name -eq "Backup Job 3"} Job Name Type State Last Result Description Created by...
Backup Job 3 Hyper-V Backup Stopped Success
The result of filtering and sorting can be saved to a variable: PS C:\Administrator> $job = Get-VBRJob | Where {$_.Name -eq "Backup Job 3"} PS C:\Administrator> $job Job Name Type State Last Result Description Created by...
Backup Job 3 Hyper-V Backup Stopped Success
You can get detailed information about the object: PS C:\Administrator> $job | gm TypeName: Veeam.Backup.Core.CBackupJob Name MemberType Definition
CanRunByScheduler Delete DisableScheduler EnableScheduler Equals FindInitialRepository FindLastSession FindSourceWanAccelerator FindTargetRepository FindTargetWanAccelerator GetHashCode GetHvOijs GetInitialRepository GetLastResult GetLastState GetObjectsInJob GetOptions GetProxy GetScheduleOptions GetSourceOffHostHvProxies GetSourceViProxies GetSourceWanAccelerator GetTargetHost GetTargetOffhostHvProxies GetTargetProxies GetTargetRepository GetTargetViProxies
Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method Method
bool ISchedulableJob... void Delete() void DisableScheduler() void EnableScheduler() bool Equals(System... Veeam.Backup.Core... Veeam.Backup.Core... Veeam.Backup.Core... Veeam.Backup.Core... Veeam.Backup.Core... int GetHashCode() Veeam.Backup.Core... Veeam.Backup.Core... Veeam.Backup.Model... Veeam.Backup.Model... Veeam.Backup.Core... Veeam.Backup.Model... System.Collections... Veeam.Backup.Model... Veeam.Backup.Core... Veeam.Backup.Core... Veeam.Backup.Core... Veeam.Backup.Core... Veeam.Backup.Core... System.Collections... Veeam.Backup.Core... Veeam.Backup.Core...
And call a method or a property of the object, for example, view last session results. Note: Since Veeam Backup & Replication v5 and v6 use Windows PowerShell 2.0, scripts that you have created with previous versions of Veeam Backup & Replication which used Windows PowerShell 1.0 may not work. Examples of Use PowerShell Remoting Interactive PowerShell Help
Examples of Use
In this example, we will review the full VM restore process performed by means of Veeam PowerShell script. To let you get most out of this example, each command will be illustrated by the action from the Veeam Backup & Replication UI that provides the result similar to execution of the PowerShell script. First, we get a list of all available backup jobs with the Get-VBRJob cmdlet: PS C:\Administrator> Get-VBRBackup Job Name Type Creation Time VM count
Backup Job 1 Backup Job 2 Backup Job 7
VMware Backup VMware Backup VMware Backup
8/1/2013 4:47:19 AM 8/1/2013 5:00:28 AM 8/6/2013 3:15:13 AM
1 1 1
The similar action is performed by the Restore wizard in Veeam Backup & Replication:
Then, we get a list of available restore points, select the last restore point and save it into a variable: PS C:\Administrator> Get-VBRBackup -Name "Backup Job 7" | GetVBRRestorePoint VM Name Creation Time Type Failoved
Backup Job 1 7/23/2013 3:15:43 AM Full Backup Job 2 7/30/2013 3:10:15 AM Increment Backup Job 7 8/6/2013 3:45:52 AM Increment
PS C:\Administrator> $restorepoint = Get-VBRBackup -Name "Backup Job 7" | Get-VBRRestorePoint | Select -Last 1 PS C:\Administrator> $restorepoint VM Name Creation Time Type Failoved
Backup Job 7 8/6/2013 3:45:52 AM Increment
A similar action is performed by the Restore wizard in Veeam Backup & Replication:
To restore a VM to another location, we will need: ESX host to which the VM should be restored Resource pool Datastore on which the VM will reside
Let's get them and save into variables.
Getting the ESXi host: PS C:\Administrator> $server = Get-VBRServer -Name "esx18.veeam.local" PS C:\Administrator> $server Name Type Machine Name Description
esx18.veeam.local ESXi esx18.veeam.local
Getting the resource pool (you need to indicate the host to look for the resource pool on): PS C:\Administrator> $pool = Get-VBRServer -Name "esx18.veeam.local" | Find-VBRViResourcePool -Name "fileservers" PS C:\Administrator> $pool ConnHo : st : Type : Refere : nce : Id : Name Path Veeam.Backup.Core.CHost ResourcePool resgroup-14867 ebaf51b0-c972-4080-95de-b590aa6cf73b_resgroup-14867 fileservers fileservers
Similar actions are performed in the steps of the Restore wizard in Veeam Backup & Replication: Selecting the host:
And then selecting the resource pool:
Now, let's perform restore of the VM: PS C:\Administrator> Start-VBRRestoreVM -RestorePoint $restorepoint -Server $server -ResourcePool $pool Restore session Restore started Job 'WinXPx86' is working... Restore Type VM Name RestoreVm State End Time
WinXPx86 Stopped 8/6/2013 5:01:18 AM
You can also view the restore job result in the Veeam Backup & Replication UI:
PowerShell Remoting
Veeam PowerShell supports remote execution of cmdlets and scripts. That is, you can run cmdlets and scripts directly on the Veeam Backup & Replication, or against remote computers. A remote session can be started on one remote computer, or a number of remote computers at a time. To enable PowerShell remoting: 1. 2. Install the WinRM Service. Enable PowerShell remoting. Start Windows PowerShell 2.0 as an administrator and type in Enable-PSRemoting http://blogs.msdn.com/b/powershell/archive/2008/05/10/remoting-with-powershellquickstart.aspx http://www.computerperformance.co.uk/powershell/powershell_remote.htm
To learn more about PowerShell remoting and its configuration, see:
Interactive PowerShell Help

Veeam PowerShell includes an interactive console-based help for each cmdlet. To get a cmdlet description, you can use the following commands: Get-VBRcommand displays a list of all Veeam PoweShell cmdlets that can be used. PS C:\Administrator> Get-VBRCommand CommandType Name ----------- ---Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Cmdlet Add-VBRBackupJob Add-VBRBackupRepository Add-VBRCopyJob Add-VBRCredentials Add-VBRESX Add-VBRESXi Add-VBRHvBackupCopyJob Add-VBRHvBackupJob Add-VBRHvCluster Add-VBRHvHost Add-VBRHvJobObject Add-VBRHvProxy Add-VBRHvReplicaJob Add-VBRHvScvmm Add-VBRJobObject Add-VBRLinux Add-VBRReplicaJob Add-VBRSmbV3Cluster Add-VBRSmbV3Host Add-VBRTapeFilesJob Add-VBRTapeMediaPool Add-VBRTapeVMJob Add-VBRvCenter Add-VBRvCloud Add-VBRvCloudBackupCopyJob Add-VBRvCloudJob Add-VBRvCloudVC Add-VBRViBackupCopyJob Add-VBRViBackupJob Add-VBRViJobObject Add-VBRViProxy ModuleName ---------VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn VeeamPSSnapIn
Get-Help <cmdletname> displays a full description of the specified cmdlet along with its syntax and full parameter description. PS C:\Users\Administrator> Get-Help Get-VBRTaskSession NAME Get-VBRTaskSession SYNOPSIS Returns list of tasks performed during a specified session. SYNTAX Get-VBRTaskSession [-Session] <CBackupSession> [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] DESCRIPTION This cmdlet returns a list of all tasks performed during the specified session. You can get the tasks for backup, replication and backup copy sessions. Run Get-VSBTaskSession to get the tasks for SureBackup session. RELATED LINKS REMARKS To see the examples, type: "get-help Get-VBRTaskSession examples". For more information, type: "get-help Get-VBRTaskSession detailed". For technical information, type: "get-help Get-VBRTaskSession full".
VEEAM BACKUP & REPLICATION CMDLETS

You can perform the following operations to administrate your backup infrastructure using Veeam PowerShell snap-in: Managing virtualization hosts and clusters Managing proxy servers Managing job assigned proxy servers Managing credentials Managing backup repositories Looking for virtual instances Managing vCloud Managing HP 3PAR StoreServ infrastructure Managing HP LeftHand P4000 or HP StoreVirtual VSA infrastructure Working with tapes Performing SureBackup Copying backups to a secondary location Managing backup files Managing jobs Managing job objects Managing job options Replicating Instant recovery Restoring Managing job sessions Managing restore points Performing VeeamZIP Getting help Exporting logs
Managing virtualization hosts and clusters

Add hosts and clusters to your Veeam Backup & Replication management console and administrate them.
Operation VMware Hyper-V
Add various type hosts ans clusters to Veeam Backup & Replication console: Adds a Linux server Adds a Windows server Adds a vCenterServer Adds an ESX host Adds an ESXi host Adds a Hyper-V host Adds a Hyper-V cluster Adds a Microsoft System Center Virtual Machine Manager server (SCVMM) Adds an SMB3 cluster Adds an SMB3 host Add-VBRLinux Add-VBRWinServer Add-VBRvCenter Add-VBRESX Add-VBRESXi Add-VBRLinux Add-VBRWinServer Add-VBRHvHost Add-VBRHvCluster Add-VBRHvScvmm Add-VBRSmbV3Cluster Add-VBRSmbV3Host
Get and remove hosts from your console: Looks for hosts you manage Gets the host you are working on Removes a host Get-VBRServer Get-VBRLocalhost Remove-VBRServer Get-VBRServer Get-VBRLocalhost Remove-VBRServer
Managing proxy servers

Create virtual proxy servers in your Veeam Backup & Replication console and administrate them.
Operation Creates a new virtual proxy Enables a disabled proxy Disables a proxy Looks for proxies you manage Removes a proxy VMware Add-VBRViProxy Enable-VBRViProxy Disable-VBRViProxy Get-VBRViProxy Remove-VBRViProxy Hyper-V Add-VBRHvProxy Enable-VBRHvProxy Disable-VBRHvProxy Get-VBRHvProxy Remove-VBRHvProxy
Managing job assigned proxy servers

Look which proxies are assigned to a job and reassign job proxies.
Operation Looks for proxies assigned to a job Reassigns job proxies VMware Get-VBRJobProxy Set-VBRJobProxy Hyper-V Get-VBRJobProxy Set-VBRJobProxy
Managing credentials
Create and manage credentials records in your Veeam Bacup & Replication console.
Operation Creates a new credentials record Looks for credentials records managed with your console Removes a credentials record Edits a credentials record VMware Add-VBRCredentials Get-VBRCredentials Remove-VBRCredentials Set-VBRCredentials Hyper-V Add-VBRCredentials Get-VBRCredentials Remove-VBRCredentials Set-VBRCredentials
Managing backup repositories

Add VMware backup repositories in your Veeam Backup & Replication console and administrate them.
Operation Adds a new backup repository Looks for connected backup repositories Removes a backup repository Rescans a backup repository VMware Add-VBRBackupRepository Get-VBRBackupRepository Remove-VBRBackupRepository Sync-VBRBackupRepository Hyper-V Add-VBRBackupRepository Get-VBRBackupRepository Remove-VBRBackupRepository Sync-VBRBackupRepository
Looking for virtual instances

Look for the virtual objects registered in your virtual infrastructure.
Operation Looks for all kinds of virtual objects Looks for datastores Looks for folders Looks for resource pools VMware Find-VBRViEntity Find-VBRViDatastore Find-VBRViFolder Find-VBRViResourcePool Hyper-V Find-VBRHvEntity
Managing vCloud
Add vCloud Director entities to your Veeam Backup & Replication console and administrate backup and recovery.
Operation VMware Add and remove vCloud Director servers: Adds a vCloud Director server Adds vCenter Server managed by vCloud Director Removes a vCloud server Add-VBRvCloud Add-VBRvCloudVC Remove-VBRServer Add-VBRvCloud Add-VBRvCloudVC Remove-VBRServer Hyper-V
Look for vCloud infrastructure objects: Looks for any kinds of vCloud Find-VBRvCloudEntity Find-VBRvCloudEntity
Operation objects
VMware
Hyper-V
Backup and restore vCloud objects: Creates a vCloud backup job Starts instant recovery of a vCloud VM Creates an object with a set of restore parameters for a vApp restore (run StartVBRvCloudRestoreVApp to apply) Restores vCloud vApp Restores a vCloud VM Add-VBRvCloudJob Start-VBRvCloudInstantRecovery Add-VBRvCloudJob Start-VBRvCloudInstantRecovery
NewVBRvCloudVAppRestoreSettings
NewVBRvCloudVAppRestoreSettings
Start-VBRvCloudRestoreVApp Start-VBRvCloudRestoreVm
Start-VBRvCloudRestoreVApp Start-VBRvCloudRestoreVm
Managing HP 3PAR StoreServ infrastructure

Add HP SAN entities to your Veeam Backup & Replication console and administrate them.
Operation VMware Work with SAN snapshots: Creates a SAN snapshot Looks for created SAN snapshots Removes a SAN snapshot Add-HP3Snapshot Get-HP3Snapshot Remove-HP3Snapshot Work with SAN storages: Adds a SAN storage Looks for SAN storages Removes a SAN storage Rescans a SAN storage Add-HP3Storage Get-HP3Storage Remove-HP3Storage Sync-HP3Storage Work with SAN volumes: Looks for SAN volumes Rescans a SAN volume Get-HP3Volume Sync-HP3Volume Hyper-V
Managing HP LeftHand P4000 or HP StoreVirtual VSA infrastructure

Add HP SAN entities to your Veeam Backup & Replication console and administrate them.
Operation VMware Work with SAN snapshots: Creates a SAN snapshot Looks for created SAN snapshots Removes a SAN snapshot Add-HP4Snapshot Get-HP4Snapshot Remove-HP4Snapshot Hyper-V
Operation
VMware Work with SAN storages:
Hyper-V
Adds a SAN storage Looks for SAN storages Removes a SAN storage Rescans a SAN storage
Add-HP4Storage Get-HP4Storage Remove-HP4Storage Sync-HP4Storage Look for SAN clusters:
Looks for SAN clusters
Get-HP4Cluster Work with SAN volumes:
Looks for SAN volumes Rescans a SAN volume
Get-HP4Volume Sync-HP4Volume
Working with tapes

Connect physical tape libraries to your Veeam Backup & Replication console and administrate tape backup and restore by means of your console.
Operation VMware Manage your tape infrastructure: Looks for tape libraries you manage Creates a new tape media pool Looks for media pools you manage Removes a media pool Get-VBRTapeLibrary Add-VBRTapeMediaPool Get-VBRTapeMediaPool Remove-VBRTapeMediaPool Work with tapes: Looks for tapes you manage Adds new tapes to tape libraries Moves tapes to another media pool Ejects a tape from a drive Erases a tape Takes tapes out of a library Get-VBRTapeMedium Import-VBRTapeMedium Move-VBRTapeMedium Eject-VBRTapeMedium Erase-VBRTapeMedium Export-VBRTapeMedium Work with drives: Looks for drives in libraries Ejects a tape from a specific drive Get-VBRTapeDrive Eject-VBRTapeDrive Get-VBRTapeDrive Eject-VBRTapeDrive Get-VBRTapeMedium Import-VBRTapeMedium Move-VBRTapeMedium Eject-VBRTapeMedium Erase-VBRTapeMedium Export-VBRTapeMedium Get-VBRTapeLibrary Add-VBRTapeMediaPool Get-VBRTapeMediaPool Remove-VBRTapeMediaPool Hyper-V
Operation
VMware Look for backup files:
Hyper-V
Looks for backup files archived to tapes
Get-VBRTapeBackup Inventory your tape archive:
Get-VBRTapeBackup
Indexes a library or a tape Inventories a library or a tape Looks for files archived to tapes Looks for versions (restore points) of files archived to tapes
Start-VBRTapeCatalog Start-VBRTapeInventory Find-VBRTapeCatalog
Start-VBRTapeCatalog Start-VBRTapeInventory Find-VBRTapeCatalog
Find-VBRTapeCatalogVersion
Backup to tape and restore from tape: Copies VM backups to tape Copies files to tape Looks for created tape jobs Restores VMs from tape Restores files from tape Add-VBRTapeVMJob Add-VBRTapeFilesJob Get-VBRTapeJob Start-VBRTapeRestore Start-VBRTapeRestoreFiles Add-VBRTapeVMJob Add-VBRTapeFilesJob Get-VBRTapeJob Start-VBRTapeRestore Start-VBRTapeRestoreFiles
Performing SureBackup
Create SureBackup environment to verify backups for recoverability.
Operation VMware Create SureBackup jobs: Creates a SureBackup job Add-VSBJob Work with virtual labs: Creates a new virtual lab Looks for virtual labs you manage Looks for virtual labs not connected to your console Adds an existing virtual lab to your console Removes a virtual lab Add-VSBVirtualLab Get-VSBVirtualLab Find-VSBVirtualLab (run Connect-VSBVirtualLab to add them) Connect-VSBVirtualLab Remove-VSBVirtualLab Work with application groups: Creates a new application group Looks for application groups you manage Removes an application Add-VSBViApplicationGroup Get-VSBApplicationGroup Remove-VSBApplicationGroup Add-VSBHvApplicationGroup Get-VSBApplicationGroup Remove-VSBApplicationGroup Add-VSBHvVirtualLab Get-VSBHvVirtualLab Find-VSBHvVirtualLab (run Connect-VSBHvVirtualLab to add them) Connect-VSBHvVirtualLab Remove-VSBHvVirtualLab Add-VSBHvJob Hyper-V
Operation group
VMware
Hyper-V
Work with SureBackup jobs: Looks for created SureBackup jobs Starts an existing SureBackup job Stops a running SureBackup job Removes a SureBackup job Get-VSBJob Start-VSBJob Stop-VSBJob Stop-VSBJob Set options to SureBackup jobs: Looks for settings of a specific SureBackup job Looks for schedule settings of a specific SureBackup job Creates an object with a set of SureBackup job setting (run Set-VSBJobOptions to apply) Edits setting of a specific SureBackup job Sets default settings to a selected SureBackup job Sets schedule to a selected SureBackup job Edits schedule options of a specific SureBackup job Get-VSBJobOptions Get-VSBJobScheduleOptions Get-VSBJobOptions Get-VSBJobScheduleOptions Get-VSBJob Start-VSBJob Stop-VSBJob Stop-VSBJob
New-VSBJobOptions
New-VSBJobOptions
Set-VSBJobOptions Reset-VSBJobOptions Set-VSBJobSchedule Set-VSBJobScheduleOptions Manage SureBackup sessions:
Set-VSBJobOptions Reset-VSBJobOptions Set-VSBJobSchedule Set-VSBJobScheduleOptions
Looks for SureBackup job sesions Looks for tasks performed during a specific SureBackup job session Removes a selected SureBackup job session
Get-VSBSession
Get-VSBSession
Get-VSBTaskSession
Get-VSBTaskSession
Remove-VSBSession
Remove-VSBSession
Copying backups to a secondary location

Copy backup files to secondary hosts using WAN acceleration technology.
Operation VMware Manage backup copy jobs: Copies VM backup files to a secondary repository Copies vCloud VM backup files to a secondary Add-VBRViBackupCopyJob Add-VBRvCloudBackupCopyJob Add-VBRHvBackupCopyJob Add-VBRvCloudBackupCopyJob Hyper-V
Operation repository Synchronizes source and target repository
VMware
Hyper-V
Sync-VBRBackupCopyJob Manage WAN accelerators:
Sync-VBRBackupCopyJob
Creates a WAN accelerator Looks for existing WAN accelerators Removes a WAN accelerator
Add-VBRWANAccelerator Get-VBRWANAccelerator Remove-VBRWANAccelerator
Add-VBRWANAccelerator Get-VBRWANAccelerator Remove-VBRWANAccelerator
Managing backup files

Import, export or remove backups.
Operation Imports backup files to Veeam Backup & Replication Exports backup files to a used-defined destination Looks for created backup files Removes backup files VMware Import-VBRBackup Export-VBRBackup Get-VBRBackup Remove-VBRBackup Hyper-V Import-VBRBackup Export-VBRBackup Get-VBRBackup Remove-VBRBackup
Managing jobs
Create, clone and administrate Veeam jobs.
Operations VMware Create backup, copy, replica, tape or SureBackup jobs: Copies a selected VM to another location Copies vCloud VM backup files to a secondary repository Creates a VM backup job Copies VM backup files to a secondary repository Creates a SureBackup job Creates a replica job Clears change tracking data Copies files to tape Copies VM backups to tape Backs up vCloud VMs Creates a VeeamZIP backup Add-VBRCopyJob Add-VBRCopyJob Hyper-V
Add-VBRvCloudBackupCopyJob Add-VBRViBackupJob Add-VBRViBackupCopyJob Add-VSBJob Add-VBRViReplicaJob Add-VBRTapeFilesJob Add-VBRTapeVMJob Add-VBRvCloudJob Start-VBRZip
Add-VBRvCloudBackupCopyJob Add-VBRHvBackupJob Add-VBRHvBackupCopyJob Add-VSBHvJob Add-VBRHvReplicaJob Reset-HvVmChangeTracking Add-VBRTapeFilesJob Add-VBRTapeVMJob Add-VBRvCloudJob Start-VBRZip
Operations
VMware Work with jobs:
Hyper-V
Clones an existing job Puts a job on temporary hold Enables a disabled job Looks for existing jobs Looks for existing SureBackup jobs Starts a created job Starts a created SureBackup job Stops a running job Stops a running SureBackup job Removes a job Removes a SureBackup job
Copy-VBRJob Disable-VBRJob Enable-VBRJob Get-VBRJob Get-VSBJob Start-VBRJob Start-VSBJob Stop-VBRJob Stop-VSBJob Remove-VBRJob Remove-VSBJob
Copy-VBRJob Disable-VBRJob Enable-VBRJob Get-VBRJob Get-VSBJob Start-VBRJob Start-VSBJob Stop-VBRJob Stop-VSBJob Remove-VBRJob Remove-VSBJob
Managing job objects

Edit the jobs you have already created by adding or removing job objects: VMs, VM containers or other virtual instances.
Operations VMware Add VMs or other virtual objects to your jobs: Adds VMs or other objects to a created job Add-VBRViJobObject Manage the job objects: Looks for VMs or other objects added to a job Removes VMs or other objects from a job Looks for VSS options set for a specific job object Edits VSS options of a specific job object Get-VBRJobObject Remove-VBRJobObject Get-VBRJobObjectVssOptions Set-VBRJobObjectVssOptions Get-VBRJobObject Remove-VBRJobObject Get-VBRJobObjectVssOptions Set-VBRJobObjectVssOptions Add-VBRHvJobObject Hyper-V
Managing job options

Edit general options, schedule, VSS settings or advanced options of a selected job.
Operations VMware Edit general options of backup, replication or copy jobs: Looks for settings of a selected job Get-VBRJobOptions Get-VBRJobOptions Hyper-V
Operations Creates an object containing new job settings (run Set-VBRJobOptions to apply) Applies new job settings to a selected job Sets default settings to a selected job
VMware
Hyper-V
New-VBRJobOptions
New-VBRJobOptions
Set-VBRJobOptions Reset-VBRJobOptions Create and manage job schedule:
Set-VBRJobOptions Reset-VBRJobOptions
Creates schedule for a selected job Enables a job schedule (you should have a schedule preset) Disables a job schedule (job requires manual run)
Set-VBRJobSchedule
Set-VBRJobSchedule
Enable-VBRJobSchedule
Disable-VBRJobSchedule
Set and manage job schedule options: Looks for schedule settings of a selected job Creates an object containing new schedule settings (run Set-VBRJobScheduleOptions to apply) Applies new schedule settings to a selected job Sets default schedule settings to a selected job Get-VBRJobScheduleOptions Get-VBRJobScheduleOptions
New-VBRJobScheduleOptions
Set-VBRJobScheduleOptions Reset-VBRJobScheduleOptions
Set-VBRJobScheduleOptions Reset-VBRJobScheduleOptions
Set and edit VSS (Volume Shadow Services) options of backup, replication or copy jobs: Looks for VSS settings of a selected job Creates an object containing new VSS settings (run SetVBRJobVssOptions to apply) Applies new VSS settings to a selected job Sets default VSS settings to a selected job Get-VBRJobVSSOptions Get-VBRJobVSSOptions
New-VBRJobVssOptions
Set-VBRJobVssOptions Reset-VBRJobVssOptions
Set-VBRJobVssOptions Reset-VBRJobVssOptions
Manage job VSS options and guest file system options: Disables guest file system indexing in a selected job Disables VSS settings in a selected job Enables guest file system indexing in a selected job Disable-VBRJobGuestFSIndexing Disable-VBRJobVSSIntegration Enable-VBRJobGuestFSIndexing Disable-VBRJobGuestFSIndexing Disable-VBRJobVSSIntegration Enable-VBRJobGuestFSIndexing
Operations Enables VSS settings in a selected job
VMware Enable-VBRJobVSSIntegration
Hyper-V Enable-VBRJobVSSIntegration
Edit general options of SureBackup jobs: Looks for settings of a selected SureBackup job Creates an object containing new SureBackup job settings (run Set-VSBJobOptions to apply) Applies new settings to a selected SureBackup job Sets default settings to a selected SureBackup job Get-VSBJobOptions Get-VSBJobOptions
New-VSBJobOptions
New-VSBJobOptions
Set-VSBJobOptions Reset-VSBJobOptions Set advanced options to jobs:
Set-VSBJobOptions Reset-VSBJobOptions
Sets special options for a selected job Sets advanced backup options for a selected job Sets advanced notification options for a selected job Sets advanced options for a selected job Sets advanced storage options for a selected job
Set-VBRJobAdvancedViOptions SetVBRJobAdvancedBackupOptions SetVBRJobAdvancedNotificationOptio ns Set-VBRJobAdvancedOptions SetVBRJobAdvancedStorageOptions
Set-VBRJobAdvancedHvOptions SetVBRJobAdvancedBackupOptions SetVBRJobAdvancedNotificationOptio ns Set-VBRJobAdvancedOptions SetVBRJobAdvancedStorageOptions
Replicating
Create replication jobs and migrate to replicas in case of production host malfunction.
Operations VMware Create replica jobs: Creates a replica job Add-VBRViReplicaJob Perform replica failover: Fail over a corrupted VM to its replica Undoes the replica failover Start-VBRViReplicaFailover Stop-VBRReplicaFailover Perform replica failback: Fails back to the production host Undoes the replica failback Start-VBRViReplicaFailback Stop-VBRViReplicaFailback Manage replicas: Looks for replicated VMs Get-VBRReplica Get-VBRReplica Start-VBRHvReplicaFailback Stop-VBRViReplicaFailback Start-VBRViReplicaFailover Stop-VBRReplicaFailover Add-VBRHvReplicaJob Hyper-V
Operations Removes a replicated VM
VMware Remove-VBRReplica
Hyper-V Remove-VBRReplica
Instant recovery
Recover VMs instantly from backup files.
Operations Starts an instant recovery of a vCloud VM Instantly recovers a VM from backup Starts Quick Migration of a VM Migrates a recovered VM to the production host Restarts a failed instant recovery Terminates an instant recovery Looks for instant recovery sessions VMware Start-VBRvCloudInstantRecovery Start-VBRInstantRecovery Start-VBRQuickMigration Stop-VBRInstantRecovery Get-VBRInstantRecovery Hyper-V Start-VBRvCloudInstantRecovery Start-VBRHvInstantRecovery StartVBRHvInstantRecoveryMigration Restart-VBRInstantRecovery Stop-VBRInstantRecovery Get-VBRInstantRecovery
Restoring
Restore VMs, vCloud VMs or files from backups or tape archives.
Operations VMware Restore virtual objects and files: Restores VM from tape Restores files from tape Restores a vCloud Director vApp Creates an object with a set of restore parameters for a vApp restore Restores a vCloud VM Restores a VM Restores VM configuration files Recovers guest Windows OS files Stops guest Windows OS file recovery session Start-VBRTapeRestore Start-VBRTapeRestoreFiles Start-VBRvCloudRestoreVApp NewVBRvCloudVAppRestoreSettings (run Start-VBRvCloudRestoreVApp to apply) Start-VBRvCloudRestoreVm Start-VBRRestoreVM Start-VBRRestoreVMFiles Start-VBRWindowsFileRestore Stop-VBRWindowsFileRestore Start-VBRTapeRestore Start-VBRTapeRestoreFiles Start-VBRvCloudRestoreVApp NewVBRvCloudVAppRestoreSettings (run Start-VBRvCloudRestoreVApp to apply) Start-VBRvCloudRestoreVm Start-VBRHvRestoreVM Hyper-V
Operations
VMware Work with restore sessions:
Hyper-V
Looks for restore sessions Removes a restore session
Get-VBRRestoreSession Remove-VBRRestoreSession
Get-VBRRestoreSession Remove-VBRRestoreSession
Managing job sessions

Get specific job sessions and look which tasks it contains.
Operations VMware Manage backup, replication and backup copy sessions: Looks for VM backup sessions Looks for tasks performed during a specific session Removes a backup session Get-VBRBackupSession Get-VBRTaskSession Remove-VBRBackupSession Manage restore sessions: Looks for restore sessions Removes a restore session Get-VBRRestoreSession Remove-VBRRestoreSession Manage SureBackup sessions: Looks for SureBackup sessions Looks for tasks performed during a specific SureBackup session Removes a SureBackup session Get-VSBSession Get-VSBSession Get-VBRRestoreSession Remove-VBRRestoreSession Get-VBRBackupSession Get-VBRTaskSession Remove-VBRBackupSession Hyper-V
Get-VSBTaskSession
Get-VSBTaskSession
Remove-VSBSession
Remove-VSBSession
Managing restore points

Look for restore points of your virtual instances and manage them.
Operations Looks for VM restore points Looks for files in a restore point Removes a restore point VMware Get-VBRRestorePoint Get-VBRFilesInRestorePoint Remove-VBRRestorePoint Hyper-V Get-VBRRestorePoint Get-VBRFilesInRestorePoint Remove-VBRRestorePoint
Performing VeeamZIP
Create a VM VeeamZIP backup.
Operations Creates a VeeamZIP backup Start-VBRZip VMware Start-VBRZip Hyper-V
Getting help
Open Veeam Backup & Replication help.
Operations Opens Veeam Backup & Replication help VMware Get-VBRToolkitDocumentation Hyper-V Get-VBRToolkitDocumentation
Exporting logs
Collect system logs and submit support tickets.
Operations Collects system logs to export VMware Export-VBRLogs Hyper-V Export-VBRLogs
Add-HP3Snapshot
Short Description
Creates a SAN snapshot.
Applies to
Version: 7.0 Platform: VMware HP SAN storage system: HP 3PAR StoreServ
Syntax
Add-HP3Snapshot -Volume <CSanVolume> [-Name <string>][Description <string>][<CommonParameters>]
Related Commands
Get-HP3Volume
Detailed Description
This cmdlet creates a snapshot of the selected HP SAN volume. See what else you can perform on HP 3PAR instances
Parameters
Parameter Description Required Position Accept Pipeline Input
True (ByValue, ByProperty Name) False
Accept Wildcard Characters
Volume
Specifies the SAN volume you want to take snapshot of. Specifies the name you want to assign to the snapshot. Specifies the description of the snapshot.
True
Named
False
Name
False
Named
False
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default.
False
Named
False
False
<CommonParameters> This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example 1
This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP3Volume and piped down. The description is "Vol 01 snapshot". Get-HP3Volume -Name "Vol 01" | Add-HP3Snapshot -Name "vol_SS_01" -Description "Vol 01 snapshot"
Example 2
This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP3Volume and assigned to the $volume variable beforehand. The description is "Vol 01 snapshot". Add-HP3Snapshot -Volume $volume -Name "vol_SS_01" -Description "Vol 01 snapshot"
Add-HP3Storage
Short Description
Adds HP SAN storage to Veeam Backup & Replication.
Applies to
Syntax
Add-HP3Storage -UserName <string> -Password <string> [-Name <string>] [-Description <string>] [-Url <string>][<CommonParameters>] -ORAdd-HP3Storage -Credentials <CCredentials> [-Name <string>] [Description <string>] [-Url <string>][<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds the selected HP SAN storage to Veeam Backup & Replication. When you add a storage to your management console, Veeam Backup & Replication automatically rescans the storage infrastructure. To rescan the SAN infrastructure manually, run Sync-HP3Storage or Sync-HP3Volume. When adding a SAN storage, you will need to provide either username/password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on HP 3PAR instances
Parameters
Parameter Description
Specifies the user name you want to use for authenticating with the SAN storage. UserName If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the SAN storage. If you use the Username/Password scenario, the -Credentials parameter False Named False False
Required
Position
Accept Pipeline Input
Password
False
Named
False
False
Parameter
Description
must be omitted. Specifies credentials you want to use for authenticating with the SAN storage.
Required
Position
Credentials
If you use the Credentials scenario, the -User and Password parameters must be omitted. Specifies the SAN storage IP address or DNS name. Specifies the description of the SAN storage.
True
Named
False
False
Name
False
Named
False
False
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the HP 3PAR Web Services API URL.
False
Named
False
False
Url
The HP 3PAR Web Services API delivers a programming interface for performing storage management tasks with HP 3PAR StoreServ storage systems.
False
Named
False
False
Example 1
This command adds a 3PAR storage with IP address 167.16.2.134 specified in the -Name parameter. The username is "Administrator" and the password is "Password". The URL is https://172.18.44.8:8080. Add-HP3Storage -UserName "Administrator" -Password "Password" Name 167.16.2.134 -Description "SAN Storage" -Url https://172.18.44.8:8080
Example 2
This command adds a 3PAR storage with IP address 167.16.2.134 specified in -Name parameter. The credentials object is obtained with Get-VBRCredentials and assigned to the $creds variable beforehand. The URL is https://172.18.44.8:8080. Add-HP3Storage -Credentials $creds -Name 167.16.2.134 Description "HP 3PAR Storage" -Url https://172.18.44.8:8080
Add-HP4Snapshot
Short Description
Creates a SAN snapshot.
Applies to
Version: 7.0 Platform: VMware HP SAN storage systems: HP LeftHand P4000, HP StoreVirtual VSA
Syntax
Add-HP4Snapshot -Volume <CSanVolume> [-Name <string>] [Description <string>][-ApplicationManagedShapshot] [<CommonParameters>]
Related Commands
Get-HP4Volume
This cmdlet creates a snapshot of the selected HP SAN volume. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Add-VBRHPSnapshot
Parameters
Volume
Specifies the SAN volume you want to take snapshot of. Specifies the name you want to assign to the snapshot. Specifies the description of the snapshot.
True
Named
False
Name
False
Named
False
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Indicates if the VM on the target volume should be quiesced to bring VM data to a consistent state. If omitted, Veeam Backup & Replication will create a
False
Named
False
False
Application Managed Shapshot
False
Named
False
False
Parameter
Description
point-in-time snapshot.
Required
Position
Example 1
This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP4Volume and piped down. The application-managed snapshot is enabled. The description is "Vol 01 snapshot". Get-HP4Volume -Name "Vol 01" | Add-HP4Snapshot -Name "vol_SS_01" -ApplicationManagedShapshot -Description "Vol 01 snapshot"
Example 2
This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01". The target volume object is obtained with Get-HP4Volume and assigned to the $volume variable beforehand. The application-managed snapshot is enabled. The description is "Vol 01 snapshot". Add-HP4Snapshot -Volume $volume -Name "vol_SS_01" ApplicationManagedShapshot -Description "Vol 01 snapshot"
Add-HP4Storage
Short Description
Adds HP SAN storage to Veeam Backup & Replication.
Applies to
Syntax
Add-HP4Storage -DnsOrIpAddress <string> -UserName <string> Password <string> [-Name <string>] [-Description <string>] [<CommonParameters>] -ORAdd-HP4Storage -DnsOrIpAddress <string> -Credentials <CCredentials> [-Name <string>] [-Description <string>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds the selected HP SAN storage to Veeam Backup & Replication. When you add a storage to your management console, Veeam Backup & Replication automatically rescans the storage infrastructure. To rescan the SAN infrastructure manually, run Sync-HP4Storage or Sync-HP4Volume. When adding a SAN storage, you will need to provide either username/password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Add-VBRHPStorage
Parameters
True (ByValue, ByProperty Name)
DnsOr IpAddress
Specifies the string with a full DNS name or IP address of the SAN storage. Specifies the user name you want to use for authenticating with the SAN storage.
True
Named
False
UserName
False
Named
False
False
If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the SAN storage. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the name of the management group the storage belongs to. Specifies the credentials you want to use for authenticating with the SAN storage. If you use the Credentials scenario, the -User and Password parameters must be omitted. Specifies the description of the SAN storage. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. False Named False False
Password
False
Named
False
False
Name
False
Named
False
False
Credentials
True
Named
False
False
Example 1
This command adds a SAN storage with IP address 167.16.2.134. The username is "Administrator" and the password is "Password". Add-HP4Storage -DnsOrIpAddress 167.16.2.134 -UserName "Administrator" -Password "Password" -Description SAN Storage
Example 2
This command adds a SAN storage with IP address 167.16.2.134. The credentials object is obtained with Get-VBRCredentials and assigned to the $creds variable beforehand. Add-HP4Storage -DnsOrIpAddress 167.16.2.134 -Credentials $creds Description SAN Storage
Add-VBRBackupJob
Short Description
Creates a new backup job. Note: In Backup & Replication v6 this cmdlet was replaced by Add-VBRViBackupJob and AddVBRHvBackupJob due to multihypervisor support introduced in the new version. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.
Applies to
Version: 7.0 and earlier Platform: VMware
Syntax
Add-VBRBackupJob [-Name] <String> [[-Type] <String>] [-Server] <CHost> [[-Folder] <String>] [-FileName <String>] -Objects <String[]> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet allows you to create a new backup job. Please note that when you create a backup job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job.
Parameters
Specifies the string with the name of the created backup job. Specifies the string with the type of the created backup job which defines how VM data is retrieved: Type VDDK Virtual Disk Development Kit (VMware vStorage API) VCB VMware Consolidated Backup (legacy mode) NET Network backup False 2 False False
Required
Position

False

False
Name
True
Parameter
Description
(legacy mode).
Required
Position
Server
Specifies the host where the created backup should be stored. Specifies the string with the path to the folder where the created backup should be stored. Specifies the string with the file name for the created backup (by default, the backup file is given the same name as the VM). Specifies the string with the name(s) of VM(s) that you want to back up. Specifies the description of the new backup job.
True
False
False
Folder
False
False
False
FileName
False
Named
False
False
Objects
True
Named
False
Description
False
Named
False
False
Example
This example allows you to create a backup job with the following parameters: Name of the backup job: jobName Data retrieval type: VDDK Variable which contains the target host DNS name or IP address: $server Path to the backup folder: C:\VmBackups VMs which should be backed up: vm1, vm2
Add-VBRBackupJob Name jobNameType VDDK Server $server Folder "C:\VmBackups" Objects vm1,vm2
Add-VBRBackupRepository
Short Description
Adds a new backup repository server.
Applies to
Syntax
Add-VBRBackupRepository [-Name <String>] [-Server <CHost>] [MountServer <CHost>] -Folder <String> -Type <CBackupRepositoryInfo+EType> [-ImportIndex] [-ImportBackup] [Description <String>] [-MaxConcurrentJobs <Int32>] [DataRateLimit <Int32>] [-AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRBackupRepository [-Name <String>] [-Server <CHost>] [MountServer <CHost>] -Folder <String> -Type <CBackupRepositoryInfo+EType> [-ImportIndex] [-ImportBackup] [Description <String>] [-UserName <String>] [-Password <String>] [-MaxConcurrentJobs <Int32>] [-DataRateLimit <Int32>] [AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRBackupRepository [-Name <String>] [-Server <CHost>] [MountServer <CHost>] -Folder <String> -Type <CBackupRepositoryInfo+EType> [-ImportIndex] [-ImportBackup] [Description <String>] [-Credentials <CCredentials>] [MaxConcurrentJobs <Int32>] [-DataRateLimit <Int32>] [AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer Get-VBRCredentials
This cmdlet adds a new backup repository server to Veeam Backup & Replication. When adding a backup repository, you may need to provide username/password or credentials to authenticate with the source server. This cmdlet provides three scenarios for each case including no authentification. See what else you can perform on backup repositories
Parameters
Specifies the the name you want to assign to the new backup repository. Specifies the host where the backup repository you want to add is located. Specifies the host where the NFS service should be installed. Specifies the full path to the folder where you want to store the backups. Specifies the type you want to assign to the repository: Type - CifsShare - LinuxLocal - WinLocal Import Index If indicated, the guest OS file system index will be imported automatically. If indicated, the existing backups located on the repository you are adding will be imported automatically. Otherwise, you will need to import the backups manually. Specifies the description of the backup repository. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the user name you want to use for authenticating with the backup repository host. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the backup repository host. If you use the Username/Password scenario, the -Credentials parameter must be omitted. False Named False False False Named False False True Named False False
Required
Position

False

False
Name
False
Named
Server
False
Named
False
False
Mount Server
False
Named
False
False
Folder
True
Named
False
False
Import Backup
False
Named
False
False
UserName
False
Named
False
False
Password
False
Named
False
False
Parameter
Description
Specifies credentials you want to use for authenticating with the backup repository host.
Required
Position
Credentials
If you use the Credentials scenario, the -User and Password parameters must be omitted. Specifies the maximum number of concurrent tasks for the repository. A valid range is 1-10. Specifies the combined data ingestion rate for the repository. A valid range is 11024 MByte/s. If set, the backup blocks size will be aligned by a 4Kb block boundary. Data alignment provides better deduplication on storage systems with fixed block size. If set, backup data blocks will be decompressed before storing the backup to the repository. Decompression helps to achieve a better deduplication ratio.
False
Named
False
False
Max Concurrent Jobs
False
Named
False
False
DataRate Limit
False
Named
False
False
Align DataBlocks
False
Named
False
False
Decompress DataBlocks
False
Named
False
False
Example
This command adds a new backup repository named "Backups Vol 01". The server to add is obtained with Get-VBRServer and assigned to the $server variable beforehand. The folder that is used as the backup repository is located on "C:\Backup Repository". The server type is set to "WinLocal". The -ImportBackup parameter is set to adopt the existing backup files. The Max concurrent tasks number is set to 6. The credentials to authentificate with the source server are obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand.
Add-VBRBackupRepository -Name "Backups Vol 01" -Server $server Folder "c:\Backup Repository" -Type WinLocal -ImportBackup MaxConcurrentJobs 6 -Credentials $Administrator
Add-VBRCopyJob
Short Description
Creates a new VM copy job.
Applies to
Syntax
Add-VBRCopyJob [-Name] <String> [-Type] <CDbBackupJobInfo+ESourceType> -Server <CHost> -Folder <String> [-FileName <String>] -Objects <String[]> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRCopyJob [-Name] <String> [-Type] <CDbBackupJobInfo+ESourceType> [-FileName <String>] -Objects <String[]> [-Description <String>] -Repository <CBackupRepository> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet creates a new job that copies the selected VM(s) to another location. With a VM copy job, you can create a fully-functioning copy of a VM that will require no manual editing and adjustments. VM copying can be helpful if you want to move your datacenter, mirror your production environment to test lab storage, etc. Please note that when you create a copy job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job. Run Copy-VBRJob to create a copy of a job. See what else you can perform on jobs
Parameters
Specifies the name you want to assign to the new copy job. Specifies the string with the type of the created copy job which defines how VM data is retrieved: Type VDDK Virtual Disk Development Kit (VMware vStorage API), VCB VMware Consolidated Backup (legacy mode), NET Network copy (legacy mode). Server Specifies the host where the created copy should be stored. Specifies the string with full path to the folder where the created VM copy should be stored. Specifies the string with the file name for the created VM copy (by default, a copied file is given the same name as the VM). Specifies the string with the name(s) of VM(s) that you want to copy. Specifies the description of the copy job. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. False Named False False True Named False False True 2 False False
Required
Position

False

False
Name
True
Folder
True
Named
False
False
FileName
False
Named
False
False
Objects
True
Named
False
Example
This example allows you to create a copy job with the following parameters: Name of a copy job: jobName Data retrieval type: VDDK Variable which contains the target host DNS name or IP address: $server Path to a copy folder: C:\VmCopies VMs which should be copied: vm1, vm2
Add-VBRCopyJob Name jobNameType VDDK Server $server Folder "C:\VmCopies" Objects vm1,vm2
Add-VBRCredentials
Short Description
Creates a credentials record.
Applies to
Version: 7.0 Platform: VMware, Hyper-V
Syntax
Add-VBRCredentials -User <String> -Password <String> [Description <String>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRCredentials [-Description <String>] [-Credential <PSCredential>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet creates a new credentials record for authenticating with the instances of your virtual infrastructure. You can add a new credentials record by indicating strings for user name and password (unprotected mode), or by supplying a PSCredential object. See what else you can perform on credentials
Parameters
Specifies the user name you want to use for authenticating with the instances of your virtual infrastructure. Please note that you should use DOMAIN\USERNAME usernames format for all hosts except ESX/ESXi hosts. Specifies the password you want to use for authenticating with the instances of your virtual infrastructure. Specifies the description for the credentials record. This parameter in non-mandatory, although it is recommended to
Required
Position
User
True
Named
False
False
Password
True
Named
False
False
Description
False
Named
False
False
Parameter
Description
input this value to make the credential records easily identified.
Required
Position
Credential
Specifies the credentials you want to add.
False
Named
False
False
Example 1
This command creates a new credentials record for the administrator. Add-VBRCredentials -User Administrator -Password Password_1 Description "Administrator Credentials"
Example 2
This command adds a credentials record for the administrator. Get-Credential is used to enter the username and password in the secure mode. Get-Credential | Add-VBRCredentials -Description "Administrator Credentials"
Add-VBRESX
Short Description
Adds an ESX host to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRESX [-Name] <String> [-User] <String> [-Password] <String> [-Port <Int32>] [-SSHUser <String>] [-SSHPassword <String>] [SSHPort <Int32>] [-SSHEnable] [-Description <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRESX [-Name] <String> [-Port <Int32>] [-SSHUser <String>] [-SSHPassword <String>] [-SSHPort <Int32>] [-SSHEnable] [Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds ESX servers to the Veeam Backup & Replication managing console. ESX servers are virtual infrastructure servers hosting the virtual machines of your virtual environment. You need to add the ESX servers to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console. You may add an ESX/ESXi host, vCenter Server or Linux server (use corresponding command for each). If you are planning to use an ESX host being a part of the vCenter hierarchy, we recommend adding the corresponding vCenter Server instead of a single ESX host to ensure more flexibility and convenience at work. When adding a new ESX server, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with a full DNS name or IP address of the ESX host. Specifies the user name you want to use for authenticating with the ESX host. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the ESX host. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Sets the integer specifying the number of the Web service port used to connect to the ESX host. By default, port 443 is used. Specifies the string with the user name of the account used for service console connection to the host (recommended). Specifies the string with the password of the account used for service console connection to the host (recommended). Sets the integer specifying the number of the service console port (recommended). Set this parameter to TRUE if you want to use service console connection for the added ESX host (recommended). Specifies the description of the ESX server. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. False Named False False
Required
Position

False

False
Name
True
User
True
False
False
Password
True
False
False
Port
False
Named
False
False
SSHUser
False
Named
False
False
SSHPassword
False
Named
False
False
SSHPort
False
Named
False
False
SSHEnable
False
Named
False
False
Parameter
Description
Specifies the credentials you want to use for authenticating with the ESX server. If you use the Credentials scenario, the -User and Password parameters must be omitted.
Required
Position
Credentials
True
Named
False
False
Example 1
This command adds the ESX host with 172.16.11.188 IP address. The username is "root" and the password is "qwerty". Add-VBRESX Name 172.16.11.188 User root Password qwerty
Example 2
This command adds the ESX host with 172.16.11.188 IP address. The credentials to authenticate with the host are obtained with Get-VBRCredentials and assigned to the $cAdministrator variable befohand. Add-VBRESX Name 172.16.11.188 -Credentials $Administrator
Add-VBRESXi
Short Description
Adds an ESXi host to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRESXi [-Name] <String> [-User] <String> [-Password] <String> [-Port <Int32>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRESXi [-Name] <String> [-Port <Int32>] [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds ESXi servers to the Veeam Backup & Replication managing console. ESXi servers are virtual infrastructure servers hosting the virtual machines of your virtual environment. You need to add the ESXi servers to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console. You may add an ESX/ESXi host, vCenter Server or Linux server (use corresponding command for each). If you are planning to use an ESXi host being a part of the vCenter hierarchy, we recommend adding the corresponding vCenter Server instead of a single ESX host to ensure more flexibility and convenience at work. When adding a new ESXi server, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with a full DNS name or IP address of the ESX host. Specifies the user name you want to use for authenticating with the ESX host. If you use the
Required
Position

False

False
Name
True
User
True
False
False
Parameter
Description
Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the ESX host.
Required
Position
Password
If you use the Username/Password scenario, the -Credentials parameter must be omitted. Sets the integer specifying the number of the Web service port used to connect to the ESX host. By default, port 443 is used. Specifies the description of the ESX server.
True
False
False
Port
False
Named
False
False
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the credentials you want to use for authenticating with the ESX server.
False
Named
False
False
Credentials
If you use the Credentials scenario, the -User and Password parameters must be omitted.
True
Named
False
False
Example 1
This command adds the ESXi host with 172.16.11.188 IP address. The username is "root" and the password is "qwerty". Add-VBRESXi Name 172.16.11.188 User root Password qwerty
Example 2
This command adds the ESXi host with 172.16.11.188 IP address. The credentials to authenticate with the host are obtained with Get-VBRCredentials and assigned to the $cAdministrator variable befohand. Add-VBRESXi Name 172.16.11.188 -Credentials $Administrator
Add-VBRHvBackupCopyJob
Short Description
Creates a Hyper-V backup copy job.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Add-VBRViBackupCopyJob.
Syntax
Add-VBRHvBackupCopyJob -SourceAccelerator <CWanAccelerator> TargetAccelerator <CWanAccelerator> [-Name <string>] [-Entity <IHvItem[]>][-Backup <CBackup[]>][-BackupJob <CBackupJob[]>] [Repository <CBackupRepository>][-Description <string>][<CommonParameters>]
Related Commands
Get-VBRWANAccelerator Find-VBRHvEntity Get-VBRBackup Get-VBRJob Get-VBRBackupRepository
This cmdlet creates a new Hyper-V backup copy job. The backup copy job is copying backup files from the source backup repository to the target backup repository. The backup copy job runs continuously synchronizing the backup repositories in userdefined time periods. The cmdlet provides two scenarios that can be used for on-site and off-site modes: To transfer the data efficiently to to the off-site location, you can use the WAN accelerator technology. WAN accelerator is a backup infrastructure component that optimizes file transfer via WAN by means of data deduplication. The role of a WAN accelerator can be assigned to a dedicated Windows-based machine (physical or virtual). For best performance you should set a WAN accelerator on both source and target sides. This mode is recommended for off-site backups. To create and run a backup copy job using WAN accelerators you need to have source and target WAN accelerators created. Run Add-VBRWANAccelerator to create a WAN accelerator. You can create a backup copy job using direct operation. With this method, the job sends the data directly to the target backup repository without performing data deduplication. This mode is recommended for on-site backups, or off-site backups using fast connections.
Please note that the backup copy job is created in disabled state. Run Enable-VBRJob to start the job running on the defined schedule. See what else you can perform on backup copy
Note:
WAN optimization is available only in Veeam Backup & Replication Enterprise Plus Edition.
Parameters
Specifies the WAN accelerator on the source side. If you select the mode using WAN accelerators, the DirectOperation parameter should be omitted. Specifies the WAN accelerator on the target side. If you select the mode using WAN accelerators, the DirectOperation parameter should be omitted. Enables the direct operation method sending the data directly to the target backup repository without performing data deduplication. If you select the direct operation mode, the TargetAccelerator and SourceAccelerator parameters should be omitted. Specifies the name you want to assign to the backup copy job. You can input string up to 255 symbols. Specifies the VM(s) you want to copy. You can assign multiple VMs to this object. Specifies the existing backup(s) from where the VMs to copy are derived. You can assign multiple backups to this object. Specifies the existing backup job(s) from where the VMs to copy are derived. You can assign multiple backup jobs to this object. True Named False False True Named False False
Required
Position
Source Accelerator
Target Accelerator
Direct Operation
True
Named
False
False
Name
False
Named
True (ByValue, ByProperty Name) True (ByValue, ByProperty Name) True (ByValue, ByProperty Name)
False
Entity
False
Named
False
Backup
False
Named
False
BackupJob
False
Named
False
Parameter
Description
Specifies the backup repository to where you want to copy the VM data. If not set, Veeam Backup & Replication will use the default backup repository. Specifies the description of the backup copy job.
Required
Position
Repository
False
Named
False
False
Description
False
Named
False
False
Example 1
This command creates a backup copy job named "CopyJob1" with the following parameters: The source and target WAN accelerators are obtained with Get-VBRWANAccelerator and assigned to $wansource and $wantarget variables accordingly beforehand, The VMs to copy are obtained with Find-VBRHvEntity and assigned to the $vms variable beforehand, The repository to where the VM data will be copied is obtained with GetVBRBackupRepository and assigned to the $repository variable beforehand.
Add-VBRHvBackupCopyJob -SourceAccelerator $wansource TargetAccelerator $wantarget -Name CopyJob1 -Entity $vms Repository $repository
Example 2
This command creates a direct backup copy job with the following parameters: The name of the job is "DC CopyJob", The backup job named "DC Backup" with the VMs to be copied is obtained with GetVBRBackup and piped down, The -Repository parameter is not set to copy the VMs to the default backup repository.
Get-VBRBackup -Name "DC Backup" | Add-VBRHvBackupCopyJob DirectOperation -Name "DC CopyJob"
Add-VBRHvBackupJob
Short Description
Creates a new Hyper-V backup job.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Add-VBRViBackupJob.
Syntax
Add-VBRHvBackupJob [-Name <String>] [-BackupRepository <CBackupRepository>] -Entity <IHvItem[]> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository Find-VBRHvEntity
This cmdlet creates a new Hyper-V backup job. Please note that when you create a backup job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job. See what else you can perform on jobs
Parameters
Specifies the name you want to assign to the backup job. Specifies the backup repository where the created backup should be stored. If not set, Veeam Backup & Replication will use the default backup repository. Specifies the VM(s) you want to back up. You can assign multiple VMs to this object. Specifies the description of
Required
Position

False

False
Name
False
Named
Backup Repository
False
Named
False
False
Entity
True
Named
False
Description
False
Named
False
Parameter
Description
the backup job. If not set, Veeam Backup & Replication will enter date and time of creation by default.
Required
Position
Example
This command creates a backup job named "Exchange Backup". The VMs to backup are obtained with Find-VBRHvEntity and piped down. The backup repository is obtained with Get-VBRBackupRepository and assigned to the $Repository variable beforehand. the description is "Hyper-V Exchange Backup". Find-VBRHvEntity -Name Exchange* | Add-VBRHvBackupJob -Name "Exchange Backup" -BackupRepository $Repository -Description "Hyper-V Exchange Backup"
Add-VBRHvCluster
Short Description
Adds a Hyper-V cluster to Veeam Backup & Replication.
Applies to
Version: 7.0 and earlier Platform: Hyper-V
Syntax
Add-VBRHvCluster -Name <String> -User <String> -Password <String> [-Description <String>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRHvCluster -Name <String> [-Description <String>] Credentials <CCredentials> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds Hyper-V clusters to the Veeam Backup & Replication managing console. If you include your virtual machines in clusters, you need to add the clusters to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console. When you add a cluster, you start managing the VMs that are part of the cluster automatically. When you remove a Hyper-V cluster from Veeam Backup & Replication managing console, the VMs that are part of the cluster are removed too. If you want to manage individual VMs with Veeam Backup & Replication, you need to add them as standalone Hyper-V hosts. Run Add-VBRHvHost to add a standalone Hyper-V host to Veeam Backup & Replication. When adding a new Hyper-V cluster, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. When you provide authentication with the Hyper-V cluster, you get equal rights for all clustered VMs. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with the DNS name of the added HyperV cluster. Specifies the user name you want to use for authenticating with the Hyper-V cluster. If you use the
Required
Position

False

False
Name
True
Named
User
True
Named
False
False
Parameter
Description
Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the Hyper-V cluster.
Required
Position
Password
If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the description of the Hyper-V cluster.
True
Named
False
False
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the credentials you want to use for authenticating with the Hyper-V cluster.
False
Named
False
False
Credentials
True
Named
False
False
Example 1
This command adds a new Hyper-V cluster named "HYPCLUSTER01" using username and password. The user name is "Administrator", and the password is "Password". The description is "Hyper-V Cluster 01". Add-VBRHvCluster -Name "HYPCLUSTER01" -User Administrator Password Password -Description "Hyper-V Cluster 01"
Example 2
This command adds a new Hyper-V cluster named "HYPCLUSTER01" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Hyper-V Cluster 01". Add-VBRHvCluster -Name "HYPCLUSTER01" -Description "Hyper-V Cluster 01" -Credentials $Administrator
Add-VBRHvHost
Short Description
Adds a Hyper-V host to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRHvHost -Name <String> -User <String> -Password <String> [Description <String>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRHvHost -Name <String> [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds Hyper-V host to the Veeam Backup & Replication managing console. You need to add the hosts to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console. If a Hyper-V host is part of a cluster, add the Hyper-V cluster instead of standalone Hyper-V host. Run Add-VBRHvCluster to add a Hyper-V cluster. When adding a new Hyper-V host, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with the DNS name of the added HyperV cluster. Specifies the user name you want to use for authenticating with the Hyper-V cluster. User If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you True Named False False
Required
Position

False

False
Name
True
Named
Password
True
Named
False
False
Parameter
Description
want to use for authenticating with the Hyper-V cluster. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the description of the Hyper-V cluster.
Required
Position
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the credentials you want to use for authenticating with the Hyper-V cluster.
False
Named
False
False
Credentials
True
Named
False
False
Example 1
This command adds a new Hyper-V server named "HyperVExchange" using username and password. The user name is "Administrator", and the password is "Password". The description is "Hyper-V Exchange host". Add-VBRHvHost -Name "HyperVExchange" -User Administrator Password Password -Description "Hyper-V Exchange host"
Example 2
This command adds a new Hyper-V host named "HyperVExchange" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Hyper-V Exchange host". Add-VBRHvHost -Name "HyperVExchange" -Credentials $Administrator -Description "Hyper-V Exchange host"
Add-VBRHvJobObject
Short Description
Adds a new object to a Hyper-V job.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Add-VBRViJobObject.
Syntax
Add-VBRHvJobObject -Job <CBackupJob> -Entities <IHvItem[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob Find-VBRHvEntity
This cmdlet allows to add VM(s) to an existing job. You can run this cmdlet with any kind of jobs. See what else you can perform on job objects
Parameters
Specifies the job(s) you want to add the VM(s) to. You can assign multiple backup jobs to this object. Specifies the VM(s) you want to add to the job. You can assign multiple VMs to this object.
Required
Position
Job
True
Named
False
False
Entities
True
Named
False
Example 1
This command adds a VM named "VM01" to the job represented by $job variable. First the job object is got and assigned to $"Backup Hv Job" variable. The VM object is obtained with Find-VBRHvEntity and piped down. Find-VBRHvEntity -Name VM01 | Add-VBRHvJobObject -Job $"Backup Hv Job"
Example 2
This command adds a VM represented by $Vm variable to the job represented to $"Backup Hv Job" variable. The variables are assigned beforehand. Add-VBRHvJobObject -Job $"Backup Hv Job" -Entities $Vm
Add-VBRHvProxy
Short Description
Adds a Hyper-V backup proxy to Veeam Backup & Replication.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Add-VBRViProxy.
Syntax
Add-VBRHvProxy -Server <CHost> [-Description <String>] [-MaxTasks <Int32>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet adds a Hyper-V backup proxy server to Veeam Backup & Replication managing console. In the backup infrastructure, the backup proxy actually performs main data handling retrieving data, processing it and transferring to the target destination. Use of backup proxies enables you to take the job processing off the backup server and allows for better scalability of your backup infrastructure. See what else you can perform on your virtual proxies When you add a proxy, you set a role to a server. To add a new proxy, you need to have the server added to your Veeam Backup & Replication managing console. Run Add-VBRHvHost to add a Hyper-V server.
Parameters
Server
Specifies the server which will act as a Hyper-V backup proxy. Specifies the description of the Hyper-V proxy.
True
Named
False
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Sets the integer specifying the number of concurrent tasks that can be assigned to the proxy simultaneously. If not set, the number of
False
Named
False
False
MaxTasks
False
Named
False
False
Parameter
Description
tasks will be set to 2 by default.
Required
Position
Example 1
This command adds a new proxy. The server that will act as the proxy is obtained with Get-VBRServer and piped down. The description is "Local Backup Proxy". The max concurrent tasks number is set to 6. Get-VBRServer -Name "HyperV Local Server" | Add-VBRHvProxy Description "Local Backup Proxy" -MaxTasks 6
Example 2
This command adds a new proxy. The server that will act as the proxy is obtained with Get-VBRServer and assigned to the $server variable. The description is "Local Backup Proxy". The max concurrent tasks number is not set to enable the default value. Add-VBRHvProxy -Server $server -Description "Local Backup Proxy"
Add-VBRHvReplicaJob
Short Description
Creates a new Hyper-V replication job.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Add-VBRViReplicaJob.
Syntax
Add-VBRHvReplicaJob [-Name <String>] -Server <CHost> -Entity <IHvItem[]> [-Suffix <String>] [-Description <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRHvReplicaJob [-Name <String>] -Path <CHvDbVolumeItem> Entity <IHvItem[]> [-Suffix <String>] [-Description <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer Find-VBRHvEntity
This cmdlet creates a new Hyper-V replication job. Replication is a process of copying a VM from its primary location (source host) to a destination location (redundant target host). Veeam Backup & Replication creates an exact copy of a VM (replica), registers it on the target host and maintains it in sync with the original VM. Please note that when you create a replica job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job. See what else you can perform on jobs See what else you can perform on replicas
Parameters
Specifies the name you want to assign to the replication job. Specifies the server where the created replica should be stored. Specifies the Hyper-V volume where the created replica should be stored. Specifies the VM(s) that you want to replicate. You can assign multiple VMs to this object. Specifies the suffix that will be appended to the name of the VM you are replicating. This name will be used to register the replicated VM on the target server. Specifies the description of the replication job. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. False Named False False
Required
Position

False

False
Name
False
Named
Server
True
Named
False
False
Path
True
Named
False
False
Entity
True
Named
False
Suffix
False
Named
False
False
Example
This command creates the backup job named "kvm01 Backup". The VM to backup is obtained with Find-VBRHvEntity and piped down. The host to locate the replicated VM on is obtained with GetVBRServer and assigned to the $server variable beforehand. The replicated VM must have the "_replica" suffix. Find-VBRHvEntity -Name kvm01 | Add-VBRHvReplicaJob -Name "kvm01 Backup" -Server $server -Suffix "_replica"
Add-VBRHvScvmm
Short Description
Adds a SCVMM server to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRHvScvmm -Name <String> -User <String> -Password <String> [-Description <String>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRHvScvmm -Name <String> [-Description <String>] Credentials <CCredentials> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds SCVMM (Microsoft System Center Virtual Machine Manager) server to the Veeam Backup & Replication managing console. When adding a new SCVMM server, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on your virtual infrastructure
Parameters
Specifies the string with the DNS name of the added SCVMM server. Specifies the user name you want to use for authenticating with the SCVMM server. User If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the SCVMM server. If you use the Username/Password scenario, True Named False False
Required
Position

False

False
Name
True
Named
Password
True
Named
False
False
Parameter
Description
the -Credentials parameter must be omitted. Specifies the credentials you want to use for authenticating with the SCVMM server.
Required
Position
Credentials
If you use the Credentials scenario, the -User and Password parameters must be omitted. Specifies the description of the SCVMM server.
True
Named
False
False
Description
False
Named
False
False
Example 1
This command adds the SCVMM server using a username and a password. Add-VBRHvScvmm -User "Administrator" -Password "Password" Description "SCVMM Server"
Example 2
This command adds the SCVMM server using credentials. The credentials record is obtained with GetVBRCredentials and assigned to the $"SCVMM Administrator" variable beforehand. Add-VBRHvScvmm -Description "SCVMM Server" -Credentials $"SCVMM Administrator"
Add-VBRJobObject
Short Description
Adds VMs to existing job. Note: In Backup & Replication v6 this cmdlet was replaced by Add-VBRViJobObject and AddVBRHvJobObject due to multihypervisor support introduced in the new version. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.
Applies to
Syntax
Add-VBRJobObject [-Job] <CBackupJob> [-Server] <CHost> [-Objects] <String[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRJobObject [-Job] <CBackupJob> [-Server] <CHost> [Entities] <CEntity[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob Get-VBRServer Find-VBRViEntity
This cmdlet allows you to add VMs or VM containers to existing backup, replication or copy job. See what else you can perform on job objects
Parameters
Specifies the job you want to add VMs to. Specifies the host where the VMs or VM containers you want to add reside. Specifies the string with the name(s) of VM(s) you want to add to the job. You can assign multiple VMs to this object.
Required
Position

False

False
Job
True
Server
True
False
False
Objects
True
False
Parameter
Description
Specifies the VM(s) or VM container(s) you want to add to the job. You can assign multiple VMs to this object.
Required
Position

Entities
True
False
Example 1
This command adds a VM named "vm3" to a job represented by $job variable. The VM is located on the server represented by the $server variable. The job object and the server object are obtained with Get-VBRJob and Get-VBRServer and assigned to the variables accordingly beforehand. Add-VBRJobObject Job $job Server $server Objects vm3
Example 2
This command adds a VM named "vm3" to the job represented by the $job variable. The VM is obtained with Find-VBRViEntity and piped down. The VM is located on the server represented by the $server variable. The job object and the server object are obtained with Get-VBRJob and GetVBRServer and assigned to the variables accordingly beforehand. Find-VBRViEntity -Name "vm3" | Add-VBRJobObject -Job $job -Server $server
Add-VBRLinux
Short Description
Adds a Linux server to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRLinux [-Name] <String> [-SSHUser] <String> [-SSHPassword] <String> [-SSHPort <Int32>] [-Description <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRLinux [-Name] <String> [-SSHPort <Int32>] [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet allows you to add a Linux server to Veeam Backup & Replication. The Linux server must have SSH and Perl. When adding a new Linux server, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with a DNS name or IP address of the Linux server you want to add. Specifies the user name you want to use for authenticating with the Linux server. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you
Required
Position
Name
True
False
False
SSHUser
True
False
False
SSHPassword
True
False
False
Parameter
Description
want to use for authenticating with the Linux server. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the credentials you want to use for authenticating with the Linux server. If you use the Credentials scenario, the -User and Password parameters must be omitted. Provide an integer specifying the Web service port number used to connect to the Linux server console. By default, port 443 is used. Specifies the description of the Linux server.
Required
Position
Credentials
True
Named
False
False
SSHPort
False
Named
False
False
Description
False
Named
False
False
Example 1
This command adds the Linux server with the 172.11.16.13 IP address using a username and a password. The user name is "Administrator" and the password is "Password". Add-VBRLinux -Name 172.11.16.13 -SSHUser "Administrator" SSHPassword "Password" -Description "Linux host 01"
Example 2
This command adds the Linux server with the 172.11.16.13 IP address using credentials. The credentials record is obtained with Get-VBRCredentials and assigned to the $"Linux Administrator" variable beforehand. Add-VBRLinux -Name 172.11.16.13 -Description "Linux host 01" Credentials $"Linux Administrator"
Add-VBRReplicaJob
Short Description
Creates new replication job. Note: In Veeam Backup & Replication v6 this cmdlet was replaced by Add-VBRViReplicaJob and AddVBRHvReplicaJob due to multihypervisor support introduced in the new version. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.
Applies to
Syntax
Add-VBRReplicaJob [-Name] <String> [[-Type] <String>] [-Server] <CHost> [-Datastore] <Datastore> -Objects <String[]> [-Suffix <String>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer Find-VBRViDatastore
This cmdlet allows you to create a new replication job. Replication is a process of copying a VM from its primary location (source host) to a destination location (redundant target host). Veeam Backup & Replication creates an exact copy of a VM (replica), registers it on the target host and maintains it in synch with the original VM. Please note that when you create a replica job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job. See what else you can perform on replicas
Parameters
Specifies the string with the name you want to assign to the replication job. Specifies the string with the type of the created replication job which defines how VM data is retrieved: VDDK Virtual Disk Development Kit (VMware vStorage API) VCB VMware Consolidated Backup (legacy mode) NET Network replication (legacy mode) Server Specifies the host where the created replica should be stored. Specifies the datastore where the created replica should reside. Specifies the string with the name(s) of VM(s) that you want to replicate. You can assign multiple VMs to this object. Specifies the suffix that will be appended to the name of the VM you are replicating. This name will be used to register the replicated VM on the target server. Specifies the description of the replica job. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. False Named False False True 3 False False
Required
Position

False

False
Name
True
Type
False
False
False
Datastore
True
False
False
Objects
True
Named
False
Suffix
False
Named
False
False
Example
This example allows you to create a replication job with the following parameters: Name of a replication job: Replica1 Replication type: VDDK Variable which contains target host DNS name or IP address: $server Variable which contains datastore name: $datastore Replicated VM: vm4
Add-VBRReplicaJob Name Replica1Type VDDK Server $server Datastore $datastore Objects vm4
Add-VBRSmbV3Cluster
Short Description
Adds an SMB3 cluster to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRSmbV3Cluster -Name <String> -User <String> -Password <String> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRSmbV3Cluster -Name <String> [-Description <String>] Credentials <CCredentials> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds an SMB3 cluster to the Veeam Backup & Replication managing console. If you include your virtual machines in clusters, you need to add the clusters to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console. When you add a cluster, you start managing the VMs that are part of the cluster automatically. When you remove a Hyper-V cluster from Veeam Backup & Replication managing console, the VMs that are part of the cluster are removed too. If you want to manage individual VMs with Veeam Backup & Replication, you need to add them as standalone SMB3 servers. Run Add-VBRSmbV3Host to add a standalone SMB3 server to Veeam Backup & Replication. When adding a new SMB3 cluster, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. When you provide authentication with the Hyper-V cluster, you get equal rights for all clustered VMs. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the full DNS name or IP address of the SMB3 cluster. Specifies the user name you want to use for authenticating with the SMB3 cluster. User If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the SMB3 cluster. Password If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the description of the SMB3 cluster. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the credentials you want to use for authenticating with the SMB3 cluster. Credentials If you use the Credentials scenario, the -User and Password parameters must be omitted. True Named False False False Named False False True Named False False True Named False False
Required
Position

False

False
Name
True
Named
Example 1
This command adds a new SMB3 cluster named "SMBCLUSTER01" using username and password. The user name is "Administrator", and the password is "Password". The description is "Hyper-V SMB Share Cluster 01". Add-VBRSmbV3Cluster -Name "SMBCLUSTER01" -User "Administrator" Password "Password" -Description "Hyper-V SMB Share Cluster 01"
Example 2
This command adds a new SMB3 cluster named "SMBCLUSTER01" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Hyper-V SMB Share Cluster 01". Add-VBRHvCluster -Name "SMBCLUSTER01" -Description "Hyper-V SMB Share Cluster 01" -Credentials $Administrator
Add-VBRSmbV3Host
Short Description
Adds an SMB3 host to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRSmbV3Host -Name <String> -User <String> -Password <String> [-Description <String>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRSmbV3Host -Name <String> [-Description <String>] Credentials <CCredentials> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds an SMB3 server to the Veeam Backup & Replication managing console. You need to add the hosts to Veeam Backup & Replication to be able to manage your virtual infrastructure via Veeam Backup & Replication console. If a SMB3 host is part of a cluster, add the SMB3 cluster instead of standalone SMB3 host. Run Add-VBRSmbV3Cluster to add a Hyper-V cluster. When adding a new SMB3 host, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with the DNS name of the added SMB3 host. Specifies the user name you want to use for authenticating with the SMB3 host. User If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you True Named False False
Required
Position

False

False
Name
True
Named
Password
True
Named
False
False
Parameter
Description
want to use for authenticating with the SMB3 host. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the description of the SMB3 host.
Required
Position
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the credentials you want to use for authenticating with the SMB3 host.
False
Named
False
False
Credentials
True
Named
False
False
Example 1
This command adds a new SMB3 host named "SMBShare010" using username and password. The user name is "Administrator", and the password is "Password". The description is "Hyper-V SMB Share Cluster 01". Add-VBRSmbV3Cluster -Name "SMBShare010" -User "Administrator" Password "Password" -Description "Hyper-V SMB Share Host 010"
Example 2
This command adds a new SMB3 host named "SMBShare010" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Hyper-V SMB Share Cluster 01". Add-VBRHvCluster -Name "SMBShare010" -Description "Hyper-V SMB Share Host 010" -Credentials $Administrator
Add-VBRTapeFilesJob
Short Description
Creates a new files to tape copy job.
Applies to
Syntax
Add-VBRTapeFilesJob [-Name <String>] -Server <CHost> -Path <String[]> -MediaPool <MediaPool> [-MediaPoolIncremental <MediaPool>] [-Description <String>] [-Credentials <CCredentials>] [-Masks <String>] [-IgnoreCase] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer Get-VBRTapeMediaPool Get-VBRCredentials
This cmdlet creates a new job copying files from Veeam Backup & Replication to tape. The tape job looks for changes in the specified files that have been made from the moment of the last tape job run. Please note that when you create a copy job, you need to run it manually. Run Start-VBRJob to start the created job. See what else you can perform on tapes
Parameters
Specifies the name you want to assign to the new files to tape copy job. You can input string up to 255 symbols. Server Specifies the source server where the files you need are located. Specifies the path to the folder(s) you need to copy. Use -Masks and IgnoreCase parameters to select particular files. You can specify multiple True Named False False
Required
Position
Name
False
Named
False
False
Path
True
Named
False
Parameter
Description
names separated by commas.
Required
Position
MediaPool
Specifies the target media pool that will be used for full backups. Specifies the target media pool that will be used for incremental backups. Specifies the description for the new files to tape copy job. Specifies the credentials you want to use for authenticating with the source server. Used to specify search conditions for -Path paramater. Specifies masks to select files in folders. Used to specify search conditions for -Path paramater. If set, the search by name will be non case sensitive.
True
Named
False
False
MediaPool Incremental
False
Named
False
False
Description
False
Named
False
False
Credentials
False
Named
False
False
Masks
False
Named
False
False
IgnoreCase
False
Named
False
False
Example 1
This command creates a new files to tape copy job named "Contacts Copy Job". The source server containing the files to be copied is obtained with Get-VBRServer and assigned to the $server variable. The target media pools for full backups and incremental backups are obtained with GetVBRTapeMediaPool and assigned to $full and $increment variables beforehand accordingly. The source file path is D:\Users\UserInfo\Contacts.xls. Add-VBRTapeFilesJob -Name "Contacts Copy Job" -Server $server Path "D:\Users\UserInfo\Contacts.xls" -MediaPool $full MediaPoolIncremental $increment
Example 2
This command creates a new files to tape copy job named "Agreements Copy Job" copying .pdf files from the "Signed" folder. The source server containing the files to be copied is obtained with GetVBRServer and assigned to the $server variable. The target media pools for full backups and incremental backups are obtained with Get-VBRTapeMediaPool and assigned to $full and $increment variables beforehand accordingly. The source file path is D:\Agreements\Signed. The mask for selecting files to copy is ".pdf". Add-VBRTapeFilesJob -Name "Agreements Copy Job" -Server $server Path "D:\Agreements\Signed" -MediaPool $full MediaPoolIncremental $increment -Description "Agreements File Copy Job" -Credentials $Administrator -Masks *.pdf
Add-VBRTapeMediaPool
Short Description
Creates a new media pool.
Applies to
Syntax
Add-VBRTapeMediaPool [-Name <String>] [-Medium <TapeMedium[]>] [Library <TapeLibrary>] [-MoveFromFree] [-Description <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium Get-VBRTapeLibrary
This cmdlet creates a new custom media pool in a tape library. Media pool is a logical group of tapes. Media pools are pre-defined service pools and custom pools used as targets for backup to tape and files to tape jobs. You can assign specific media pools to certain tape jobs. It is recommended to write the full and incremental backups to separate dedicated media pools to achieve better data recoverability. You can select the replenishment strategy for the media pool. You can either choose to always refill the media pool with clean tapes from the Free media pool, or to overwrite the oldest tape recorded. To replenish the media pool, indicate the -MoveFromFree option. See what else you can perform on tapes
Parameters
Specifies the name you want to assign to the media pool. If not set, the media pool name will be set by default. Specifies the tape(s) you want to include to the media pool. You can assign multiple tapes to this object. Library Specifies the tape library where you want to create media pool. False Named
Required
Position
Name
False
Named
False
False
Medium
False
Named
True (ByValue, ByProperty Name) True (ByValue, ByProperty
False
False
Parameter
Description
Required
Position

Name)
Move FromFree
If set, the media pool will be refilled with tapes from Free pool automatically. Otherwise, the job will overwrite the oldest tape when the media pool is out of clean tapes. Specifies the description for the created media pool.
False
Named
False
False
Description
False
Named
False
False
Example 1
This command creates a media pool named "FullBackups". The tapes that should be included in the media pool are obtained with Get-VBRTapeMedium by selecting the first 10 tapes from the Free media pool, and piped down. The library object is obtained with Get-VBRTapeMediaPool and assigned to $lib variable beforehand. The description of the new media pool is "Full backups media pool". The MoveFromFree parameter is not set to enable the overwrite replenishment strategy. Get-VBRTapeMedium -Free | Select -First 10 | Add-VBRTapeMediaPool -Name "FullBackups" -Library $lib -Description "Full backups media pool"
Example 2
This command creates a media pool named FullBackups. The description of the new media pool is "Full backups media pool". First the tape and library objects are got and assigned to $tape and $lib variables accordingly. The -MoveFromFree parameter is set to enable the replenishment of media pool with the clean tapes. Add-VBRTapeMediaPool -Name FullBackups -Medium $tape -Library $lib -MoveFromFree -Description "Full backups media pool"
Add-VBRTapeVMJob
Short Description
Creates a new backup to tape copy job.
Applies to
Syntax
Add-VBRTapeVMJob [-Name <String>] [-Repository <CBackupRepository[]>] [-BackupJob <CBackupJob[]>] -MediaPool <MediaPool> [-MediaPoolIncremental <MediaPool>] [DisableIncremental] [-HardwareCompression] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMediaPool Get-VBRBackupRepository Get-VBRJob
This cmdlet creates a new job that copies VM backups to tape. To be able to create a backup to tape copy job, you need to have existing backups available. You can copy VM backups in two ways: From backup jobs: the tape job looks for backup files that have been produced by the specified backup job from the moment of the last tape job run, From backup repository: the tape job looks for all VM backups that have written to the specified backup repository from the moment of the last tape job run.
Please note that when you create a copy job, you need to run it manually. Run Start-VBRJob to start the created job. See what else you can perform on tapes
Parameters
Specifies the name you want to assign to the VM to tape copy job. Specifies the source backup repository you want to use as the source for the VM backups.
Required
Position

False True (ByValue, ByProperty Name)

False
Name
False
Named
Repository
False
Named
False
Parameter
Description
You can assign multiple backup repositories to this object. Specifies the backup job you want to use as the source for the VM backups. You can assign multiple backup jobs to this object. Specifies the target media pool you want to use for full backups. You can input string up to 255 symbols.
Required
Position
BackupJob
False
Named
False
MediaPool
True
Named
False
False
MediaPool Incremental
Specifies the target media pool you want to use for incremental backups. If set, the tape job will copy only the full backup files. Otherwise, the incremental backups will be written to the media pool set in the MediaPoolIncremental.
False
Named
False
False
Disable Incremental
Please be careful to set this parameter in case you do not want to store the incremental backups on tape. If it is not set, the incremental backups will be written to the media pool you set for the full backups. Enables hardware compression option.
False
Named
False
False
Hardware Compression
Please note that if you plan to use hardware compression when recording backups to tape, consider that although it decreases traffic, this option affects performance. Specifies the description of the new VM to tape copy job.
False
Named
False
False
Description
False
Named
False
False
Example 1
This command creates a job named "CRM Backup Copy to Tape" copying files from the backup job named "CRM Backup" to tape. The backup job is obtained with Get-VBRJob and piped down. The target media pools for full backups and incremental backups are obtained with GetVBRTapeMediaPool and assigned to $full and $increment variables beforehand accordingly. The job description is "CRM Backup Copy to Tape". Get-VBRJob -Name "CRM Backup" | Add-VBRTapeVMJob -Name "CRM Backup Copy to Tape" - MediaPool $full -MediaPoolIncremental $increment -Description "CRM Backup Copy to Tape"
Example 2
This command creates a job named "Local Backup Copy to Tape" copying files from the backup repository named "Local Repository 01" to tape. The backup repository is obtained with GetVBRBackupRepository and piped down. The target media pools for full backups is obtained with GetVBRTapeMediaPool and assigned to $full variable beforehand. The incremental backups are not written to tape. The hardware compression option is enabled. Get-VBRBackupRepository -Name "Local Repository 01" | AddVBRTapeVMJob -Name "Local Backup Copy to Tape" - MediaPool $full -DisableIncremental -HardwareCompression
Example 3
This command creates a job named "Local Backup Copy to Tape" copying files from the backup repository represented by the $repository variable. The backup repository is obtained with GetVBRBackupRepository and assigned to the variable beforehand. The target media pools for full backups is obtained with Get-VBRTapeMediaPool and assigned to $full variable beforehand. The incremental backups are not written to tape. Add-VBRTapeVMJob -Name "Local Backup Copy to Tape" -Repository $repository -MediaPool $full -DisableIncremental
Add-VBRvCenter
Short Description
Adds a vCenter Server to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRvCenter [-Name] <String> [-User] <String> [-Password] <String> [-Port <Int32>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRvCenter [-Name] <String> [-Port <Int32>] [-Description <String>] -Credentials <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet allows you to add a vCenter Server to Veeam Backup & Replication. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with a full DNS name or IP address of the vCenter Server. Specifies the user name you want to use for authenticating with the vCenter server. User Please note that the user name should be in "DOMAIN\USERNAME" format. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the vCenter server. If you use the True 2 False False
Required
Position

False

False
Name
True
Password
True
False
False
Parameter
Description
Username/Password scenario, the -Credentials parameter must be omitted. Specifies the credentials you want to use for authenticating with the vCenter server.
Required
Position
Credentials
If you use the Credentials scenario, the -User and Password parameters must be omitted. Sets the integer specifying the number of Web service port used to connect to the vCenter Server. By default, port 443 is used. Specifies the description of the vCenter server.
True
Named
False
False
Port
False
Named
False
False
Description
False
Named
False
False
Example 1
This command adds the vCenter server named "vcdev25.domain.local" using a username and a password. The user name is "Administrator" and the password is "Password". Add-VBRvCenter -Name "vcdev25.domain.local" -User "Domain\Administrator" -Password "Password" -Description "vcdev25 vCenter Server"
Example 2
This command adds the vCenter server named "vcdev25.domain.local" using credentials. The credentials record is obtained with Get-VBRCredentials and assigned to the $"Linux Administrator" variable beforehand. Add-VBRvCenter -Name "vcdev25.domain.local" -Description "vcdev25 vCenter Server" -Credentials $"vcdev Administrator"
Add-VBRvCloud
Short Description
Adds a vCloud Director server to Veeam Backup & Replication.
Applies to
Version: 7.0 Platform: VMware
Syntax
Add-VBRvCloud [-Name] <string> [-User] <string> [-Password] <string> [-Url <string>] [-Description <string>][<CommonParameters>] -ORAdd-VBRvCloud [-Name] <string> -Credentials <CCredentials> [-Url <string>] [-Description <string>][<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet adds a new vCloud Director server to Veeam Backup & Replication. When adding a new vCloud Director server you will need to provide either username/password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on vCloud
Parameters
Specifies the full DNS name or IP address of the vCloud Director server or any cell in the vCloud Director infrastructure. Specifies the user name you want to use for authenticating with the vCloud Director server. If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the vCloud Director server. If you use the
Required
Position
Name
True
False
False
User
True
False
False
Password
True
False
False
Parameter
Description
Username/Password scenario, the -Credentials parameter must be omitted. Specifies the credentials you want to use for authenticating with the vCloud Director server. If you use the Credentials scenario, the -User and Password parameters must be omitted. Specifies the URL you want to connect to the vCloud Director Web API with. Specifies the description of the new vCloud Director server. If not set, the user name who created the server and the date and time of creation will be added by default.
Required
Position
Credentials
True
Named
False
False
Url
False
Named
False
False
Description
False
Named
False
False
Example 1
This command creates a new server named "vCloud Director Server" having the https://vclouddirectorserver:443 URL address. The username is "Administrator" and the password is "password". Add-VBRvCloud -Name "vCloud Director Server" -User Administrator -Password password -Url https://vclouddirectorserver:443 Description "vCloud Director Server"
Example 2
This command creates a new server named "vCloud Director Server" having the https://vclouddirectorserver:443 URL address. The credentials are obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The -Description parameter is not set to get the default description created. Add-VBRvCloud -Name "vCloud Director Server" -Credentials $Administrator -Url https://vclouddirectorserver:443
Add-VBRvCloudBackupCopyJob
Short Description
Creates a vCloud backup copy job.
Applies to
Syntax
Add-VBRvCloudBackupCopyJob [-Name <String>] [-Entity <IItem[]>] [-Backup <CBackup[]>] [-BackupJob <CBackupJob[]>][-Repository <CBackupRepository>] -SourceAccelerator <CWanAccelerator> TargetAccelerator <CWanAccelerator> [-Description <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRvCloudBackupCopyJob [-Name <String>] [-Entity <IItem[]>] [-Backup <CBackup[]>] [-BackupJob <CBackupJob[]>][-Repository <CBackupRepository>] -DirectOperation [-Description <String>] [WarningAction <ActionPreference>][-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackup Get-VBRJob Get-VBRBackupRepository Get-VBRWANAccelerator
This cmdlet creates a new vCloud backup copy job. The backup copy job is copying backup files from the source backup repository to the target backup repository. The backup copy job runs continuously synchronizing the backup repositories in userdefined time periods. The cmdlet provides two scenarios that can be used for on-site and off-site modes: To transfer the data efficiently to to the off-site location, you can use the WAN accelerator technology. WAN accelerator is a backup infrastructure component that optimizes file transfer via WAN by means of data deduplication. The role of a WAN accelerator can be assigned to a dedicated Windows-based machine (physical or virtual). For best performance you should set a WAN accelerator on both source and target sides. This mode is recommended for off-site backups. To create and run a backup copy job using WAN accelerators you need to have source and target WAN accelerators created. Run Add-VBRWANAccelerator to create a WAN accelerator. You can create a backup copy job using direct operation. With this method, the job sends the data directly to the target backup repository without performing data deduplication. This mode is recommended for on-site backups, or off-site backups using fast connections.
Please note that the backup copy job is created in disabled state. Run Enable-VBRJob to start the job running on the defined schedule. See what else you can perform on vCloud See what else you can perform on backup copy Note: WAN optimization is available only in Veeam Backup & Replication Enterprise Plus Edition.
Parameters
Specifies the name you want to assign to the backup copy job. You can input string up to 255 symbols. Specifies the VM(s) you want to copy. You can assign multiple VMs to this object. Specifies the existing backup from where the VMs to copy are derived. You can assign multiple backups to this object. Specifies the existing backup job from where the VMs to copy are derived. You can assign multiple backup jobs to this object. Specifies the backup repository to where you want to copy the VM data. If not set, Veeam Backup & Replication will use the default backup repository. Specifies the WAN accelerator on the source side. If you select the mode using WAN accelerators, the DirectOperation parameter should be omitted. Specifies the WAN accelerator on the target side. If you select the mode using WAN accelerators, the DirectOperation parameter should be omitted. True Named False False True Named False False True (ByValue, ByProperty Name) True (ByValue, ByProperty Name)
Required
Position
Name
False
Named
False
False
Entity
False
Named
False
Backup
False
Named
False
BackupJob
False
Named
False
Repository
False
Named
False
False
Source Accelerator
Target Accelerator
Parameter
Description
Specifies the description of the backup copy job.
Required
Position
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Enables the direst operation method sending the data directly to the target backup repository without performing data deduplication. If you select the direct operation mode, the TargetAccelerator and SourceAccelerator parameters should be omitted.
False
Named
False
False
Direct Operation
False
Named
False
False
Example 1
This command creates a backup copy job named "vCloud CopyJob1" with the following parameters: The source and target WAN accelerators are obtained with Get-VBRWANAccelerator and assigned to $wansource and $wantarget variables accordingly beforehand, The VMs to copy are obtained with Find-VBRvCloudEntity and assigned to the $vms variable beforehand, The repository to where the VM data will be copied is obtained with GetVBRBackupRepository and assigned to the $repository variable beforehand.
Add-VBRvCloudBackupCopyJob -SourceAccelerator $wansource TargetAccelerator $wantarget -Name CopyJob1 -Entity $vms Repository $repository
Example 2
Get-VBRBackup -Name "DC Backup" | Add-VBRvCloudBackupCopyJob DirectOperation -Name "DC CopyJob"
Add-VBRvCloudJob
Short Description
Creates a vCloud Director backup job.
Applies to
Syntax
Add-VBRvCloudJob -Entity <IItem[]> [-Name <string>] [BackupRepository <CBackupRepository>] [-Description <string>] [<CommonParameters>]
Related Commands
Find-VBRvCloudEntity Get-VBRBackupRepository
This cmdlet creates a new vCloud Director backup job. You should always use vCD backup jobs to back up VMs managed by vCloud Director. If you back up VMs managed by vCloud Director using a regular backup job, Veeam Backup & Replication will perform backup at the level of the underlying vCenter Server and will not capture vApp metadata. As a result, you will not let you restore a fully functioning VM to vCloud Director. Please note that when you create a backup job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job. See what else you can perform on vCloud
Parameters
Specifies the VM(s) you want to backup. You can assign multiple VMs to this object. Specifies the name you want to assign to the backup job.
Required
Position
Entity
True
Named
True
False
Name
False
Named
False
False
Parameter
Description
Required
Position
Backup Repository
Specifies the backup repository object where the backup files will be stored. If not set, the files will be stored in Veeam Backup & Replication default backup repository. Specifies the description of the new backup job.
False
Named
False
False
Description
False
Named
False
False
Example 1
This command creates a new vCloud Director backup job with the following parameters: Job name: "vCD Backup Job 1". $vm: the VM to backup. $brepository: the backup repository to store the backup files. Description: "vCloud Director Backup Job".
Add-VBRvCloudJob -Entity $vm -Name "vCD Backup Job" BackupRepository $brepository -Description "vCloud Director Backup Job"
Example 2
This command creates a new vCloud Director backup job with the following parameters: Job name: "vCD Backup Job 2". Description: "vCloud Director Backup Job". The VM named "vCloud Server" is obtained with Find-VBRvCloudEntity and piped down. The -BackupRepository parameter is not set to enable use of the default backup repository.
Find-VBRvCloudEntity -Name "vCloud Server" | Add-VBRvCloudJob Name "vCD Backup Job 2" -Description "vCloud Director Backup Job"
Add-VBRvCloudVC
Short Description
Adds vCenter Server managed by vCloud Director to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRvCloudVC [-vCloudServer] <CHost> [-VCInfo] <CVcdVcInfo> [User] <string> [-Password] <string> [-Name <string>] [-Port <int>] [-Description <string>] [<CommonParameters>] -ORAdd-VBRvCloudVC [-vCloudServer] <CHost> [-VCInfo] <CVcdVcInfo> Credentials <CCredentials> [-Name <string>] [-Port <int>] [Description <string>] [<CommonParameters>]
Related Commands
Get-VBRServer Find-VBRvCloudEntity Get-VBRCredentials
This cmdlet adds a new vCenter server to Veeam Backup & Replication console. The vCenter server is registered as a part of vCloud Director . When adding a new vCenter server, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on vCloud
Parameters
vCloudServer
Specifies the vCloud server you want to connect a vCenter to. Specifies the vCenter server you want to connect to the vCloud. Specifies the user name you want to use for authenticating with the vCenter server. If you use the Username/Password
True
False
VCInfo
True
False
User
True
False
False
Parameter
Description
scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the vCenter server.
Required
Position
Password
If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the credentials you want to use for authenticating with the vCenter server. If you use the Credentials scenario, the -User and Password parameters must be omitted. Specifies the DNS name or IP address of the vCenter server you want to connect. Specifies the web-service port number. If not set, the default port number 443 will be used.
True
False
False
Credentials
True
Named
False
False
Name
False
Named
False
False
Port
IMPORTANT: When you customize the port number, you should make sure that you set this port on the vCenter Server/ESX(i) host settings first. Specifies the description of the vCenter server. If not set, the default description containing the username of the user who created the record and date and time of creation will be used.
False
Named
False
False
Description
False
Named
False
False
Example 1
This command adds a new vCenter server with the following parameters: The vCenter will be registered on the server with 172.16.1.13 IP address. The server object is piped to the cmdlet. The $vc variable contains the new vCenter server object. The username is "Administrator" and the password is "Password". The new vCenter name is "vCenter Server 1". The -Port parameter is not set to enable the default 443 web-service port number. The -Description parameter is not set to enable the default description.
Get-VBRServer -Name 172.16.1.13 | Add-VBRvCloudVC -VCInfo $vc User Administrator -Password Password -Name "vCenter Server 1"
Example 2
This command adds a new vCenter server with the following parameters: The server where the new vCenter will be registered is represented by $s variable. The $vc variable contains the new vCenter server object. The $creds variable contains the Administrator credentials record. The new vCenter name is "vCenter Server 2". The -Port parameter is set to 456 to set the connection through web-service port number 456 instead of default 443 port. The -Description parameter is not set to enable the default description.
Add-VBRvCloudVC -vCloudServer $s -VCInfo $vc -Credentials $creds -Name "vCenter Server 2" -Port 456
Add-VBRViBackupCopyJob
Short Description
Creates a VMware backup copy job.
Applies to
Version: 7.0 Platform: VMware For Hyper-V. run Add-VBRHvBackupCopyJob.
Syntax
Add-VBRViBackupCopyJob -SourceAccelerator <CWanAccelerator> TargetAccelerator <CWanAccelerator> [-Name <string>][-Entity <IViItem[]>] [-Backup <CBackup[]>][-BackupJob <CBackupJob[]>] [Repository <CBackupRepository>][-Description <string>][<CommonParameters>] -ORAdd-VBRViBackupCopyJob -DirectOperation [-Name <string>] [-Entity <IViItem[]>] [-Backup <CBackup[]>] [-BackupJob <CBackupJob[]>] [Repository <CBackupRepository>] [-Description <string>] [<CommonParameters>]
Related Commands
Get-VBRWANAccelerator Find-VBRViEntity Get-VBRBackup Get-VBRJob Get-VBRBackupRepository
This cmdlet creates a new VMware backup copy job. The backup copy job is copying backup files from the source backup repository to the target backup repository. The backup copy job runs continuously synchronizing the backup repositories in userdefined time periods. The cmdlet provides two scenarios that can be used for on-site and off-site modes: To transfer the data efficiently to to the off-site location, you can use the WAN accelerator technology. WAN accelerator is a backup infrastructure component that optimizes file transfer via WAN by means of data deduplication. The role of a WAN accelerator can be assigned to a dedicated Windows-based machine (physical or virtual). For best performance you should set a WAN accelerator on both source and target sides. This mode is recommended for off-site backups. To create and run a backup copy job using WAN accelerators you need to have source and target WAN accelerators created. Run Add-VBRWANAccelerator to create a WAN accelerator. You can create a backup copy job using direct operation. With this method, the job sends the data directly to the target backup repository without performing data deduplication. This mode is recommended for on-site backups, or off-site backups using fast connections.
Please note that the backup copy job is created in disabled state. Run Enable-VBRJob to start the job running on the defined schedule. See what else you can perform on backup copy Note: WAN optimization is available only in Veeam Backup & Replication Enterprise Plus Edition.
Parameters
Specifies the WAN accelerator on the source side. If you select the mode using WAN accelerators, the DirectOperation parameter should be omitted. Specifies the WAN accelerator on the target side. If you select the mode using WAN accelerators, the DirectOperation parameter should be omitted. Enables direst operation method sending the data directly to the target backup repository without performing data deduplication. If you select the direct operation mode, the TargetAccelerator and SourceAccelerator parameters should be omitted. Specifies the name you want to assign to the backup copy job. You can input string up to 255 symbols. Specifies the VM you want to copy. You can assign multiple VMs to this object. Specifies the existing backup(s) to set the VMs you want to copy. You can assign multiple backups to this object. BackupJob Specifies the existing backup job(s) to set the VMs you False Named True Named False False True Named False False
Required
Position
Source Accelerator
Target Accelerator
Direct Operation
True
Named
False
False
Name
False
Named
True (ByValue, ByProperty Name) True (ByValue, ByProperty Name) True (ByValue, ByProperty Name) True (ByValue,
False
Entity
False
Named
False
Backup
False
Named
False
False
Parameter
Description
want to copy. You can assign multiple backup jobs to this object. Specifies the backup repository to where you want to copy the VM data. If not set, Veeam Backup & Replication will use the default backup repository. Specifies the description of the backup copy job.
Required
Position

ByProperty Name)
Repository
False
Named
False
False
Description
False
Named
False
False
Example 1
This command creates a backup copy job named "CopyJob1" with the following parameters: The source and target WAN accelerators are obtained with Get-VBRWANAccelerator and assigned to $wansource and $wantarget variables accordingly beforehand, The VMs to copy are obtained with Find-VBRViEntity and assigned to the $vms variable beforehand, The repository to where the VM data will be copied is obtained with GetVBRBackupRepository and assigned to the $repository variable beforehand.
Add-VBRViBackupCopyJob -SourceAccelerator $wansource TargetAccelerator $wantarget -Name CopyJob1 -Entity $vms Repository $repository
Example 2
Get-VBRBackup -Name "DC Backup" | Add-VBRViBackupCopyJob DirectOperation -Name "DC CopyJob"
Add-VBRViBackupJob
Short Description
Creates VMware backup job.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Add-VBRHvBackupJob.
Syntax
Add-VBRViBackupJob [-Name <String>] [-BackupRepository <CBackupRepository>] -Entity <IViItem[]> [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository Find-VBRViEntity
This cmdlet allows you to create a new VMware backup job. Please note that when you create a backup job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job. See what else you can perform on jobs
Parameters
Specifies the string with the name of the created backup job. Specifies the backup repository where the created backup should be stored. Specifies the VM(s) that you want to back up. You can assign multiple VMs to this object. Specifies the description of the backup job. If not set, Veeam Backup &
Required
Position

False

False
Name
False
Named
Backup Repository
False
Named
False
False
Entity
True
Named
False
Description
False
Named
False
False
Parameter
Description
Replication will enter date and time of creation by default.
Required
Position
Example
This command creates a backup job named "Exchange Backup". The VMs to backup are obtained with Find-VBRViEntity and piped down. The backup repository is obtained with Get-VBRBackupRepository and assigned to the $Repository variable beforehand. the description is "VMware Exchange Backup". Find-VBRViEntity -Name Exchange* | Add-VBRHvBackupJob -Name "Exchange Backup" -BackupRepository $Repository -Description "VMware Exchange Backup"
Add-VBRViJobObject
Short Description
Adds a VM to a job.
Applies to
Version: 7.0 Platform: VMware For Hyper-V, run Add-VBRHvJobObject.
Syntax
Add-VBRViJobObject -Job <CBackupJob> -Entities <IViItem[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob Find-VBRViEntity
This cmdlet allows to add VM(s) to an existing job. You can run this cmdlet with any kind of jobs. See what else you can perform on job objects
Parameters
Specifies the job you want to add the VM(s) to. You can assign multiple backup jobs to this object. Specifies the vM(s) you want to add to the job. You can assign multiple VMs to this object.
Required
Position
Job
True
Named
False
False
Entities
True
Named
False
Example 1
This command adds a VM named "VM01" to the job represented by $job variable. First the job object is got and assigned to $job variable.The VM object is piped down. Find-VBRViEntity -Name VM01 | Add-VBRHvJobObject -Job $job
Example 2
This command adds a VM represented by $Vm variable to the job represented to $job variable. The variables are assigned beforehand. Add-VBRViJobObject -Job $job -Entities $Vm
Add-VBRViProxy
Short Description
Adds a VMware backup proxy to Veeam Backup & Replication.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Add-VBRHvProxy.
Syntax
Add-VBRViProxy -Server <CHost> [-Description <String>] [-MaxTasks <Int32>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet adds a VMware backup proxy server to Veeam Backup & Replication managing console. In the backup infrastructure, the backup proxy actually performs main data handling retrieving data, processing it and transferring to the target destination. Use of backup proxies enables you to take the job processing off the backup server and allows for better scalability of your backup infrastructure. See what else you can perform on your virtual proxies When you add a proxy, you set a role to a server. To add a new proxy, you need to have the server added to your Veeam Backup & Replication managing console. Run Add-VBRESX or Add-VBRESXi to add a VMware server.
Parameters
Server
Specifies the server which will act as a VMware backup proxy. Specifies the description of the VMware proxy.
True
Named
False
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Sets the integer specifying the number of concurrent tasks that can be assigned to the proxy simultaneously. If not set, the number of
False
Named
False
False
MaxTasks
False
Named
False
False
Parameter
Description
tasks will be set to 2 by default.
Required
Position
Example 1
This command adds a new proxy. The server that will act as the proxy is obtained with Get-VBRServer and piped down. The description is "Local Backup Proxy". The max concurrent tasks number is set to 6. Get-VBRServer -Name "VMware Local Server" | Add-VBRViProxy Description "Local Backup Proxy" -MaxTasks 6
Example 2
This command adds a new proxy. The server that will act as the proxy is obtained with Get-VBRServer and assigned to the $server variable. The description is "Local Backup Proxy". The max concurrent tasks number is not set to enable the default value. Add-VBRViProxy -Server $server -Description "Local Backup Proxy"
Add-VBRViReplicaJob
Short Description
Adds new VMware replication job.
Applies to
Version: Platform: VMware For Hyper-V, run Add-VBRHvReplicaJob.
Syntax
Add-VBRViReplicaJob [-Name <String>] -Server <CHost> -Entity <IViItem[]> [-Datastore <CViDatastoreItem>][-ResourcePool <CViResourcePoolItem>] [-Folder <CViFolderItem>] [-Suffix <String>] [-BackupRepository <CBackupRepository>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob Find-VBRViEntity Find-VBRViDatastore Find-VBRViResourcePool Find-VBRViFolder Get-VBRBackupRepository
This cmdlet allows you to create a new VMware replication job. Replication is a process of copying a VM from its primary location (source host) to a destination location (redundant target host). Veeam Backup & Replication creates an exact copy of a VM (replica), registers it on the target host and maintains it in synch with the original VM. Please note that when you create a replica job, you need to run it manually unless you enable a job schedule. Run Start-VBRJob to start the created job. Run Set-VBRJobSchedule to set schedule for the job. See what else you can perform on jobs See what else you can perform on replicas
Parameters
Specifies the string with the name of the created replication job. Specifies the host where the created replica should be stored. Specifies the VM(s) that you want to replicate. You can assign multiple VMs to this object. Specifies the datastore to which you want to replicate. Specifies the resource pool to which you want to replicate. Specifies the folder to which you want to replicate. Specifies the suffix that will be appended to the name of the VM you are replicating. This name will be used to register the replicated VM on the target server. Specifies the backup repository which will be used to store replica metadata files. Specifies the description of the new job. Description If not set, Veeam Backup & Replication will enter date and time of creation by default. False Named False False
Required
Position

False

False
Name
False
Named
Server
True
Named
False
False
Entity
True
Named
False
Datastore
False
Named
False
False
ResourcePool
False
Named
False
False
Folder
False
Named
False
False
Suffix
False
Named
False
False
Backup Repository
False
Named
False
False
Example 1
This command adds a new job named "DC Replication Job" replicating a VM named "DC". The VM to replicate is obtained with Find-VBRViEntity and piped down. The server and the resource pool to locate the replica are obtained with Get-VBRServer and Find-VBRViResourcePool and assigned to the $server and $pool variables accorgingly beforehand. The replica is created with the suffix "_replica". The description of the job is "DC Replication Job". Find-VBRViEntity -Name "DC" | Add-VBRViReplicaJob -Name "DC Replication Job" -Server $server -ResourcePool $pool -Suffix "_replica"
Example 2
This command adds a new job named "DC Replication Job" replicating a VM represented by the $vm variable. The VM to replicate is obtained with Find-VBRViEntity and assigned to the variable beforehand. The server where the replica will reside is obtained with Get-VBRServer and assigned to the $server variable beforehand. The datastore and the resource pool to locate the replica are obtained with Find-VBRViDatastore and Find-VBRViResourcePool and assigned to the $datastore and $pool variables accorgingly beforehand. The replica is created with the suffix "_replica". The description of the job is "DC Replication Job". Add-VBRViReplicaJob -Name "DC Replication Job" -Server $server Entity $vm -Datastore $datastore -ResourcePool $pool -Suffix "_replica" -Description "DC Replication Job"
Add-VBRWANAccelerator
Short Description
Creates a new WAN accelerator.
Applies to
Version: 7.0 Platform: VMware, Hyper-V Note: WAN optimization is available only in Veeam Backup & Replication Enterprise Plus Edition.
Syntax
Add-VBRWANAccelerator -Server <CHost> [-Description <String>] [CachePath <String>] [-CacheSize <UInt32>] [-CacheSizeUnit <ESizeUnit>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet creates a new WAN accelerator. WAN accelerator is an architecture component that optimizes file transfer via WAN by means of data deduplication. The role of a WAN accelerator can be assigned to a dedicated Windows-based machine (physical or virtual). For best performance you should set a WAN accelerator on both source and target sides. See what else you can perform on backup copy
Parameters
Specifies the server where WAN accelerator will be created. Please note that you can create WAN accelerator on Microsoft Windows servers only. Specifies the description of the WAN accelerator. Specifies the path to the folder where WAN accelerator will be created. Specifies the cache folder capacity value in UInt32 format. Accepted values: 1 to 65535.
Required
Position

Server
True
Named
False
Description
False
Named
False
False
CachePath
False
Named
False
False
CacheSize
False
Named
False
False
Parameter
Description
Specifies the measure unit for the cache folder capacity. The valid values are GB and TB.
Required
Position
CacheSize Unit
False
Named
False
False
Example
This command creates a new WAN accelerator with the following parameters: The $s variable contains the server where the WAN accelerator will be created. The description of the new WAN accelerator is "BackupWANAccelerator". The -CachePath parameter sets the folder where the new WAN accelerator will be created. The cache size capacity is set to 100GB.
Add-VBRWANAccelerator -Server $s -Description BackupWANAccelerator -CachePath "c:\wan" -CacheSize 100 CacheSizeUnit GB
Add-VBRWinServer
Short Description
Adds Windows server to Veeam Backup & Replication.
Applies to
Syntax
Add-VBRWinServer -Name <String> -User <String> -Password <String> [-Description <String>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORAdd-VBRWinServer -Name <String> [-Description <String>] Credentials <CCredentials> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet allows you to add a Windows server to Veeam Backup & Replication managing console. When adding a new Windows server, you will need to provide either username and password or credentials. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on your virtual infrastructure instances
Parameters
Specifies the string with the DNS name of the Windows server you want to add. Specifies the user name you want to use for authenticating with the Windows server. User If you use the Username/Password scenario, the -Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the Windows server. If you use the Username/Password scenario, the -Credentials parameter True Named False False
Required
Position

False

False
Name
True
Named
Password
True
Named
False
False
Parameter
Description
must be omitted. Specifies the description of the Windows server.
Required
Position
Description
If not set, Veeam Backup & Replication will enter date and time of creation by default. Specifies the credentials you want to use for authenticating with the Windows server.
False
Named
False
False
Credentials
True
Named
False
False
Example 1
This command adds a new Windows server named "WinServer" using username and password. The user name is "Administrator", and the password is "Password". The description is "Windows File Server". Add-VBRWinServer -Name "WinServer" -User Administrator -Password Password -Description "Windows File Server"
Example 2
This command adds a new Windows server named "WinServer" using credentials. The credentials object is obtained with Get-VBRCredentials and assigned to the $Administrator variable beforehand. The description is "Windows File Server". Add-VBRWinServer -Name "WinServer" -Credentials $Administrator Description "Windows File Server"
Add-VSBApplicationGroup
Short Description
Creates a VMware application group for SureBackup job. Note: In Backup & Replication v6 this cmdlet was replaced by Add-VSBViApplicationGroup and AddVSBHvApplicationGroup due to multihypervisor support introduced in the new version. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.
Applies to
Syntax
Add-VSBApplicationGroup [-Name] <String> [-Vm] <CVm[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORAdd-VSBApplicationGroup [-Name] <String> [-RestorePoint] <COib[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet creates a new VMware application group. An application group is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The VMs in the application group are started first to ensure the proper testing environment for the primary VM. Please note that you can set the order the VMs in the application group will be powered on when the SureBackup job starts. This may be important if any of the applications must be started prior to other. The VMs are powered in the order they were added to the VM object in this cmdlet. See what else you can perform on SureBackup
Parameters
Specifies the string with the name you want to assign to the application group. Specifies the VM(s) you want to include into the application group. You can assign multiple VMs to this object. Specifies the restore points of VMs that should be added to the application group. You can assign multiple restore points to this object.
Required
Position

False

False
Name
True
Vm
True
False
RestorePoint
True
False
Example
This example allows you to create an application group with the following parameters: Application group name: AppGroup Variable which contains objects of VMs to be added to the group: $vms
Add-VSBApplicationGroup Name AppGroupVM $vms
Add-VSBHvApplicationGroup
Short Description
Creates a Hyper-V application group for SureBackup job.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Add-VSBViApplicationGroup.
Syntax
Add-VSBHvApplicationGroup [-Name <String>] [-VmFromBackup <CHvVmItem[]>] [-RestorePoint <COib[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]>]
Related Commands
Find-VBRHvEntity Get-VBRRestorePoint
This cmdlet creates a new Hyper-V application group. An application group is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The VMs in the application group are started first to ensure the proper testing environment. Please note that you can set the order the VMs in the application group will be powered on when the SureBackup job starts. This may be important if any of the applications must be started prior to other. The VMs are powered in the order they were added to the VM object in this cmdlet, i.e. in order you searched for VMs with Find-VBRHvEntity. This cmdlet provides two scenarios. You can add VMs to your application group either by searching for existing VMs or by adding a restore point containing the VMs you need. Run Add-VSBHvVirtualLab to create a virtual lab. Run Add-VSBHvJob to create a SureBackup Job. See what else you can perform on SureBackup
Parameters
Specifies the name you want to assign to the application group. Specifies the VM(s) you want to add to the application group. You can assign multiple VMs to this object. Specifies the restore points of the VMs you want to add to the application group. You can assign multiple restore points to this object.
Required
Position

False

False
Name
False
Named
VmFrom Backup
True
Named
False
RestorePoint
True
Named
False
Example 1
This command creates a new application group named "Exchange Appgroup".The VMs that should be included into the application group are obtained with Find-VBRHvEntity and piped down. The VMs are obtained in the order they must boot when the SureBackup job starts. Find-VBRHvEntity -Name "DC", "DNSServer" | AddVSBHvApplicationGroup -Name "Exchange Appgroup"
Example 2
This command creates a new application group "MailServer Appgroup". The restore point object is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. Add-VSBHvApplicationGroup -Name "MailServer Appgroup" RestorePoint $restorepoint
Add-VSBHvJob
Short Description
Creates a Hyper-V SureBackup job.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Add-VSBJob.
Syntax
Add-VSBHvJob [-Name <String>] -VirtualLab <CHvSbVirtualLab> [AppGroup <CSbAppGroup>] [-LinkedJob <CBackupJob[]>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBHvVirtualLab Get-VSBApplicationGroup Get-VBRJob
This cmdlet adds a new Hyper-V SureBackup job. SureBackup is a Veeam recovery verification technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The VMs in the application group are started first to ensure the proper testing environment. Run Add-VSBHvVirtualLab to create a virtual lab. Run Add-VSBHvApplicationGroup to create an application group. You can use a linked job to bring the target VM(s) to the job, or an application group containing the required VMs, or a combination of both according to your virtual infrastructure objectives: If you need to verify several different VMs in same environment: create an application group that can be reused by several SureBackup jobs, providing a multi-use copy of the production environment. In this case, use the linked job to create a SureBackup job for each VM or a group of VMs that you want to verify. If you need to verify only one VM or one group of VMs, or if each VM to verify requires its own environment: include the VM(s) you want to verify right into the application group. Within the application group, you can set the VM startup order, see AddVSBHvApplicationGroup for details. If the VMs you want to verify do not require any specific environment: select the VM(s) to verify with the linked job, and indicate the virtual lab to use for verification. You do not need to create an application group in this case.
Please note that when you create a SureBackup job, you need to run it manually unless you enable a job schedule.
Run Start-VSBJob to start the created SureBackup job. Run Set-VSBJobScheduleOptions to set schedule for the SureBackup job. See what else you can perform on SureBackup See what else you can perform on jobs
Parameters
Specifies the name you want to assign to the Sure Backup job. Specifies the virtual lab you want to use for verification. Specifies the application group you want to use to provide the copy of the production environment of the verified VM. If you do not use an application group, make sure that the -LinkedJob parameter is set. Specifies the backup, replication or copy job containing the VM you want to verify. LinkedJob If you do not use a linked backup job, make sure that the -AppGroup parameter is set. You can assign multiple backup jobs to this object. Description Specifies the description of the new SureBackup job. False Named False False False Named
Required
Position


False
Name
False
Named
VirtualLab
True
Named
False
AppGroup
False
Named
False
False
Example 1
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The VM to verify is obtained by searching for the backup job named "Exchange Backup Job" with Get-VBRJob, and piped down. The virtual lab and the application group objects are obtained with Get-VSBHvVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $"Exchange Appgroup" variables accordingly beforehand. Get-VBRJob -Name "Exchange Backup Job" | Add-VSBHvJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $"Exchange Appgroup"
Example 2
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The virtual lab and application group objects are obtained with Get-VSBHvVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $"Exchange Appgroup" variables accordingly beforehand. Add-VSBHvJob -Name "Exchange SureJob" -VirtualLab $VLab01 AppGroup $"Exchange Appgroup"
Example 3
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and an application group. The virtual lab object is obtained with Get-VSBHvVirtualLab and piped down. The VM to verify is included into the application group, the application group object is obtained with GetVSBApplicationGroup and assigned to the $"Exchange Appgroup" variable beforehand. Get-VSBHvVirtualLab -Name "Exchange VLab 01" | Add-VSBHvJob -Name "Exchange SureJob" -AppGroup $"Exchange Appgroup"
Example 4
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and a linked job. The virtual lab object is obtained with Get-VSBHvVirtualLab and assigned to $VLab01 variable beforehand. The VM to verify is obtained with Get-VBRJob and assigned to the $"Exchange Backup" variable beforehand. Add-VSBHvJob -Name "Exchange SureJob" -VirtualLab $VLab01 LinkedJob $"Exchange Backup"
Add-VSBHvVirtualLab
Short Description
Creates a Hyper-V virtual lab.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Add-VSBVirtualLab.
Syntax
Add-VSBHvVirtualLab -Name <String> -Server <CHost> -Folder <String> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet creates a new Hyper-V virtual lab. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. Run Add-VSBHvApplicationGroup to create an application group. Run Add-VSBHvJob to create a SureBackup job. See what else you can perform on SureBackup
Parameters
Specifies the name you want to assign to the virtual lab. Specifies the Hyper-V host where the virtual lab should be created. Specifies the path to the folder where the redo log files of the virtual lab will be stored.
Required
Position

False

False
Name
True
Named
Server
True
Named
False
False
Folder
True
Named
False
False
Example
This command creates a new virtual lab named "Exchange VLab 01". The server where the virtual lab will be located is obtained with Get-VBRServer and assigned to the $server variable beforehand. The folder path to store the redo files is c:\VirtualLabs. Add-VSBHvVirtualLab -Name "Exchange VLab 01" -Server $server Folder "c:\VirtualLabs"
Add-VSBJob
Short Description
Creates a VMware SureBackup job.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Add-VSBHvJob.
Syntax
Add-VSBJob [[-Name] <String>] -VirtualLab <CViSbVirtualLab> [AppGroup <CSbAppGroup>] [-LinkedJob <CBackupJob[]>] [-Description <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBVirtualLab Get-VSBApplicationGroup Get-VBRJob
This cmdlet creates a new VMware SureBackup job. SureBackup is a Veeam recovery verification technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The VMs in the application group are started first to ensure the proper testing environment. Run Add-VSBVirtualLab to create a virtual lab. Run Add-VSBViApplicationGroup to create an application group. You can use a linked job to bring the target VM(s) to the job, or an application group containing the required VMs, or a combination of both according to your virtual infrastructure objectives: If you need to verify several different VMs in same environment: create an application group that can be reused by several SureBackup jobs, providing a multi-use copy of the production environment. In this case, use the linked job to create a SureBackup job for each VM or a group of VMs that you want to verify. If you need to verify only one VM or one group of VMs, or if each VM to verify requires its own environment: include the VM(s) you want to verify right into the application group. Within the application group, you can set the VM startup order, see AddVSBViApplicationGroup for details. If the VMs you want to verify do not require any specific environment: select the VM(s) to verify with the linked job, and indicate the virtual lab to use for verification. You do not need to create an application group in this case.
Please note that when you create a SureBackup job, you need to run it manually unless you enable a job schedule.
Run Start-VSBJob to start the created SureBackup job. Run Set-VSBJobScheduleOptions to set schedule for the SureBackup job. See what else you can perform on SureBackup See what else you can perform on jobs
Parameters
Specifies the name you want to assign to the SureBackup job. Specifies the virtual lab you want to use for verification. Specifies the application group you want to use to provide the copy of the production environment of the verified VM. If you do not use an application group, make sure that the -LinkedJob parameter is set. Specifies the backup, replication or copy job containing the VM you want to verify. LinkedJob If you do not use a linked backup job, make sure that the -AppGroup parameter is set. You can assign multiple backup jobs to this object. Description Specifies the description of the new SureBackup job. False Named False False False Named
Required
Position


False
Name
False
Named
VirtualLab
True
Named
False
AppGroup
False
Named
False
False
Example 1
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The VM to verify is obtained by searching for the backup job named "Exchange Backup Job" with Get-VBRJob, and piped down. The virtual lab and the application group objects are obtained with Get-VSBVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $"Exchange Appgroup" variables accordingly beforehand. Get-VBRJob -Name "Exchange Backup Job" | Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $"Exchange Appgroup"
Example 2
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab, an application group and a linked job. The virtual lab and application group objects are obtained with Get-VSBVirtualLab and Get-VSBApplicationGroup and assigned to $VLab01 and $"Exchange Appgroup" variables accordingly beforehand. Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 -AppGroup $"Exchange Appgroup"
Example 3
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and an application group. The virtual lab object is obtained with Get-VSBVirtualLab and piped down. The VM to verify is included into the application group, the application group object is obtained with GetVSBApplicationGroup and assigned to the $"Exchange Appgroup" variable beforehand. Get-VSBVirtualLab -Name "Exchange VLab 01" | Add-VSBJob -Name "Exchange SureJob" -AppGroup $"Exchange Appgroup"
Example 4
This command creates a new Sure Backup job named "Exchange SureJob" using a virtual lab and a linked job. The virtual lab object is obtained with Get-VSBVirtualLab and assigned to $VLab01 variable beforehand. The VM to verify is obtained with Get-VBRJob and assigned to the $"Exchange Backup" variable beforehand. Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 LinkedJob $"Exchange Backup"
Add-VSBViApplicationGroup
Short Description
Creates an application group for SureBackup job.
Applies to
Version: 7.0 Platform: VMware For Hyper-V, run Add-VSBHvApplicationGroup.
Syntax
Add-VSBViApplicationGroup -Name <String> -Vm <CViVmItem[]> [WarningAction <ActionPreference>][-WarningVariable <String>] [<CommonParameters>] -ORAdd-VSBViApplicationGroup -Name <String> -RestorePoint <COib[]> [-WarningAction <ActionPreference>][-WarningVariable <String>] [<CommonParameters>]
Related Commands
Find-VBRViEntity Get-VBRRestorePoint
This cmdlet returnes a new application group containing virtual machines that the application server is dependent on. An application group is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The VMs in the application group are started first to ensure the proper testing environment. Please note that you can set the order the VMs in the application group will be powered on when the SureBackup job starts. This may be important if any of the applications must be started prior to other. The VMs are powered in the order they were added to the VM object in this cmdlet, i.e. in order you searched for VMs with Find-VBRViEntity. This cmdlet provides two scenarios. You can add VMs to your application group either by searching for existing VMs or by adding a restore point containing the VMs you need. Run Add-VSBVirtualLab to create a virtual lab. Run Add-VSBJob to create a SureBackup Job. See what else you can perform on SureBackup
Parameters
Specifies the name you want to assign to the application group. Specifies the VM(s) you want to add to the application group. You can assign multiple VMs to this object. Specifies the restore points of the VMs you want to add to the application group. You can assign multiple restore points to this object.
Required
Position

False

False
Name
False
Named
Vm
True
Named
False
RestorePoint
True
Named
False
Example 1
This command creates a new application group named "Exchange Appgroup". The VMs that should be included into the application group are obtained with Find-VBRViEntity and piped down. The VMs are obtained in the order they must boot when the SureBackup job starts. Find-VBRViEntity -Name "DC", "DNSServer" | AddVSBHvApplicationGroup -Name "Exchange Appgroup"
Example 2
This command creates a new application group "MailServer Appgroup". The restore point object is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. Add-VSBViApplicationGroup -Name "MailServer Appgroup" RestorePoint $restorepoint
Add-VSBVirtualLab
Short Description
Creates a VMware virtual lab.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Add-VSBHvVirtualLab.
Syntax
Add-VSBVirtualLab [-Name] <String> [-Server] <CHost> [-Datastore] <CViDatastoreItem> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer Find-VBRViDatastore
This cmdlet creates a new VMware virtual lab. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. Run Add-VSBViApplicationGroup to create an application group. Run Add-VSBJob to create a SureBackup job. See what else you can perform on SureBackup
Parameters
Specifies the string with the name you want to assign to the virtual lab. Specifies the ESX(i) host where the virtual lab should be created. Specifies the datastore on which redo logs for tested VMs should be stored.
Required
Position

False

False
Name
True
Server
True
False
False
Datastore
True
False
False
Example
This command creates a new virtual lab named "Exchange VLab 01". The server where the virtual lab will be located is obtained with Get-VBRServer and assigned to the $server variable beforehand. The datastore to store the redo files is obtained with Find-VBRViDatastore and assigned to the $datastore variable beforehand. Add-VSBVirtualLab -Name "Exchange VLab 01" -Server $server Datastore $datastore
Clear-VBRWANCache
Short Description
Removes data from WAN accelerator global cache.
Applies to
Syntax
Clear-VBRWANCache -Accelerator <CWanAccelerator> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRWANAccelerator
This cmdlet clears WAN accelerator global cache. You may need to clear the global cache in case, i.e., the data gets corrupted.
Parameters
Accelerator
Specifies the WAN accelerator you want to clear the cache of.
True
Named
False
Example 1
This command clears cache of WAN accelerator named "WAN 01". The accelerator is obtained with Get-VBRWANAccelerator and piped down. Get-VBRWANAccelerator -Name "WAN 01" | Clear-VBRWANCache
Example 2
This command clears cache of the WAN accelerator represented by the $"accelerator01" variable. The accelerator is obtained with Get-VBRWANAccelerator and assigned to the variable beforehand. Clear-VBRWANCache -Accelerator $"accelerator01"
Connect-VSBHvVirtualLab
Short Description
Connects an existing Hyper-V virtual lab.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Connect-VSBVirtualLab.
Syntax
Connect-VSBHvVirtualLab [-VirtualLab] <CHvLabShortInfo> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Find-VSBHvVirtualLab
This cmdlet connects an existing Hyper-V virtual lab to Veeam Backup & Replication console. When you add a new host to your Veeam Backup & Replication console, the virtual labs that are registered on it are not added automatically. Use this cmdlet to add the virtual labs to your Veeam Backup & Replication console. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. See what else you can perform on SureBackup
Parameters
Specifies the virtual lab you want to connect to your Veeam Backup & Replication console.
Required
Position

VirtualLab
True
False
Example 1
This command connects a virtual lab named "Exchange VLab 01". The virtual lab to connect is obtained with Find-VSBHvVirtualLab by looking for the specific virtual lab by name on the server represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Find-VSBHvVirtualLab -Server $server -Name "Exchange VLab 01" | Connect-VSBHvVirtualLab
Example 2
This command connects a virtual lab represented by the $VLab01 variable. The virtual lab object is obtained with Find-VSBHvVirtualLab and assigned to the variable beforehand. Connect-VSBHvVirtualLab -VirtualLab $VLab01
Connect-VSBVirtualLab
Short Description
Connects an existing VMware virtual lab.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Connect-VSBHvVirtualLab.
Syntax
Connect-VSBVirtualLab [-VirtualLab] <CVirtualLabDescriptor> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Find-VSBVirtualLab
This cmdlet connects an existing VMware virtual lab to Veeam Backup & Replication console. When you add a new host to your Veeam Backup & Replication console, the virtual labs that are registered on it are not added automatically. Use this cmdlet to add the virtual labs to your Veeam Backup & Replication console. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. See what else you can perform on SureBackup
Parameters
VirtualLab
Specifies the virtual lab you want to connect.
True
False
Example 1
This command connects a virtual lab named "Exchange VLab 01" to Veeam Backup & Replication. The server where the virtual lab is located is obtained with Get-VBRServer and assigned to the $server variable beforehand. Find-VSBVirtualLab -Server $server -Name "Exchange VLab 01" | Connect-VSBVirtualLab
Example 2
This command connects a virtual lab represented by the $VLab01 variable. The virtal lab object is obtained with Find-VSBVirtualLab and assigned to the variable beforehand. Connect-VSBVirtualLab -VirtualLab $VLab01
Copy-VBRJob
Short Description
Clones an existing job.
Applies to
Version: 7.0 and earlier Platform: VMware, Hyper-V
Syntax
Copy-VBRJob [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet clones an existing job. You can run this cmdlet with backup, replication and copy jobs. See what else you can perform on jobs Note: Job cloning requires Veeam Backup & Replication Enterprise edition.
Parameters
Job
Specifies the job you want to clone.
True
False
Example 1
This command clones the jobs named "DHCP Replica Job" and "DHCP Backup Job". The jobs are obtained with Get-VBRJob and piped down. Get-VBRJob -Name "DHCP Replica Job", "DHCP Backup Job" | CopyVBRJob
Example 2
This command clones the job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehand. Copy-VBRJob -Job $job
Disable-VBRHvProxy
Short Description
Disables a Hyper-V backup proxy.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Disable-VBRViProxy.
Syntax
Disable-VBRHvProxy -Proxy <CHvProxy[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRHvProxy
This cmdlet allows you to disable a Hyper-V backup proxy. The disabled proxy is not used by any job. See what else you can perform on your virtual proxies
Parameters
Specifies the Hyper-V backup proxy you want to disable. You can assign multiple proxies to this object.
Required
Position

Proxy
True
Named
False
Example 1
This command disables the selected Hyper-V proxy. The needed proxy object is obtained with GetVBRHvProxy by selecting the proxy with name containing "Hyper-V" and piped down. Get-VBRHvProxy -Name *Hyper-V* | Disable-VBRHvProxy
Example 2
This command disables the selected Hyper-V proxy represented by the $proxy variable. The proxy is obtained with Get-VBRHvProxy and assigned to the variable beforehand. Disable-VBRHvProxy -Proxy $proxy
Disable-VBRJob
Short Description
Puts a selected job on hold.
Applies to
Syntax
Disable-VBRJob -Job <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet puts a selected job on hold. The job and its settings are not deleted from Veeam Backup & Replication. You can enable the job at any time by running Enable-VBRJob. You can run this cmdlet with backup, replication and copy jobs. You cannot disable a SureBackup job. Run Stop-VBRJob to stop the job once without disabling it. See what else you can perform on jobs
Parameters
Specifies the job you want to disable. You can assign multiple jobs to this object.
Required
Position

Job
True
Named
False
Example 1
This command disables jobs named "Backup Job 01" and "Backup Job 02".The jobs object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | DisableVBRJob
Example 2
This command disables the job represented by the $job variable. The job object is obtained with GetVBRJob and assigned to the variable beforehand. Disable-VBRJob -Job $job
Disable-VBRJobGuestFSIndexing
Short Description
Disables job guest file system indexing option.
Applies to
Syntax
Disable-VBRJobGuestFSIndexing [-Job] <CBackupJob[]> [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet disables guest file system indexing in the selected job. The guest file system indexing settings are not deleted. Guest file system indexing is cataloging the guest VM files during the backup. Indexing helps you recognize files stored on guest VM. If you backup your VMs without guest file system indexing option, you will not be able to perform guest OS files restore. You can run this cmdlet with backup, replication and copy jobs. See what else you can perform on job options
Parameters
Specifies the job you want to edit. You can assign multiple backup jobs to this object.
Required
Position

Job
True
False
Example 1
This command disables the guest file system indexing option in jobs named "Backup Job 01" and "Backup Job 02". The jobs object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | DisableVBRJobGuestFSIndexing
Example 2
This command disables the guest file system indexing option in the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Disable-VBRJobGuestFSIndexing -Job $job
Short Description
Disables job schedule.
Applies to
Syntax
Disable-VBRJobSchedule -Job <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet disables job schedule. The schedule settings are not deleted. When you disable a job schedule, you can launch the job manually by running Start-VBRJob. You can run this cmdlet with backup, replication and copy jobs. See what else you can perform on job options
Parameters
Specifies the job(s) you want to disable. You can assign multiple backup jobs to this object.
Required
Position

Job
True
Named
False
Example 1
This command disables the job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | Disable-VBRJobSchedule
Example 2
This command disables the job represented by the $job variable. The job object is obtained with GetVBRJob and assigned to the variable beforehand. Disable-VBRJobSchedule -Job $job
Disable-VBRJobVSSIntegration
Short Description
Disables job VSS settings.
Applies to
Syntax
Disable-VBRJobVSSIntegration [-Job] <CBackupJob[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet disables the VSS settings in the selected job. The VSSs settings are not deleted form the job. VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently. You can run this cmdlet with backup, replication and copy jobs. See what else you can perform on job options
Parameters
Specifies the job you want to edit. You can assign multiple jobs to this object.
Required
Position

Job
True
False
Example 1
This command disables the VSS options in jobs named "Backup Job 01" and "Backup Job 02". The jobs object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | DisableVBRJobVSSIntegration
Example 2
This command disables the VSS options in job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Disable-VBRJobVSSIntegration -Job $job
Disable-VBRViProxy
Short Description
Disables a VMware backup proxy.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Disable-VBRHvProxy.
Syntax
Disable-VBRViProxy -Proxy <CViProxy[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRViProxy
This cmdlet allows you to temporarily disable a VMware backup proxy. The disabled proxy is not used by any job. See what else you can perform on your virtual proxies
Parameters
Specifies the VMware backup proxy you want to disable. You can assign multiple proxies to this object.
Required
Position

Proxy
True
Named
False
Example 1
This command disables the selected VMware proxies named "VMware Backup Proxy 01", "VMware Backup Proxy 05". The proxies are obtained with Get-VBRViProxy by selecting by names and piped down. Get-VBRHvProxy -Name "VMware Backup Proxy 01", "VMware Backup Proxy 05" | Disable-VBRViProxy
Example 2
This command disables the selected VMware proxy represented by the $proxy variable. The proxy is obtained with Get-VBRViProxy and assigned to the variable beforehand. Disable-VBRViProxy -Proxy $proxy
Eject-VBRTapeDrive
Short Description
Ejects tape from the selected media drive.
Applies to
Syntax
Eject-VBRTapeDrive -Drive <TapeDrive> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeDrive
This cmdlet ejects tape from the specified drive. The tape returns to its original slot. Run Eject-VBRTapeMedium to eject a specific tape from drive. Run Export-VBRTapeMedium to get a tape out of the library. See what else you can perform on tapes
Parameters
Drive
Specifies the drive you want to eject.
True
Named
False
Example 1
This command ejects the tape from the drive named "Drive01". The drive object is obtained with GetVBRTapeDrive and piped down. Get-VBRTapeDrive -Name "Drive01" | Eject-VBRTapeDrive
Example 2
This command ejects the tape from the drive represented by $drive variable. The drive object is obtained with Get-VBRTapeDrive and assigned to the variable beforehand. Eject-VBRTapeDrive -Drive $drive
Eject-VBRTapeMedium
Short Description
Ejects tape from media drive.
Applies to
Syntax
Eject-VBRTapeMedium -Medium <TapeMedium> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium
This cmdlet ejects the currently injected tape from the selected media drive. The tape returns to its original slot. Run Eject-VBRTapeDrive to eject a tape from a specific drive. See what else you can perform on tapes
Parameters
Medium
Specifies the tape you want to eject.
True
Named
False
Example 1
This command ejects the tapes containing the backup named "Fileserver Backup". The tapes containing the needed backup are obtained with Get-VBRTapeMedium and piped down. The backup is obtained with Get-VBRBackup and assigned to the $"Fileserver Backup" variable beforehand. Get-VBRTapeMedium -Backup $"Fileserver Backup" | EjectVBRTapeMedium
Example 2
This command ejects the tape represented by $tape variable. The tape object is obtained with GetVBRTapeMedium and assigned to the variable beforehand. Eject-VBRTapeMedium -Medium $tape
Enable-VBRHvProxy
Short Description
Enables a Hyper-V backup proxy.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Enable-VBRViProxy.
Syntax
Enable-VBRHvProxy -Proxy <CHvProxy[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRHvProxy
This cmdlet allows you to enable a Hyper-V backup proxy. See what else you can perform on your virtual proxies
Parameters
Specifies then object of the Hyper-V backup proxy you want to enable. You can assign multiple proxies to this object.
Required
Position

Proxy
True
Named
False
Example 1
This command enables all proxies with names starting with "Hyper-V Proxy 1...". The proxies are obtained with Get-VBRHvProxy by filtering with "*" search condition and piped down. Get-VBRHvProxy -Name "Hyper-V Proxy 1*" | Enable-VBRHvProxy
Example 2
This command enables the Hyper-V proxy represented by the $proxy variable. The needed proxy is obtained with Get-VBRHvProxy and assigned to the variable beforehand. Enable-VBRHvProxy -Proxy $proxy
Enable-VBRJob
Short Description
Enables a disabled job.
Applies to
Syntax
Enable-VBRJob -Job <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] a[<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet enables a disabled job. When you disable a job, you put it on hold until you enable it with this cmdlet. You can disable a job by running Disable-VBRJob. You can run this cmdlet with backup, replication and copy jobs. Run Start-VBRJob to start a job once. See what else you can perform on jobs
Parameters
Specifies the job you want to enable. You can assign multiple jobs to this object.
Required
Position

Job
True
Named
False
Example 1
This command enables the jobs named "Backup Job 01" and "Backup Job 02". The backup jobs are obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | Enable-VBRJob
Example 2
This command enables the job represented by the $job variable. The job object is obtained with GetVBRJob and assigned to the variable beforehand. Enable-VBRJob -Job $job
Enable-VBRJobGuestFSIndexing
Short Description
Enables job guest file system indexing option.
Applies to
Syntax
Enable-VBRJobGuestFSIndexing [-Job] <CBackupJob[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet enables guest file system indexing in the selected job. Guest file system indexing is cataloging the guest VM files during the backup. Indexing helps you recognize files stored on guest VM. If you backup your VMs without guest file system indexing option, you will not be able to perform guest OS files restore. You can enable the guest file system indexing settings in case you have these settings set beforehand. Use this cmdlet to enable the indexing option that was disabled with DisableVBRJobGuestFSIndexing. You can run this cmdlet with backup and replica jobs including vCloud jobs. See what else you can perform on job options
Parameters
Required
Position

Job
True
False
Example 1
This command enables the guest file system indexing option in jobs named "Backup Job 01" and "Backup Job 02". The jobs are obtained with Get-VBRJob and piped down. Get-VBRJob -Name Name "Backup Job 01", "Backup Job 02" | EnableVBRJobGuestFSIndexing
Example 2
This command enables the guest file system indexing option in the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Enable-VBRJobGuestFSIndexing -Job $job
Short Description
Enables job schedule.
Applies to
Syntax
Enable-VBRJobSchedule -Job <CBackupJob[]> [-WarningAction <ActionPreference>][-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet enables job schedule. You can enable the job schedule in case you have the schedule set beforehand. Use this cmdlet to enable the job schedule that was disabled with Disable-VBRJobSchedule. You can run this cmdlet with any kind of jobs. See what else you can perform on job options
Parameters
Specifies the job(s) you want to edit. You can assign multiple jobs to this object.
Required
Position

Job
True
Named
False
Example 1
This command enables the schedule for jobs named "Backup Job 01" and "File Copy Job 02". The jobs are obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01", "File Copy Job 02" | EnableVBRJobSchedule
Example 2
This command enables the schedule for job represented by the $"Backup Job 01" variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Enable-VBRJobSchedule -Job $"Backup Job 01"
Enable-VBRJobVSSIntegration
Short Description
Enables job VSS settings.
Applies to
Syntax
Enable-VBRJobVSSIntegration [-Job] <CBackupJob[]> [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet enables the VSS settings in the selected job. VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently. You can enable the VSS settings in case you have these settings set beforehand. Use this cmdlet to enable the VSS settings that were disabled with Disable-VBRJobVSSIntegration. You can run this cmdlet with backup and replica jobs including vCloud jobs. See what else you can perform on job options
Parameters
Required
Position

Job
True
False
Example 1
This command enables the VSS option in the job named "Backup Job 01" and "Backup Job 02". The jobs are obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | EnableVBRJobVSSIntegration
Example 2
This command enables the VSS option in the job represented by the $"Backup Job 01" variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Enable-VBRJobVSSIntegration -Job $"Backup Job 01"
Enable-VBRViProxy
Short Description
Enables a VMware backup proxy.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Enable-VBRHvProxy.
Syntax
Enable-VBRViProxy -Proxy <CViProxy[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRViProxy
This cmdlet allows you to enable a VMware backup proxy. See what else you can perform on your virtual proxies
Parameters
Specifies the VMware backup proxy you want to enable. You can assign multiple proxies to this object.
Required
Position

Proxy
True
False
Example 1
This command enables the selected VMware proxy named "VMwareProxy". The needed proxy is obtained with Get-VBRViProxy and piped down. Get-VBRViProxy -Name "VMwareProxy" | Enable-VBRViProxy
Example 2
This command enables the selected VMware proxy represented by the $proxy variable. The needed proxy is obtained with Get-VBRViProxy and assigned to the variable beforehand. Enable-VBRViProxy -Proxy $proxy
Erase-VBRTapeMedium
Short Description
Clears data from tape.
Applies to
Syntax
Erase-VBRTapeMedium -Medium <TapeMedium[]> [-Long] [-RunAsync] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium
This cmdlet clears a selected tape making it available for new recordings. By default Veeam Backup & Replication runs short erase procedure clearing only the tape headers. The remaining data is overwritten. You can enable long erase procedure to clear all data from the tape by adding "-Long" parameter to your string. The erased tape remains in the media pool it belongs to. Exceptions are predefined Unrecognized, Imported and Free media pools. If you move tape with data to the Free media pool and confirm the operation, Mark as Free will take effect and the data will be overwritten. See what else you can perform on tapes
Parameters
Specifies the tape(s) you want to erase. You can assign multiple tapes to this object. If set, the erase procedure will clear all data from the tape. Otherwise Veeam Backup & Replication runs a short erase procedure that clears the headers only: the tape is regarded as free and the remaining data is ovewritten. Indicates that the command returns immediately without waiting for the task to complete.
Required
Position

Medium
True
Named
False
Long
False
Named
False
False
RunAsync
False
Named
False
False
Example 1
This command clears the tape with barcode 00233400. The tape to erase is obtained with GetVBRTapeMedium, selected using the Where-Object by "barcode" property and piped down. Get-VBRTapeMedium | Where-Object {$_.barcode -eq "00233400"}| Erase-VBRTapeMedium -RunAsync
Example 2
This command clears the tape represented by $tape variable. The tape is obtained with GetVBRTapeMedium and assigned to the variable beforehand. The RunAsync parameter is set to bring the process to the background. Erase-VBRTapeMedium -Tape $tape -RunAsync
Export-VBRBackup
Short Description
Exports a backup or restore point files to a selected folder.
Applies to
Syntax
Export-VBRBackup [-Backup] <CBackup> [-Dir] <String> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORExport-VBRBackup [-RestorePoint] <COib> [-Dir] <String> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackup Get-VBRRestorePoint
This cmdlet copies a selected backup files to a user-specified directory. You can copy a whole backup file or select backups for a specific job object. The job objects are VMs, VM containers, datastores or resource pools. See what else you can perform on your backup files
Parameters
Specifies the backup file you want to export. Specifies the job object (i.e. a VM) for which you want to export the backup files. Specifies the path to the folder where you want to copy the files to.
Required
Position

False

False
Backup
True
RestorePoint
True
False
False
Dir
True
False
False
Example 1
This command exports the backup file represented by the $"AD backup" to the folder "C:\Export". The backup file to export is obtained with Get-VBRBackup and assigned to the variable beforehand. Export-VBRBackup -Backup $"AD backup" -Dir "C:\Export"
Example 2
This command exports the backup file for a specific VM represented by the $"AD_local" to the folder "C:\Export". The backup file to export is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. Export-VBRBackup -RestorePoint $"AD_local" -Dir "C:\Export"
Export-VBRConfiguration
Short Description
Exports configuration backup file.
Applies to
Syntax
Export-VBRConfiguration [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
This cmdlet backs up current configuration of Veeam Backup & Replication server. By default, configuration backups are stored to the C:\backup\VeeamConfigBackup\%BackupServer% folder on the Veeam backup server. With configuration backup, you can store a copy of your host configuration: your virtual infrastructure, jobs configuration, Veeam Backup & Replication settings and other data. You can restore configuration in case the Veeam Backup & Replication host is failed or configuration is corrupted. Run Import-VBRConfiguration to restore your host configuration. <CommonParameters> This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
This command exports the current configuration of Veeam Backup & Replication host. Export-VBRConfiguration
Export-VBRLogs
Short Description
Collects logs for export.
Applies to
Syntax
Export-VBRLogs -Server <CHost[]> -FolderPath <String> [-Compress] [-From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORExport-VBRLogs -Job <IJob[]> -FolderPath <String> [-Compress] [From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORExport-VBRLogs -Entity <IVmItem[]> -FolderPath <String> [Compress] [-From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORExport-VBRLogs -Backup <CBackup[]> -FolderPath <String> [Compress] [-From <DateTime>] [-To <DateTime>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer Get-VBRJob Get-VSBJob Find-VBRViEntity / Find-VBRHvEntity Get-VBRBackup
This cmdlet collects system logs. You can use this cmdlet to collect logs you can send to the Veeam support. The log files are written to the folder you specify in this cmdlet. This cmdlet provides syntax for getting logs for hosts, jobs, entities or backups. You can get logs for all kind of virtual host, any jobs including SureBackup jobs, all entities including datastores, clusters, replicas, etc., or any backup.
Parameters
Specifies the server(s) from which you want to collect logs. Server Note that selected servers must be running and reachable over the network. You can assign multiple servers to this object. Specifies the start date to collect the logs for export. Enter the date in format set in your workstation Date and Time settings. Specifies the end date to collect the logs for export. Enter the date in format set in your workstation Date and Time settings. Specifies the job(s) you want to collect logs for. You can get logs for all kind of jobs. You can assign multiple jobs to this object. Specifies the VM(s) you want to collect logs for. You can assign multiple VMs to this object. Specifies the backups you want to collect logs for. You can assign multiple backups to this object. Specifies the destination folder to which the logs will be exported. If set, the log files will be archived. True Named
Required
Position
False
From
False
Named
False
False
To
False
Named
False
False
Job
True
Named
False
Entity
True
Named
False
Backup
True
Named
False
FolderPath
True
Named
False
False
Compress
False
Named
False
False
Example 1
This command starts collecting log files from the server represented by the $server variable. The destination path is C:\Logs. The period for collecting data is July, 21, 2013 - July, 25, 2013. The data compression is enabled. Export-VBRLogs -Server $server -FolderPath "C:\Logs" -Compress From 7/21/2013 -To 7/25/2013
Example 2
This command starts collecting log files for the SureBackup job named "DC SureJob". The job is obtained with Get-VSBJob and piped down. The destination path is C:\Logs\SureBackup Logs. The period for collecting data is not set to collect all the data for the job. The data compression is enabled. Get-VSBJob -Name "DC SureJob" | Export-VBRLogs -FolderPath "C:\Logs\SureBackup Logs" -Compress
Example 3
This command starts collecting log files for the VM named "DC" for May, 2013. The VM is obtained with Find-VBRViEntity and piped down. The destination path is C:\Logs. The data compression is enabled. Find-VBRViEntity -Name "DC" | Export-VBRLogs -FolderPath "C:\Logs" -Compress -From 6/01/2013 -To 7/01/2013
Export-VBRTapeMedium
Short Description
Exports selected tapes from library.
Applies to
Syntax
Export-VBRTapeMedium -Medium <TapeMedium[]> [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium
This cmdlet moves a selected tape to the mail slot. You can take the tape out of the mail slot manually. The mail slot is the slot through which you can put the new tapes into the library and take the tapes with data out. The mail slot is a service slot and you do not manage the tape residing inside it until it is imported to the library or after it is exported. Run Import-VBRTapeMedium to put new tapes to the library. See what else you can perform on tapes
Parameters
Specifies the tape(s) you want to export. You can assign multiple tapes to this object. Indicates that the command returns immediately without waiting for the task to complete.
Required
Position

Medium
True
Named
False
RunAsync
False
Named
False
False
Example 1
This command exports the tapes belonging to the media pool named "Incremental Backups". The tapes are obtained with Get-VBRTapeMedium by piping the needed media pool down. The -RunAsync parameter is set to bring the process to the background. Get-VBRTapeMediaPool -Name "Incremental Backups" | GetVBRTapeMedium | Export-VBRTapeMedium -RunAsync
Example 2
This command moves the group of tapes represented by the $tapes variable to the mail slot. The tapes object is obtained with Get-VBRTapeMedium and assigned to the variable beforehand. The RunAsync parameter is set to bring the process to the background. $tapes | Export-VBRTapeMedium -RunAsync
Find-VBRDatastore
Short Description
Returns a list of VMware datastores connected to the specified ESX(i) host. Note: In Backup & Replication v6 this cmdlet was replaced by Find-VBRViDatastore due to multihypervisor support introduced in the new version. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.
Applies to
Syntax
Find-VBRDatastore [-Server] <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of all datastores connected to the specified ESX(i) host.
Parameters
Server
Specifies the ESX(i) host you want to get the list of the connected datastores of. Specifies the name of the datastore you want to get, or search conditions. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
True
Example 1
This command looks for the datastore named "Store 04" on server named named "VMwareHost". The server object is obtained with Get-VBRServer and piped down. Get-VBRServer -Name "VMwareHost" | Find-VBRDatastore -Name "Store 04"
Example 2
This command looks for the all datastores located on server represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Find-VBRDatastore -Server $server
Find-VBRHvEntity
Short Description
Looks for Hyper-V objects.
Applies to
Syntax
Find-VBRHvEntity [-Server <CHost[]>] [-HostsAndVMs] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRHvEntity [-Server <CHost[]>] [-Hosts] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRHvEntity [-Server <CHost[]>] [-HostsAndVolumes] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of Hyper-V objects managed by Veeam Backup & Replication. You can get the list of all Hyper-V objects in your virtual environment or narrow down your search to hosts, VMs or volumes, or look for instances directly by name. Look for other virtual instances Run Get-VBRServer to get the list of the Hyper-V hosts.
Return Type
CHvHostItem CHvVmItem
Parameters
Specifies the host you want to look for entities on. You can assign multiple servers to this object. Views results as hosts and VMs. Views results as hosts. Views results as hosts and volumes. Specifies the name of the entity you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position

True (ByValue, ByProperty Name) False False False
Server
False
Named
False
HostsAnd VMs Hosts HostsAnd Volumes
False False False
Named Named Named
False False False
Name
False
Named
False
True
Example 1
This command looks for all Hyper-V objects registered on server named "Hyper-V Host". The server is obtained with Get-VBRServer and piped down. Get-VBRServer -Name "HvHost" | Find-VBRHvEntity
Example 2
This command looks for Hyper-V hosts and VMs registered on Hyper-V servers named "HvHost 01" and "HvHost 02". The servers are obtained with Get-VBRServer and piped down. Get-VBRServer -Name "HvHost 01", "HvHost 02" | Find-VBRHvEntity HostsAndVMs
Example 3
This command directly looks for the Hyper-V server named "HvExchange". Find-VBRHvEntity -Name "HvExchange"
Find-VBRObject
Short Description
Returns a list of all VMs and VM containers on the specified ESX(i) host. Note: In Backup & Replication v6 this cmdlet was replaced by Find-VBRViEntity and Find-VBRHvEntity due to multihypervisor support introduced in the new version.
Applies to
Syntax
Find-VBRObject [-Server] <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of all VMs and VM containers on the specified ESX(i) host. Look for other virtual instances
Parameters
Server
Specifies the host you want to look for objects on. Specifies the name of the object you want to get, or search conditions. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
False
Example 1
This command looks all objects registered on server named named "VMwareHost". The server object is obtained with Get-VBRServer and piped down. Get-VBRServer -Name "VMwareHost" | Find-VBRObject
Example 2
This command looks for VMs named "VM01" and "VM03" located on server represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Find-VBRObject -Server $server -Name "VM01", "VM03"
Find-VBRResourcePool
Short Description
Looks for VMware resource pools. Note: This cmdlet is obsolete. In Backup & Replication v6 this cmdlet was replaced by FindVBRViResourcePool.
Applies to
Syntax
Find-VBRResourcePool [-Server] <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of all VMware resource pools on the specified ESX(i) host. Look for other virtual instances
Parameters
Server
Specifies the host you want to look for resource pool on.
True
False
Name
Specifies the name of the resource pool you want to get, or search conditions. You can specify multiple names separated by commas.
False
Named
False
False
Find-VBRTapeCatalog
Short Description
Looks for files stored on tapes.
Applies to
Syntax
Find-VBRTapeCatalog [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet looks for files stored on tapes that are managed by Veeam Backup & Replication. Veeam Backup & Replication stores all data about the backups that were recorded to tapes in the database, and you can view the list of files both while the tapes are online, or after they were removed from the library. The backups or files that were written to tapes with Veeam Backup & Replication are indexed automatically. Run Start-VBRTapeCatalog to index the imported tapes. You can get the list of all files that are stored on tapes or narrow down the output by file name. Run Find-VBRTapeCatalogVersion to look for list of versions of a specific file. See what else you can perform on tapes
Return Type
CatalogueFile
Parameters
Specifies the name of the file to look for or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
This command looks for .vbk files. Find-VBRTapeCatalog -Name *.vbk
Short Description
Looks for versions of files stored on tapes.
Applies to
Syntax
Find-VBRTapeCatalogVersion [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRTapeCatalogVersion [-CatalogFile <CatalogueFile>] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Find-VBRTapeCatalog
This cmdlet looks for versions of files stored on tapes that are managed by Veeam Backup & Replication. File version is used as a file restore point. You can get the list of all files and their versions that are stored on tapes or narrow down the output by file name or object of file you need. Run Find-VBRTapeCatalog to get the list of files stored on tapes. See what else you can perform on tapes
Return Type
CatalogueFileVersion
Parameters
Specifies the name of the file you want to get versions for, or search conditions. You can specify multiple names separated by commas. Specifies the file you want to get versions for.
Required
Position
Name
False
Named
False
True
CatalogFile
False
Named
True (ByValue, ByProperty
False
Parameter
Description
Required
Position

Name)
This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example 1
This command looks for the most recent version of file named "Payroll_Marketing.html". The file object is obtained with Find-VBRTapeCatalog and piped down. The needed version is filtered with Select method. Find-VBRTapeCatalog -Name "Payroll_Marketing.html" | FindVBRTapeCatalogVersion | Select -First 1
Example 2
This command looks for versions of file represented by $file variable. The file object is obtained with Find-VBRTapeCatalog, assigned to the variable and piped down. $file | Find-VBRTapeCatalogueVersion
Find-VBRvCloudEntity
Short Description
Looks for vCloud Director entities.
Applies to
Syntax
Find-VBRvCloudEntity [-Server <CHost[]>][-Full][-Name <string[]>] [<CommonParameters>] Find-VBRvCloudEntity [-Server <CHost[]>][-VApp][-Name <string[]>] [<CommonParameters>] Find-VBRvCloudEntity [-Server <CHost[]>][-Template][-Name <string[]>] [<CommonParameters>] Find-VBRvCloudEntity [-Server <CHost[]>][-VmTemplate][-Name <string[]>] [<CommonParameters>] Find-VBRvCloudEntity [-Server <CHost[]>][-OrganizationVdc][-Name <string[]>] [<CommonParameters>] Find-VBRvCloudEntity [-Server <CHost[]>][-StorageProfile][-Name <string[]>] [<CommonParameters>] Find-VBRvCloudEntity [-Server <CHost[]>][-Datastore][-Name <string[]>] [<CommonParameters>] Find-VBRvCloudEntity [-Server <CHost[]>][-Vc][-Name <string[]>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet looks for a certain entity of vCloud Director. You can get the whole list of vCloud entities, or the list of specified entities (i.e. vApps), or narrow down the output by filtering by name. See what else you can perform on vCloud
Return Type
CVcdSystemItem CVcdOrganizationItem CVcdOrganizationVdcItem CVcdVappItem CVcdVmItem CVcdOrgVdcStorageProfile CVcdDatastoreRestoreInfo
Parameters
Specifies the server(s) where the entity to look for is located. You can assign multiple servers to this object. Full VApp Template VmTemplate Organization Vdc StorageProfile Datastore Vc View results as the list of all vCloud entities. View results as vApps. View results as vApp templates. View results as VM templates. View results as Organization vDCs. View results as storage profiles. View results as datastores. View results as vClouds. Specifies the name(s) of the entity. Name You can specify multiple names separated by commas. False Named False True False False False False False False False False Named Named Named Named Named Named Named Named
Required
Position

Server
False
Named
False
False False False False False False False False
False False False False False False False False
Example 1
This command looks for all vCloud entities registered on the server represented by $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Find-VBRvCloudEntity -Server $server -Full
Example 2
This command looks for the vCloud entities registered on the server with 172.16.1.13 IP address. The server object is obtained with Get-VBRServer and piped down. The output is filtered by name containing "SQL". Get-VBRServer -Name "172.16.1.13" | Find-VBRvCloudEntity -Name *SQL*
Example 3
This command looks for the vApps registered on the server named "vCloud Server". The server object is obtained with Get-VBRServer and piped down. Get-VBRServer -Name "vCloud Server" | Find-VBRvCloudEntity -VApp
Example 4
This command looks for the datastore named "Datastore 04" registered on the server represented by $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Find-VBRvCloudEntity -Server $server -Datastore -Name "Datastore 04"
Find-VBRViDatastore
Short Description
Looks for VMware datastores connected to the specified ESX(i) host.
Applies to
Syntax
Find-VBRViDatastore -Server <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of datastores connected to the specified ESX(i) host. You can get the list of all datastores on the specified ESX(i) host or look for instances directly by name. Look for other virtual instances
Return Type
CViDatastoreItem
Parameters
Server
Specifies the ESX(i) host to which the datastores you are looking for are connected. Specifies the name of the datastore you want to get, or search conditions. You can specify multiple names separated by commas.
True
Named
False
Name
False
Named
False
True
Example 1
This command looks for the list of datastores connected to the ESXi hosts. The servers are obtained with Get-VBRServer, sorted by "Type" and piped down. Get-VBRServer -Type ESXi | Find-VBRViDatastore
Example 2
This command looks for the datastores connected to the ESXi host named "ESXiHost". The server is obtained with Get-VBRServer and piped down. The list of datastores is narrowed down to the datastore named "MSExchange" and datastores with names starting with "LocalStore_0". Get-VBRServer -Name "ESXiHost" | Find-VBRViDatastore -Name "MSExchange", "LocalStore_0*"
Example 3
This command looks for the datastore named "MSExchange" connected to the server represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Find-VBRViDatastore -Server $server -Name "MSExchange"
Find-VBRViEntity
Short Description
Looks for VMware entities.
Applies to
Syntax
Find-VBRViEntity [-Server <CHost[]>] [-HostsAndClusters] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRViEntity [-Server <CHost[]>] [-VMsAndTemplates] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRViEntity [-Server <CHost[]>] [-DatastoresAndVMs] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRViEntity [-Server <CHost[]>] [-HostsAndDatastores] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRViEntity [-Server <CHost[]>] [-ResourcePools] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORFind-VBRViEntity [-Server <CHost[]>] [-Servers] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of all VMware objects connected to the specified ESX(i) host. You can get the list of all VMware entities registered in your virtual VMware environment or narrow down the search results to specific objects, or look for instances directly by name. Look for other virtual instances Run Get-VBRServer to get the list of the VMware hosts.
Return Type
CVcItem CViFolderItem CViDatacenterItem CEsxItem CViClusterItem CViResourcePoolItem CViVmItem CViVirtualAppItem CViFolderItem CViDatacenterItem
Parameters
True (ByValue, ByProperty Name) False False False False False False
Server
Specifies the ESX(i) host you want to look for entities on. Views results as hosts and clusters. Views results as VMs and templates. Views results as datastores and VMs. Views results as hosts and datastores. Views results as resource pools. Views results as VMware hosts. Specifies the name of the entity you want to get, or search conditions. You can specify multiple names separated by commas.
False
Named
False
HostsAnd Clusters VMsAnd Templates Datastores AndVMs HostsAnd Datastores ResourcePools Servers
False False False False False False
Named Named Named Named Named Named
False False False False False False
Name
False
Named
True
True
Example 1
This command looks for the list of hosts and clusters connected to the ESXi hosts named "ESXiHost 01" and "ESXiHost 02". The servers are obtained with Get-VBRServer and piped down. Get-VBRServer -Name "ESXiHost 01", "ESXiHost 02" | FindVBRViEntity -HostsAndClusters
Example 2
This command looks for the list of resource pools connected to the ESXi host named "ESXiHost". The server is obtained with Get-VBRServer and piped down. The list of resource pools is narrowed down to the resource pools with names starting with "Veeam". Get-VBRServer -Name "ESXiHost" | Find-VBRViEntity -ResourcePools -Name Veeam*
Find-VBRViFolder
Short Description
Looks for list of folders on the specified ESX(i) host.
Applies to
Syntax
Find-VBRViFolder -Server <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of folders on the specified ESX(i) host. You can get the list of all folders on the specified ESX(i) host or look for instances directly by name. Look for other virtual instances
Return Type
CViFolderItem
Parameters
Server
Specifies the ESX(i) host you want to look for folders on. Specifies the name of the folder you want to get, or search conditions. You can specify multiple names separated by commas.
True
Named
False
Name
False
Named
False
True
Example 1
This command looks for the list of folders located on the ESXi hosts. The servers are obtained with GetVBRServer, sorted by "Type" and piped down. Get-VBRServer -Type ESXi | Find-VBRViFolder
Example 2
This command looks for the datastores connected to the ESXi host named "ESXiHost". The server is obtained with Get-VBRServer and piped down. The list of datastores is narrowed down to the datastore named "MSExchange" and datastores with names starting with "LocalStore_0". Get-VBRServer -Name "ESXiHost" | Find-VBRViFolder -Name "MSExchange", LocalStore_0*
Find-VBRViResourcePool
Short Description
Looks for resource pools on the specified ESX(i) host.
Applies to
Syntax
Find-VBRViResourcePool -Server <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of resource pools on the specified ESX(i) host. You can get the list of all resource pools on the specified ESX(i) host or look for instances directly by name. Look for other virtual instances
Return Type
CViResourcePoolItem
Parameters
Server
Specifies the ESX(i) host you want to look for resource pools on. Specifies the name of the resource pool you want to get, or search conditions. You can specify multiple names separated by commas.
True
Named
False
Name
False
Named
False
False
Example 1
This command looks for the list of resource pools located on the ESXi hosts. The servers objects are obtained with Get-VBRServer, sorted by "Type" and piped down. Get-VBRServer -Type ESXi | Find-VBRViResourcePool
Example 2
This command looks for the resource pool named "ResourcePool_05" connected to the ESXi host named "ESXiHost". The server object is obtained with Get-VBRServer and piped down. Get-VBRServer -Name "ESXiHost" | Find-VBRViResourcePool -Name "ResourcePool_05"
Find-VSBHvVirtualLab
Short Description
Looks for the virtual labs created on the specified Hyper-V host.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Find-VSBVirtualLab.
Syntax
Find-VSBVirtualLab [-Server] <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of all virtual labs created on the specified Hyper-V host. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. You can get the list of all virtual labs on the specified ESX(i) host or look for instances directly by name. See what else you can perform on SureBackup
Return Type
CHvSbVirtualLab
Parameters
Server
Specifies the server where virtual labs are registered. Specifies the name of the virtual lab or search conditions. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
True
Example 1
This command looks for the list of all virtual labs created on the Hyper-V server named "Hyper-V Host". The server object is obtained with Get-VBRServer and piped down. Get-VBRServer -Name "Hyper-V Host" | Find-VSBHvVirtualLab
Example 2
This command looks for the virtual labs with names starting with "Hv" on the server represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Find-VSBHvVirtualLab -Server $server -Name Hv*
Find-VSBVirtualLab
Short Description
Looks for virtual labs created on the specified ESX(i) host.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Find-VSBHvVirtualLab.
Syntax
Find-VSBVirtualLab [-Server] <CHost> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet returns a list of all virtual labs created on the specified ESX(i) host. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. You can get the list of all VMware virtual labs on the specified ESX(i) host or look for instances directly by name. See what else you can perform on SureBackup
Return Type
CVirtualLabDescriptor
Parameters
Server
Specifies the server you want to look for virtual labs on. Specifies the name of the resource pool you want to get, or search conditions. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
False
Example 1
This command looks for the list of all virtual labs located on the ESXi hosts. The servers are obtained with Get-VBRServer, sorted by "Type" and piped down. Get-VBRServer -Type ESXi | Find-VSBVirtualLab
Example 2
This command looks for the virtual lab named "MailServer_VLab" connected to the ESXi host named "ESXiHost". The server is obtained with Get-VBRServer and piped down. Get-VBRServer -Name "ESXiHost" | Find-VSBVirtualLab -Name "MailServer_VLab"
Get-HP3Snapshot
Short Description
Returns a SAN snapshot object.
Applies to
Syntax
Get-HP3Snapshot [-Name <string[]>][<CommonParameters>] -ORGet-HP3Snapshot [-Name <string[]>] [-Volume <CSanVolume[]>][<CommonParameters>]
Related Commands
Get-HP3Volume
This cmdlet returns a SAN snapshot object. You can get the list of all SAN snapshots in your storage system or narrow down the output by the snapshot name or a specific volume. See what else you can perform on HP 3PAR instances
Parameters
Specifies the name of the snapshot you want to get. Name You can specify multiple names separated by commas. Specifies the volume(s) for which you want to get the snapshots. You can assign multiple volumes to this object. False Named False True
Required
Position
Volume
False
Named
False
Example 1
This command looks for the list of all snapshots. Get-HP3Snapshot
Example 2
This command looks for snapshots of the specific volumes. The list of volumes is obtained with GetHP3Volume, the first three volumes are selected and piped down. Get-HP3Volume | Select -First 3 | Get-HP3Snapshot
Get-HP3Storage
Short Description
Returns a SAN storage object.
Applies to
Syntax
Get-HP3Storage [-Name <string[]>][<CommonParameters>]
This cmdlet returns SAN storage object. You can get the list of all SAN snapshots in your storage system or narrow down the output by the storage name. See what else you can perform on HP 3PAR instances
Parameters
Specifies the name of the storage you want to get. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all SAN storages. Get-HP3Storage
Example 2
This command looks for the list of storages with names starting with "HP Store". Get-HP3Storage -Name "HP Store*"
Get-HP3Volume
Short Description
Returns a SAN volume object.
Applies to
Syntax
Get-HP3Volume -Storage <CHp3PARHost[]> [-Name <string[]>][<CommonParameters>]
Related Commands
Get-HP3Storage
This cmdlet returns SAN volume object. You can get the list of all SAN volumes in your storage system, narrow down the output by the volume name or specify a cluster or a storage within which you want to look for the volumes. See what else you can perform on HP 3PAR instances
Parameters
Specifies the storage(s) within which you want to look for the volumes. You can assign multiple storages to this object. Specifies the name of the volume you want to get. Name You can specify multiple names separated by commas. False Named False True
Required
Position

Storage
True
Named
False
Example 1
This command looks for the volume named "HP Store" in the storage named "HP Store 01". The storage object is obtained with Get-HP3Storage and piped down. Get-HP3Storage -Name "HP Store 01" | Get-HP3Volume -Name "HP Store"
Example 2
This command looks for the volume named "HP Store" in the storage represented by the $"SAN storage" variable. The storage object is obtained with Get-HP3Storage and assigned to the variable beforahand. Get-HP3Volume -Storage $"SAN storage" -Name "HP Store"
Get-HP4Cluster
Short Description
Returns a SAN cluster object.
Applies to
Syntax
Get-HP4Cluster -Storage <CHpP4Group[]> [-Name <string[]>][<CommonParameters>]
Related Commands
Get-HP4Storage
This cmdlet returns SAN cluster object. You can get the list of all SAN clusters in your storage system, or narrow down the output by the cluster name or a specific storage. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Get-VBRHPCluster
Parameters
Specifies the storage within which you want to look for the clusters. You can assign multiple storages to this object. Specifies the name of the cluster you want to get. Name You can specify multiple names separated by commas. False Named False True
Required
Position

Storage
True
Named
False
Example 1
This command looks for the list of clusters in the storage named "HP Store 01". The storage object is obtained with Get-HP4Storage and piped down. Get-HP4Storage -Name "HP Store 01" | Get-HP4Cluster
Example 2
This command looks for the list of clusters in the storage named "HP Store 01". The storage object is obtained with Get-HP4Storage and assigned to the variable beforehand. Get-HP4Cluster -Storage $"HP Store 01"
Get-HP4Snapshot
Short Description
Returns a SAN snapshot object.
Applies to
Syntax
Get-HP4Snapshot [-Name <string[]>][<CommonParameters>] -ORGet-HP4Snapshot [-Name <string[]>] [-Volume <CSanVolume[]>][<CommonParameters>]
Related Commands
Get-HP4Volume
This cmdlet returns SAN snapshot object. You can get the list of all SAN snapshots in your storage system, or narrow down the output by the snapshot name or a specific volume. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Get-VBRHPSnapshot
Parameters
Specifies the name of the snapshot you want to get. Name You can specify multiple names separated by commas. Specifies the volume(s) you want to get the snapshots of. You can assign multiple volumes to this object. False Named False True
Required
Position
Volume
False
Named
False
Example 1
This command looks for snapshots of the volume named "HP Vol01". The volume is obtained with GetHP4Volume and piped down. Get-HP4Volume -Name "HP Vol01" | Get-HP4Snapshot
Example 2
This command looks for the snapshots of the volume represented by the $vol variable. The volume is obtained with Get-HP4Volume and assigned to the variable beforehand. Get-HP4Snapshot
Get-HP4Storage
Short Description
Returns a SAN storage object.
Applies to
Syntax
Get-HP4Storage [-Name <string[]>] [<CommonParameters>]
This cmdlet returns a SAN storage object. You can get the list of all SAN snapshots in your storage system, or narrow down the output by the storage name. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Get-VBRHPStorage
Parameters
Specifies the name of the storage you want to get. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all storages. Get-HP4Storage
Example 2
This command looks for the list of storages with names starting with "HP Store". Get-HP4Storage -Name "HP Store*"
Get-HP4Volume
Short Description
Returns a SAN volume object.
Applies to
Syntax
Get-HP4Volume [-Name <string[]>] [<CommonParameters>] -ORGet-HP4Volume -Cluster <CHpP4kCluster[]> [-Name <string[]>] [<CommonParameters>] -ORGet-HP4Volume -Storage <CHpP4Group[]> [-Name <string[]>] [<CommonParameters>]
Related Commands
Get-HP4Storage Get-HP4Cluster
This cmdlet returns a SAN volume object. You can get the list of all SAN volumes in your storage system,narrow down the output by the volume name, or specify a cluster or a storage within which you want to look for the volumes. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Get-VBRHPVolume
Parameters
Specifies the name of the volume you want to get. Name You can specify multiple names separated by commas. Specifies the cluster within which you want to look for the volumes. You can assign multiple False Named False True
Required
Position
Cluster
True
Named
False
Parameter
Description
clusters to this object. Specifies the storage within which you want to look for the volumes. You can assign multiple storages to this object.
Required
Position
Storage
True
Named
False
Example 1
This command looks for the list of volumes with names starting with "HP Store" within the cluster named "Cluster 1". The cluster object is obtained with Get-HP4Cluster and piped down. Get-HP4Cluster -Name "Cluster 1" | Get-HP4Volume -Name "HP Store*"
Example 2
This command looks for all volumes in the storage named "HP Store 01". The storage object is obtained with Get-HP4Storage and piped down. Get-HP4Storage -Name "HP Store 01" | Get-HP4Volume
Example 3
This command looks for volume named "HP Vol01" in the storage represented by the $storage variable. The storage object is obtained with Get-HP4Storage and assigned to the variable beforehand. Get-HP4Volume -Storage $storage -Name "HP Vol01"
Get-VBRBackup
Short Description
Returns the list of backup files.
Applies to
Syntax
Get-VBRBackup [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all backups stored in the Veeam Backup & Replication database. By default, the backup files are named by backup jobs names. You can get the list of all backup files or look for instances directly by name. See what else you can perform on your backup files Run Get-VBRJob to get the list of backup, replication or copy jobs.
Return Type
CBackup
Parameters
Specifies the name of the backup file you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
False
Example 1
This command looks for all backups stored in the database. Get-VBRBackup
Example 2
This command looks for the backups named "vCloud Webservices Backup" and "Exchange Backup_imported". Get-VBRBackup -Name "vCloud Webservices Backup", "Exchange Backup_imported"
Get-VBRBackupRepository
Short Description
Returns the list of all backup repositories.
Applies to
Syntax
Get-VBRBackupRepository [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all backup repositories managed by Veeam Backup & Replication. You can get the list of all backup repositories or look for instances directly by name. See what else you can perform on backup repositories
Return Type
CBackupRepository
Parameters
Specifies the name of the backup repository you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all backup repositories managed by Veeam Backup & Replication. Get-VBRBackupRepository
Example 2
This command looks for the backup repositories named "Backups Vol2" and for backup repositories with names starting with "Local". Get-VBRBackupRepository -Name "Backups Vol2", "*Local"
Get-VBRBackupSession
Short Description
Returns a list of backup sessions that have been run.
Applies to
Syntax
Get-VBRBackupSession [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all backup, replication and backup copy sessions that have been run. You can get the list of all backup, replication and backup copy sessions, or look for instances directly by name. Run Get-VBRTaskSession to get the list of all tasks performed during the specific backup, replication or backup copy session. Run Get-VSBSession to get the list of SureBackup sessions that have been run. See what else you can perform on sessions
Return Type
CBackupSession
Parameters
Specifies the name of the backup session you want to get, or search conditions. Name The name of the session is a name of the job. You can specify multiple names separated by commas. False Named False True
Required
Position
Example 1
This command looks for the list of all backup sessions. Get-VBRBackupSession
Example 2
This command looks for all backup copy sessions. Get-VBRBackupSession -Name *Copy Job*
Get-VBRCredentials
Short Description
Returnes a list of credentials records.
Applies to
Syntax
Get-VBRCredentials [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of credentials managed by Veeam Backup & Replication. You can get the list of all credentials or look for instances directly by name. See what else you can perform on credentials
Return Type
CCredentials
Parameters
Specifies the user name or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example
This command gets the list of credentials records containing "Administrator" in the account name. Get-VBRCredentials -Name *Administrator*
Get-VBRFilesInRestorePoint
Short Description
Returns a list of all files for the selected restore point.
Applies to
Syntax
Get-VBRFilesInRestorePoint [-RestorePoint] <COib> [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet returns a list of all files for the selected restore point. You can get the list of all files in a selected restore point or look for instances directly by name. See what else you can perform on restore points
Return Type
COIBFileInfo
Parameters
RestorePoint
Specifies the restore points for which you want to get the list of files. Specifies the name of the file(s) you want to get, or search conditions. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
True
Example 1
This command gets the list of files in the last restore point of the backup named "Webservices Backup". The restore point is obtained with Get-VBRRestorePoint and piped down. Get-VBRRestorePoint -Name "Webservices Backup" | Select -Last 1 | Get-VBRFilesInRestorePoint
Example 2
This command gets the list of files in the restore point represented by the $restorepoint variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. Get-VBRFilesInRestorePoint -RestorePoint $restorepoint
Get-VBRHvProxy
Short Description
Returns a list of Hyper-V backup proxies.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Get-VBRViProxy.
Syntax
Get-VBRHvProxy [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all Hyper-V backup proxies managed by Veeam Backup & Replication. You can get the list of all Hyper-V backup proxies or look for instances directly by name. See what else you can perform on your virtual proxies Run Get-VBRJobProxy to get the list of proxies assigned to a specific job.
Return Type
CHvProxy
Parameters
Specifies the name of the Hyper-V proxy server you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all Hyper-V proxies. Get-VBRHvProxy
Example 2
This command gets the Hyper-V proxies with names containing "Local". Get-VBRHvProxy -Name *Local*
Get-VBRInstantRecovery
Short Description
Returns the instant VM recovery session running at the moment.
Applies to
Syntax
Get-VBRInstantRecovery [-Full] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns the instant VM recovery session running at the moment. You can get the information about the instant recovery sessions in short or detailed view. See what else you can perform on instant recovery
Return Type
InstantRecoveryDetails
Parameters
Specifies the information on sessions and history returned in detailed view.
Required
Position

False

False
Full
False
Named
Example
This command gets the list of the instant recovery sessions in detailed view. Get-VBRInstantRecovery -Full
Get-VBRJob
Short Description
Returns a list of created jobs.
Applies to
Syntax
Get-VBRJob [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of jobs stored in Veeam Backup & Replication database. With this cmdlet, you can get the following jobs: Backup Jobs Replication Jobs Backup Copy Jobs VM Copy Jobs File Copy Jobs
You can get the list of all jobs or look for instances directly by name. Run Get-VBRBackupSession or Get-VBRTaskSession to get the information on job session or session tasks. Run Get-VBRTapeJob to get the list of tape jobs. Run Get-VSBJob to get the list of SureBackup jobs. See what else you can perform on jobs
Return Type
CBackupJob
Parameters
Specifies the name of the job you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example
This command gets the list of backup copy jobs. Get-VBRJob -Name *Backup Copy Job*
Get-VBRJobObject
Short Description
Returns the list of objects in the specified job.
Applies to
Syntax
Get-VBRJobObject [-Job] <CBackupJob> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet returns a list of objects in the specified job. The job objects are VMs, VM containers, datastores or resource pools. You can run this cmdlet for backup, replication, backup copy, VM copy or file copy jobs. See what else you can perform on job objects
Return Type
CObjectInJob
Parameters
Job
Specifies the job you want to get the objects of. Specifies the name of the job object (i.e. a VM) you want to get, or search conditions. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
True
Example 1
This command looks for the SharePoint VMs in the job named "VM Copy Job 01". The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "VM Copy Job 01" | Get-VBRJobObject -Name *SharePoint*
Example 2
This command looks for the VM named "SharePoint" in the job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehend. Get-VBRJobObject -Job $job -Name "SharePoint"
Get-VBRJobObjectVssOptions
Short Description
Returns a list of VSS settings set for specific VM in job.
Applies to
Syntax
Get-VBRJobObjectVssOptions [-ObjectInJob] <CObjectInJob> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJobObject
This cmdlet returns a list of VSS settings set for specific VM in the job. VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently. Run Get-VBRJobVSSOptions to get the list of VSS options of a specific job. See what else you can perform on job objects
Return Type
CVssOptions
Parameters
ObjectInJob
Specifies the VMs or VM containers for which you want to get VSS options.
True
False
Example 1
This command looks for the VSS settings of the first VM included in job named "Exchange Backup Copy". The job to look for the VM in is obtained with Get-VBRJob and piped down. The VM is obtained with Get-VBRJobObject by selecting the first VM in the job object list and piped down. Get-VBRJob -Name "Exchange Backup Copy" | Get-VBRJobObject | Select -First 1 | Get-VBRJobObjectVssOptions
Example 2
This command looks for the VSS settings of the VM represented by the $vm variable. The VM is obtained with Get-VBRJobObject and assigned to the variable beforehand. Get-VBRJobObjectVssOptions -ObjectInJob $vm
Get-VBRJobOptions
Short Description
Returns a list of job settings.
Applies to
Syntax
Get-VBRJobOptions [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet returns a list of job settings for a selected job. See what else you can perform on job options
Return Type
CJobOptions
Parameters
Job
Specifies the job you want to get the options of.
True
False
Example 1
This command looks for the list of options of the job named "Fileserver Replica". The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Fileserver Replica" | Get-VBRJobOptions
Example 2
This command looks for the list of options of the job represented by the $"Fileserver Replica" variable. The job is obtained with Get-VBRJobObject and assigned to the variable beforehand. Get-VBRJobOptions -Job $"Fileserver Replica Job"
Get-VBRJobProxy
Short Description
Returns the list of proxy servers assigned to a selected job.
Applies to
Syntax
Get-VBRJobProxy -Job <CBackupJob[]> [-Target] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet returns the list of source or target proxy servers assigned to a selected job. You will see the notification if the automatic proxy selection is enabled. See what else you can perform on job assigned proxies Run Get-VBRViProxy or Get-VBRHvProxy to get a list of all VMware or Hyper-V proxies managed by Veeam Backup & Replication.
Return Type
CViProxy or CHvProxy
Parameters
Specifies the job for which you want to get the list proxies. You can assign multiple backup jobs to this object. If set, the command returns the list of target proxy servers. If omitted, the command returns the list of source proxy servers.
Required
Position

Job
True
Named
False
Target
False
Named
False
False
Example 1
This command looks for the list of target proxies assigned to the job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | Get-VBRJobProxy -Target
Example 2
This command looks for the list of source proxies assigned to the job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | Get-VBRJobProxy
Example 3
This command looks for the list of target proxies represented by the $"Job 1" variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Get-VBRJobProxy -Job $"Job 1"
Get-VBRJobScheduleOptions
Short Description
Returns a list of scheduling settings for a selected job.
Applies to
Syntax
Get-VBRJobScheduleOptions [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet returns a list of job scheduling options for a selected job. See what else you can perform on job options
Return Type
ScheduleOptions
Parameters
Job
Specifies the job you want to get the scheduling options of.
True
False
Example 1
This command looks for the list of schedulling options of the job named "ActiveDirectory Copy Job". The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "ActiveDirectory Copy Job" | GetVBRJobScheduleOptions
Example 2
This command looks for the list of options of the job represented by the $"ActiveDirectory Copy Job" variable. The job is obtained with Get-VBRJobObject and assigned to the variable beforehand. Get-VBRJobScheduleOptions -Job $"ActiveDirectory Copy Job"
Get-VBRJobVSSOptions
Short Description
Returns a list of VSS settings for a selected job.
Applies to
Syntax
Get-VBRJobVSSOptions [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet returns a list of VSS settings for a selected job. See what else you can perform on job options Run Get-VBRJobObjectVssOptions to get the list of VSS options set for specific objects in a job.
Return Type
CVssOptions
Parameters
Job
Specifies the job you want to get the VSS options of.
True
False
Example 1
This command looks for the list of VSS options of the job named "ActiveDirectory Backup". The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "ActiveDirectory Backup" | Get-VBRJobVSSOptions
Example 2
This command looks for the list of options of the job represented by the $ad_backup variable. The job is obtained with Get-VBRJobObject and assigned to the variable beforehand. Get-VBRJobVSSOptions -Job $ad_backup
Get-VBRLocalhost
Short Description
Returns returns the local server Veeam Backup & Replication is installed on.
Applies to
Syntax
Get-VBRLocalhost [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
This cmdlet returns the local server Veeam Backup & Replication is installed on. See what else you can perform on your virtual infrastructure instances
Return Type
CHost <CommonParameters> This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
This command looks for the local Veeam Backup & Replication server. Get-VBRLocalhost
Get-VBRReplica
Short Description
Returns the list of replicated VMs.
Applies to
Syntax
Get-VBRReplica [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns the list of replicated VMs managed by Veeam Backup & Replication. See what else you can perform on replicas
Return Type
CBackup
Parameters
Specifies the name of the replication job you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for all replicas managed by Veeam Backup & Replication. Get-VBRReplica
Example 2
This command looks for the replicas with names starting with "DC". Get-VBRReplica -Name DC*
Get-VBRRestorePoint
Short Description
Returns the list of restore points.
Applies to
Syntax
Get-VBRRestorePoint [[-Backup] <CBackup[]>] [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackup
This cmdlet returns a list of restore points stored in Veeam Backup & Replication database. You can get the list of restore points of all VMs managed by Veeam Backup & Replication, or get the restore points for a specific backup or for a specific VM. See what else you can perform on restore points
Return Type
COib
Parameters
Specifies the backup for which you want to get the restore points. You can assign multiple backups to this object. Specifies the name of the VM for which you want to get the restore points, or search conditions. You can specify multiple names separated by commas.
Required
Position

Backup
False
False
Name
False
Named
False
True
Example 1
This command looks for the latest restore point of the VM named "MSExchange02" in the backup named "MSExchange Backup". The backup is obtained with Get-VBRBackup and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. Get-VBRBackup -Name "MSExchange Backup" | Get-VBRRestorePoint Name *MSExchange02* | Sort-Object $_.creationtime -Descending | Select -First 1
Example 2
This command looks for the restore points of the backup represented by the variable $backup. The backup to look the restore points in is obtained with Get-VBRBackup and assigned to the variable beforehand. Get-VBRRestorePoint -Backup $backup
Get-VBRRestoreSession
Short Description
Returns the list of restore sessions.
Applies to
Syntax
Get-VBRRestoreSession [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all restore sessions stored in Veeam Backup & Replication database. You can get the list of all restore sessions or get the restore sessions of a specific VM or VM(s). See what else you can perform on restore See what else you can perform on sessions
Return Type
CRestoreSession
Parameters
Specifies the name of the VM you want to get the restore session of, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for all restore sessions stored in the database. Get-VBRRestoreSession
Example 2
This command looks for the restore sessions of the VMs named "Hv_DNS" and "Hv_DC". Get-VBRRestoreSession -Name "Hv_DNS", "Hv_DC"
Get-VBRServer
Short Description
This cmdlet returns a list of all hosts connected to Veeam Backup & Replication.
Applies to
Syntax
Get-VBRServer [-Type <CDBHost+EType>] [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all hosts connected to Veeam Backup & Replication. You can get the list of all hosts or narrow down the output to the servers of specific type, or search for instances directly by name. Run Find-VBRViEntity or Find-VBRHvEntity to look for VMware or Hyper-V virtual objects registered on these hosts. See what else you can perform on your virtual infrastructure instances
Return Type
CHost
Parameters
Specifies the server type: - BackupServer - ESX - ESXi - HvCluster - HvServer Type - Linux - Local - SanHost - Scvmm - SmbCluster - SmbServer - VC - VcdSystem False Named False False
Required
Position
Parameter
Description
- Windows Specifies the name of the server you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the servers named "Active_Directory". Get-VBRServer -Name "Active_Directory"
Example 2
This command looks for the VM named "Hv_DNS" registered on a Hyper-V server. Get-VBRServer -Type HvServer -Name "Hv_DNS"
Get-VBRTapeBackup
Short Description
Returns the list of backups recorded to tape.
Applies to
Syntax
Get-VBRTapeBackup [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns the list of backups recorded to tape. Veeam Backup & Replication stores all data about the backups that were recorded to tapes in the database, and you can view the list of files both while the tapes are online, or after they were removed from the library. The backups or files that were written to tapes with Veeam Backup & Replication are indexed automatically. Run Start-VBRTapeCatalog to index the imported tapes. Run Get-VBRTapeJob to get the list of the copy to tape jobs. See what else you can perform on tapes
Return Type
Cbackup
Parameters
Specifies the name(s) of the backup or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for all backups recorded to tapes. Get-VBRTapeBackup
Example 2
This command looks for backups named "VM01" and "VM05". Get-VBRTapeBackup -Name "VM01", "VM05"
Get-VBRTapeDrive
Short Description
Returns the list of tape drives.
Applies to
Syntax
Get-VBRTapeDrive [-Library <TapeLibrary>] [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
This cmdlet returns the list of tape recording drives. You can also view the model name, the state of the drive and whether it is enabled or disabled. You can get the whole list of drives throughout all libraries, or the list of drives within specified library, or search for instances directly by name. See what else you can perform on tapes
Return Type
TapeDrive
Parameters
Library
Specifies the tape medium library that the tape drive belongs to. Specifies the tape drive name(s), or search conditions. You can specify multiple names separated by commas.
False
Named
False
Name
False
Named
False
True
Example 1
This command gets a tape drive named "Drive 01" in the library named "Lib HP01". The library object is obtained with Get-VBRTapeLibrary and piped down. Get-VBRTapeLibrary -Name "Lib HP01" | Get-VBRTapeDrive Name "Drive 01"
Example 2
This command gets a tape drive named "Drive 01" in the library represented by the $"Lib HP01" variable. The library object is obtained with Get-VBRTapeLibrary and assigned to the variable beforehand. Get-VBRTapeDrive -Library $"Lib HP01" -Name "Drive 01"
Get-VBRTapeJob
Short Description
Returns the list of copy to tape jobs.
Applies to
Syntax
Get-VBRTapeJob [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns the list of copy to tape jobs registered in Veeam Backup & Replication database. Run Get-VBRTapeBackup to get the list of backups recorded to tape. See what else you can perform on tapes
Return Type
CBackupJob
Parameters
Specifies the name(s) of the tape job, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all tape jobs registered in Veeam Backup & Replication database. Get-VBRTapeJob
Example 2
This command looks for tape jobs named "Fileserver 2Tape Backup Job" and "ActiveDirectory 2Tape Backup Job". Get-VBRTapeJob -Name "Fileserver 2Tape Backup Job", "ActiveDirectory 2Tape Backup Job"
Get-VBRTapeLibrary
Short Description
Returns a list of tape libraries.
Applies to
Syntax
Get-VBRTapeLibrary [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of tape media libraries connected to Veeam Backup & Replication. You can get the list of all tape libraries, or search for instances directly by name. Run Start-VBRTapeInventory to rescan the list of tape entities managed by Veeam Backup & Replication. See what else you can perform on tapes
Return Type
TapeLibrary
Parameters
Specifies the name of the tape media library, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command gets a list of all tape media libraries connected to Veeam Backup & Replication. Get-VBRTapeLibrary
Example 2
This command gets a list of tape media libraries filtering the output by name starting with "HP...". Get-VBRTapeLibrary -Name HP*
Get-VBRTapeMediaPool
Short Description
Returns a list of tape media pools.
Applies to
Syntax
Get-VBRTapeMediaPool [-Library <TapeLibrary>] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
This cmdlet returns a list of tape media pools managed by Veeam Backup & Replication. Media pools are logical groups of tapes within a tape media library which may have predefined or custom names based on purpose, recorded data, and so on. You can get the list of media pools within specified library, or search for instances directly by name. Run Start-VBRTapeInventory to rescan the list of tape entities managed by Veeam Backup & Replication. See what else you can perform on tapes
Return Type
MediaPool
Parameters
Library
Specifies the library that the media pool belongs to. Specifies the name(s) of the tape media library the media pool belongs to. You can specify multiple names separated by commas.
False
Named
False
Name
False
Named
False
True
Example 1
This command looks for the list of media pools in the "Lib HP01" library. The library object is obtained with Get-VBRTapeLibrary and piped down. Get-VBRTapeLibrary -Name "Lib HP01" | Get-VBRTapeMediaPool
Example 2
This command looks for the media pool named "Incremental Backups" in the library represented by the $"Lib HP01" variable. The library object is obtained with Get-VBRTapeLibrary and assigned to the variable beforehand. Get-VBRTapeMediaPool -Library $"Lib HP01" -Name "Incremental Backups'
Get-VBRTapeMedium
Short Description
Returns a list of tapes.
Applies to
Syntax
Get-VBRTapeMedium [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-VBRTapeMedium [-Free] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-VBRTapeMedium [-Unrecognized] [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-VBRTapeMedium [-Offline] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-VBRTapeMedium [-Online] [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-VBRTapeMedium -Backup <CBackup> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-VBRTapeMedium -MediaPool <MediaPool> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] Get-VBRTapeMedium -Library <TapeLibrary> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackup Get-VBRTapeMediaPool Get-VBRTapeLibrary
This cmdlet returns a list of tapes managed by Veeam Backup & Replication. You can get the full list of tapes or narrow down the output by name, by type (Free, Unrecognized,Offline, Online), by media pool or by tape library, or look for tapes containing a specific backup. Run Start-VBRTapeInventory to rescan the list of tape entities managed by Veeam Backup & Replication.
See what else you can perform on tapes
Return Type
TapeMedium
Parameters
Specifies the name of tape you want to get. Name You can specify multiple names separated by commas. Narrows down your search conditions to the Free tapes. Narrows down your search conditions to the Unrecognized tapes. Narrows down your search conditions to the Offline tapes. Narrows down your search conditions to the Online tapes. Specifies the backup you want to get. You will get a tape or a list of tapes where the backup data is stored. Specifies the media pool within which you want to look for the tapes. Specifies the tape library within which you want to look for the tapes. False Named False True
Required
Position
Free
False
Named
False
False
Unrecognized
False
Named
False
False
Offline
False
Named
False
False
Online
False
Named
False
False
Backup
True
Named
False
MediaPool
True
Named
False
Library
True
Named
False
Example 1
The following command gets a tape named "00110001". Get-VBRTapeMedium -Name "00110001"
Example 2
The following command gets a tape with the barcode "00233400". Get-VBRTapeMedium | Where-Object {$_.barcode -eq "00233400"}
Example 3
This command looks for the list of tapes belonging to the media pool named "Incremental Backups". The media pool is obtained with Get-VBRTapeMediaPool and piped down. Get-VBRTapeMediaPool -Name "Incremental Backups" | GetVBRTapeMedium
Get-VBRTaskSession
Short Description
Returns list of tasks performed during a specified session.
Applies to
Syntax
Get-VBRTaskSession [-Session] <CBackupSession> [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
This cmdlet returns a list of all tasks performed during the specified session. You can get the tasks for backup, replication and backup copy sessions. Run Get-VSBTaskSession to get the tasks for SureBackup session. See what else you can perform on sessions
Return Type
CBackupTaskSession
Parameters
Session
Specifies the session the tasks of which you want to get. Specifies the name of the job object within the session you indicated in -Session parameter the tasks for which you want to get. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
True
Example 1
This command gets the list of tasks performed for the VMs named "DC" and "DNS" in the backup job session named "Exchange Backup". The backup session is obtained with Get-VBRBackupSession and piped down. Get-VBRBackupSession -Name "Exchange Backup" | Get-VBRTaskSession -Name "DC", "DNS"
Example 2
This command gets the list of tasks performed for the VMs named "DC" and "DNS" in the backup job session represented by the $"Exchange Session" variable. The backup session is obtained with GetVBRBackupSession and assigned to the variable beforehand. Get-VBRTaskSession -Session $"Exchange Session" -Name "DC", "DNS"
Get-VBRToolkitDocumentation
Short Description
Opens Veeam Backup & Replication Help.
Applies to
Syntax
Get-VBRToolkitDocumentation
This cmdlet opens Veeam Backup & Replication Help in a separate window.
Get-VBRViProxy
Short Description
Returns VMware backup proxies.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Get-VBRHvProxy.
Syntax
Get-VBRViProxy [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all VMware backup proxies managed by Veeam Backup & Replication. See what else you can perform on your virtual proxies Run Get-VBRJobProxy to get the list of proxies assigned to a specific job.
Return Type
CViProxy
Parameters
Specifies the name of the VMware proxy you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all VMware proxies. Get-VBRViProxy
Example 2
This command looks for the proxy named "LocalProxy". Get-VBRViProxy -Name "LocalProxy"
Short Description
Returnes the list of WAN accelerators.
Applies to
Syntax
Get-VBRWANAccelerator [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet gets the list of WAN accelerators managed by Veeam Backup & Replication. WAN accelerator is an architecture component that optimizes file transfer via WAN by means of data deduplication. The role of a WAN accelerator can be assigned to a dedicated Windows-based machine (physical or virtual). For best performance you should set a WAN accelerator on both source and target sides. You can get the list of all WAN accelerators, or search for instances directly by name. See what else you can perform on backup copy
Return Type
CwanAccelerator
Parameters
Specifies the name(s) of the WAN accelerator, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all WAN accelerators. Get-VBRWANAccelerator
Example 2
This command looks for WAN accelerators with the names starting with "WAN". Get-VBRWANAccelerator -Name WAN*
Get-VSBApplicationGroup
Short Description
Returns the list of application groups.
Applies to
Syntax
Get-VSBApplicationGroup [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns the list of all created application groups. An application group is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database.To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The VMs in the application group are started first to ensure the proper testing environment for the primary VM. You can get the list of all application groups, or search for instances directly by name. See what else you can perform on SureBackup
Return Type
CSbAppGroup
Parameters
Specifies the name of the application group you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all application groups. Get-VSBApplicationGroup
Example 2
This command looks for the application group named "MailServer Appgroup". Get-VSBApplicationGroup -Name "MailServer Appgroup"
Get-VSBHvVirtualLab
Short Description
Returns a list of Hyper-V virtual labs.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Get-VSBVirtualLab.
Syntax
Get-VSBVirtualLab [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns all Hyper-V virtual labs that are connected to Veeam Backup & Replication console. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database.To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. Please note, that when you add a new host to your Veeam Backup & Replication console, the virtual labs that are registered on it are not added automatically. Run Connect-VSBHvVirtualLab to add the virtual labs to your Veeam Backup & Replication console. You can get the list of all virtual labs, or search for instances directly by name. See what else you can perform on SureBackup
Return Type
CHvSbVirtualLab
Parameters
Specifies the name(s) of the virtual lab, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
False
True
Example 1
This command looks for the list of all virtual labs created or connected to Veeam Backup & Replication. Get-VSBHvVirtualLab
Example 2
This command looks for the list of virtual labs with names starting with "Exchange". Get-VSBHvVirtualLab -Name Exchange*
Get-VSBJob
Short Description
Returns a list of SureBackup jobs.
Applies to
Syntax
Get-VSBJob [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all created SureBackup jobs. SureBackup is a Veeam recovery verification technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. You can get the list of all SureBackup jobs or look for specific jobs directly by name. Run Get-VSBSession or Get-VSBTaskSession to get the information on SureBackup session or session tasks. Run Get-VBRJob to look for backup, replication or copy jobs. See what else you can perform on SureBackup See what else you can perform on jobs
Return Type
CSbJob
Parameters
Specifies the name of the SureBackup job you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all created SureBackup jobs. Get-VSBJob
Example 2
This command looks for the SureBackup jobs named "SureJob 01" and "SureJob 02". Get-VSBJob -Name "SureJob 01", "SureJob 02"
Get-VSBJobOptions
Short Description
Returns a list of settings of a selected SureBackup job.
Applies to
Syntax
Get-VSBJobOptions [-Job] <CSbJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
This cmdlet returns a list of job settings for the specified SureBackup job. See what else you can perform on job options See what else you can perform on SureBackup
Return Type
CDRJobOptions
Parameters
Job
Specifies the SureBackup job you want to get the settings of.
True
False
Example 1
This command looks for the list of job settings for the SureBackup job named "SureJob 02". The SureBackup job is obtained with Get-VSBJob and piped down. Get-VSBJob -Name "SureJob 02" | Get-VSBJobOptions
Example 2
This command looks for the list of job settings for the SureBackup job represented by the $SureJob variable. The SureBackup job is obtained with Get-VSBJob and assigned to the variable beforehand. Get-VSBJobOptions -Job $SureJob
Get-VSBJobScheduleOptions
Short Description
Returns a list of scheduling settings of a selected SureBackup job.
Applies to
Syntax
Get-VSBJobScheduleOptions [-Job] <CSbJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
This cmdlet returns a list of job scheduling options for the specified SureBackup job. See what else you can perform on job options See what else you can perform on SureBackup
Return Type
ScheduleOptions
Parameters
Job
Specifies the SureBackup job you want to get the scheduling settings of.
True
False
Example 1
This command looks for the list of job settings for the SureBackup job named "SureJob 02". The SureBackup job is obtained with Get-VSBJob and piped down. Get-VSBJob -Name "SureJob 02" | Get-VSBJobScheduleOptions
Example 2
This command looks for the list of job settings for the SureBackup job represented by the $SureJob variable. The SureBackup job is obtained with Get-VSBJob and assigned to the variable beforehand. Get-VSBJobScheduleOptions -Job $SureJob
Get-VSBSession
Short Description
Returns a list of SureBackup sessions that have been run.
Applies to
Syntax
Get-VSBSession [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns a list of all SureBackup sessions that have been run. Run Get-VSBTaskSession to get the list of all tasks performed during the specific SureBackup session. Run Get-VBRBackupSession to get list of backup sessions that have been run. See what else you can perform on SureBackup See what else you can perform on sessions
Return Type
CSbSession
Parameters
Specifies the name of the SureBackup session you want to get, or search conditions. Name The name of the SureBackup session is a name of the SureBackup job. You can specify multiple names separated by commas. False Named False True
Required
Position
Example 1
This command looks for the list of all backup sessions. Get-VSBSession
Example 2
This command looks for the SureBackup session named "Winserver SureJob". Get-VSBSession -Name *Winserver SureJob*
Get-VSBTaskSession
Short Description
Returns a list of all tasks performed during the specified SureBackup session.
Applies to
Syntax
Get-VSBTaskSession [-Session] <CSbSession> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBSession
This cmdlet returns a list of all tasks performed during the specified SureBackup session. Run Get-VBRTaskSession to get the tasks for backup, replication and backup copy sessions. See what else you can perform on SureBackup See what else you can perform on sessions
Return Type
CSbTaskSession
Parameters
Session
Specifies the SureBackup session the tasks of which you want to get. Specifies the name of the SureBackup job object within the session you indicated in Session parameter the tasks for which you want to get. You can specify multiple names separated by commas.
True
False
Name
False
Named
False
True
Example 1
This command gets the list of tasks performed for the VMs named "DC" and "DNS" in the SureBackup job session named "Exchange SureJob". The SureBackup session is obtained with Get-VSBSession and piped down. Get-VSBSession -Name "Exchange SureJob" | Get-VBRTaskSession Name "DC", "DNS"
Example 2
This command gets the list of tasks performed for the VMs named "DC" and "DNS" in the SureBackup job session represented by the $"Exchange SureJob" variable. The SureBackup session is obtained with Get-VSBSession and assigned to the variable beforehand. Get-VSBTaskSession -Session $"Exchange SureJob" -Name "DC", "DNS"
Get-VSBVirtualLab
Short Description
Returns the list of VMware virtual labs.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Get-VSBHvVirtualLab.
Syntax
Get-VSBVirtualLab [-Name <String[]>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet returns the list of all created VMware virtual labs. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. Please note, that when you add a new host to your Veeam Backup & Replication console, the virtual labs that are registered on it are not added automatically. Run Connect-VSBVirtualLab to add the virtual labs to your Veeam Backup & Replication console. You can get the list of all virtual labs, or search for instances directly by name. See what else you can perform on SureBackup
Return Type
CViSbVirtualLab
Parameters
Specifies the name of the VMware virtual lab you want to get, or search conditions. You can specify multiple names separated by commas.
Required
Position
Name
False
Named
False
True
Example 1
This command looks for the list of all virtual labs. Get-VSBVirtualLab
Example 2
This command looks for the virtual labs named "MailServer VLab 01" and "MailServer VLab 05". Get-VSBVirtualLab -Name "MailServer VLab 01", "MailServer VLab 05"
Import-VBRBackup
Short Description
Imports backup files to Veeam Backup & Replication.
Applies to
Syntax
Import-VBRBackup [-Server] <CHost> [-FileName] <String> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet imports backup files to Veeam Backup & Replication. You can import backups, i.e. from a server that is not managed by Veeam Backup & Replication or after adding a new backup repository. See what else you can perform on your backup files
Parameters
Server
Specifies the target server where you want to store the imported backups. Specifies the path to the backup file you want to import.
True
False
FileName
True
False
Example 1
This command imports the folder with SureBackup files to the server named "Fileserver". The target server is obtained with Get-VBRServer and piped down. The file path is ESX17.Veeam.Local\C:\Backups\SureBackups. Get-VBRServer -Name "Fileserver" | Import-VBRBackup -FileName "ESX17.Veeam.Local\C:\Backups\SureBackups"
Example 2
This command imports the folder with SureBackup files to the server represented by the $server variable. The target server is obtained with Get-VBRServer and assigned to the variable beforehand. The file path is ESX17.Veeam.Local\C:\Backups\SureBackups. Import-VBRBackup -Server $server -FileName "ESX17.Veeam.Local\C:\Backups\SureBackups"
Import-VBRConfiguration
Short Description
Imports backup of Veeam Backup & Replication server configuration file.
Applies to
Syntax
Import-VBRConfiguration -FileName <String> [-DatabaseName <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet imports configuration file of Veeam Backup & Replication that was previously backed up. With configuration backup, you can store a copy of your host configuration: your virtual infrastructure, jobs configuration, Veeam Backup & Replication settings and other data. You can restore configuration in case the Veeam Backup & Replication host is failed or configuration is corrupted. By default, configuration backups are stored to the C:\backup\VeeamConfigBackup\%BackupServer% folder on the Veeam backup server. You can select any configuration file to restore to. You can restore configuration data to the default Veeam Backup & Replication SQL database or to another database. If you restore to the default database, it is recommended to backup the database first. Run Export-VBRConfiguration to retrieve and export your current configuration.
Parameters
Specifies the configuration file path you want to restore. Specifies the name of the database into which data from the configuration backup should be imported. If not set, the data will be restored to the Veeam Backup & Replication database set by default.
Required
Position

False

False
FileName
True
Named
DatabaseName
False
Named
False
False
Example 1
This command imports a configuration backup file named "VEEAMBACKUP-10-06-2013" to the default database. Import-VBRConfiguration -FileName "C:\backup\VeeamConfigBackup\VEEAMBACKUP\VEEAMBACKUP-10-06-2013"
Example 2
This command imports a configuration backup file named "VEEAMBACKUP-10-06-2013" to the database named "ConfigBackup". Import-VBRConfiguration -FileName "C:\backup\VeeamConfigBackup\VEEAMBACKUP\VEEAMBACKUP-10-06-2013" -DatabaseName "ConfigBackup"
Import-VBRTapeMedium
Short Description
Moves new tape to library.
Applies to
Syntax
Import-VBRTapeMedium [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORImport-VBRTapeMedium [-Library <TapeLibrary>] [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
This cmdlet moves tapes that are inserted in the mail slot to an available slot in a library. You need to put the new tapes to the mail slot manually. The slot to put the tape in is selected automatically. The mail slot is the slot through which you can put the new tapes into the library and take the tapes with data out. The mail slot is a service slot and you do not manage the tape residing inside it until it is imported to the library or after it is exported. You can move new tapes to a free slot selected automatically or to a specific library. This cmdlet provides two scenarios for each case. Use Export-VBRTapeMedium cmdlet to move tapes to the mail slot to take them out of the library. See what else you can perform on tapes
Parameters
Library
Specifies the library you want to move the tapes to. Indicates that the command returns immediately without waiting for the task to complete.
False
Named
False
RunAsync
False
Named
False
False
Example 1
This command moves the tapes from the mail slot to an automatically selected free slot. The RunAsync parameter is set to bring the process to the background. Import-VBRTapeMedium -RunAsync
Example 2
This command moves the tape from the mail slot to the library with name containing "HP Lib003". The library object is obtained with Get-VBRTapeLibrary and piped down. The -RunAsync parameter is set to bring the process to the background. Get-VBRTapeLibrary -Name "HP Lib003" | Import-VBRTapeMedium RunAsync
Move-VBRTapeMedium
Short Description
Moves a tape to another tape media pool.
Applies to
Syntax
Move-VBRTapeMedium -Medium <TapeMedium[]> -MediaPool <MediaPool> [<CommonParameters>]
Related Commands
Get-VBRTapeMedium Get-VBRTapeMediaPool
This cmdlet moves a selected tape to specified tape media pool. If you move tape with data to the Free media pool and confirm the operation, Mark as Free will take effect and the data will be overwritten. See what else you can perform on tapes Important! If a tape media is used by an existing tape\file backup job, it will be removed only after the job is finished. In case you definitely have to disable this pool, you should first modify the corresponding job to target another media pool.
Parameters
Specifies the tape(s) you want to move. You can assign multiple tapes to this object. Specifies the target media pool where you want to move the tape(s) to.
Required
Position

True (ByValue, ByProperty Name) True (ByValue, ByProperty Name)
Medium
True
Named
False
MediaPool
True
Named
False
Example 1
This command moves the tapes from the Unrecognized media pool to the media pool represented by the $pool variable. The tapes object is obtained with Get-VBRTapeMedium by selecting the tapes by Unrecognized parameter, and piped down. The target media pool is obtained with GetVBRTapeMediaPool and assigned to the variable beforehand. Get-VBRTapeMedium -Unrecognized | Move-VBRTapeMedium -MediaPool $pool
Example 2
This command moves the tape represented by the $tape variable to the media pool represented by the $pool variable. The tape object and the media pool object are obtained with Get-VBRTapeMedium and Get-VBRTapeMediaPool accordingly and assigned to the variables beforehand. Move-VBRTapeMedium -Medium $tape -MediaPool $pool
New-VBRJobOptions
Short Description
Sets job options.
Applies to
Syntax
New-VBRJobOptions [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORNew-VBRJobOptions [-ForBackupJob] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORNew-VBRJobOptions [-ForReplicaJob] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet lets you edit job settings of backup jobs, replication jobs or selected VMs. This cmdlet returns the CJobOptions object containing the default settings of the job you want to edit. You can customize any setting that you want to apply to the job. This object is then used in the Set-VBRJobOptions cmdlet. You can edit settings of jobs (including vCloud backup jobs), VMs or replication jobs by running this cmdlet with -ForJob, -ForObject or -ForReplicaJob parameters respectively. See what else you can perform on job options
Parameters
Returns the list of the default settings for backup job. Returns the list of the default settings for replication job.
Required
Position

False

False
ForBackupJob
False
Named
ForReplicaJob
False
Named
False
False
Example
This command schedules the job named "Backup Job 1" to running every 2 hours. The object with scheduling settings is assigned to the $NewScheduleOption variable. The "OptionsPeriodically" parameter is set to &True and its value is set to 120 (minutes). The job to apply the schedule is obtained with Get-VBRJob and assigned to the $job variable. The object is then applied to the job by running Set-VBRJobScheduleOptions with these two variables. $NewScheduleOption = New-VBRJobScheduleOptions $NewScheduleOption.OptionsPeriodically.Enabled = $True $NewScheduleOption.OptionsPeriodically.FullPeriod = 120 $Job = Get-VBRJob -Name "Backup Job 1" Set-VBRJobScheduleOptions -Job $Job -Options $NewScheduleOption
Short Description
Sets job schedule options.
Applies to
Syntax
New-VBRJobScheduleOptions [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
This cmdlet lets you edit scheduling settings of jobs. This cmdlet returns the ScheduleOptions object containing the default scheduling settings of the job you want to edit. You can customize any setting that you want to apply to the job. This object is then used in the Set-VBRJobScheduleOptions cmdlet. You can use the ScheduleOptions object with backup, replication or copy jobs. See what else you can perform on job options
Short Description
Sets job VSS options.
Applies to
Syntax
New-VBRJobVssOptions [-ForJob] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORNew-VBRJobVssOptions [-ForObject] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORNew-VBRJobVssOptions [-ForReplicaJob] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet lets you edit VSS settings of backup jobs, replication jobs or selected VMs. VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently. This cmdlet returns the CVssOptions object containing the VSS settings of the job you want to edit. You can customize any setting that you want to apply to the job. This object is then used in the SetVBRJobVssOptions cmdlet. You can edit settings of backup jobs (including vCloud backup jobs), Vms or replication jobs by running this cmdlet with -ForJob, -ForObject or -ForReplicaJob parameters respectively. See what else you can perform on job options
Parameters
Returns the list of the default VSS settings for backup, replication or copy job. Returns the list of the default VSS settings for VMs. Returns the list of the default VSS settings for replication job.
Required
Position
ForJob
False
Named
False
False
ForObject
False
Named
False
False
ForReplicaJob
False
Named
False
False
Example
This example helps you get the CVssOptions object with customized VSS settings for a backup job. The Enable setting is set to True, The GuestFSIndexingType setting is set to "Everyfolders", The TransactionLogsTruncation setting is set to Always.
PS C:\PS> New-VBRJobVssOptions Enabled Is Credentials GuestFS Indexing ------- --------------- ---------------False False None Never PS C:\PS> $o=New-VBRJobVssOptions PS C:\PS> $o.Enabled=$true PS C:\PS> $o.GuestFSIndexingType="Everyfolders" PS C:\PS> $o.TransactionLogsTruncation="Always" PS C:\PS> $o Enabled Is Credentials GuestFS Indexing ------- --------------- ---------------True False Everyfolders Always Transaction Logs ---------------Transaction Logs ----------------
New-VBRvCloudVAppRestoreSettings
Short Description
Creates a set of vApp restore parameters.
Applies to
Syntax
New-VBRvCloudVAppRestoreSettings [-RestorePoint] <COib> [vAppName <String>] [-OrgVdc <IVcdItem>] [-PowerUp] [-Reason <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Find-VBRvCloudEntity ([-OrganizationVdc])
This cmdlet is an assistant command creating a CVcdVAppRestoreSettings object that is further used in the Start-VBRvCloudRestoreVApp cmdlet. This object gathers the parameters of a selected vApp that will be needed for restore. The vApp that you want to restore and its parameters are derived from the specified restore point data. Use the -OrgVdc parameter to set another organization where you want to restore the vApp to. You can customize any of the parameters that are derived from the restore point. For more information, see the Advanced Setup below.
Advanced Setup
The restore parameters include the settings of the vApp, namely restore point, vApp name, Organization vDC, and VMs included, as well as the settings of the VM: restore point, storage profile, datastore and template. Each of these settings can be reset to user settings allowing to restore the vApp i.e. to another organization, or with another vApp name, or apply other storage profiles to the VMs. When applying different restore settings, it is recommended to set "null" to all VM settings that you leave unchanged to avoid conflicts when restoring the vApp to another infrastructure. For example, if the target organization has no access to the datastore that is originally set for the vApp, PowerShell will terminate your vApp restore job. If you set "null" to all VM settings, Veeam Backup & Replication will apply the default settings of the target organization. Please make sure that you set the parameters for all VMs that belong to the vApp, otherwise you will not be able to run the restore job. See what else you can perform on vCloud See what else you can perform on restore
Parameters
Specifies the restore point of the vApp you want to restore the vApp to. Specifies the name of the restored vApp. Use this parameter in case you want to restore the vApp with different name. Specifies the Organization vDC you want to restore the vApp to. If not set, the vApp will be restored to the original Organization vDC. If set to True, the vApp will be powered up right after it is restored. Otherwise, you will need to power up the vApp manually. Specifies the reason for performing restore of the selected vApp. Reason The information you provide will be saved in the session history so that you can reference it later. False Named False False
Required
Position
RestorePoint
True
False
vAppName
False
Named
False
False
OrgVdc
False
Named
False
False
PowerUp
False
Named
False
False
Example
This command creates settings for the future restore of the vApp in another Organization vDC. The $restorepoint variable contains the restore point of the vApp. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The $vdc variable contains the Organization vDC object where the vApp will be restored. The vDC object is obtained with Find-VBRvCloudEntity ([-OrganizationVdc]) and assigned to the variable beforehand. The PowerUp parameter is set to True to start the vApp automatically right after the restore.
$restoreparams = New-VBRvCloudVAppRestoreSettings -RestorePoint $restorepoint -vAppName "vApp01" -OrgVdc $Org Here you get the $restorepoint variable containing the vApp settings: vAppOib - the restore point of the vApp, OrgVdc - the organization vDataCenter where the vApp is registered, Vms - the list of VMs whithin the vApp, vAppName - the name of the vApp.
vAppOib OrgVdc Vms vAppName --------------------Veeam.Bacvup.. Veeam.Backup... {Veeam.Backup...
vApp01
You can view the properties of the VMs within the vApp by typing "$restoreparams.vms": VmOib - the VM restorepoint, StorageProfile - the VM storage profile, vCloudDatastore - the datastore that the VM uses, VmTemplate - the VM template.
VmOib StorageProfile vCloudDatastore VmTemplate ------------------ -----------------------Veeam... Name: 'Storag... Veeam.Backup.CV... You need to specify the new organization to where you want to restore the vApp. The new organization object is assigned to the $org variable. All other VM parameters are set to null. $restoreparams = New-VBRvCloudVAppRestoreSettings -RestorePoint $restorepoint -OrgVdc $Org $restoreparams.vms[0].vCloudDatastore=$null $restoreparams.vms[0].StorageProfile=$null $restoreparams.vms[0].VmTemplate=$null The $restoreparams variable now contains the data needed for the restore and can be used in the Start-VBRvCloudRestoreVApp cmdlet.
New-VSBJobOptions
Short Description
Sets SureBackup job options.
Applies to
Syntax
New-VSBJobOptions [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
This cmdlet lets you edit job settings of SureBackup jobs. This cmdlet returns the CDRJobOptions object containing the default settings of the SureBackup job you want to edit. You can customize any setting that you want to apply. This object is then used in the Set-VSBJobOptions cmdlet. See what else you can perform on job options See what else you can perform on SureBackup <CommonParameters> This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Example
This command creates a CDRJobOptions object with the following settings: The EmailNotification is enabled, The EmailNotificationAddresses is set to mailto@veeam.com, The RunningVmsNumber is set to 6, The other settings are left by default.
PS C:\PS> $sureoptions = New-VSBJobOptions PS C:\PS> $sureoptions.EmailNotification = "True" PS C:\PS> $sureoptions.EmailNotificationAddresses = "mailto@veeam.com" PS C:\PS> $sureoptions.RunningVmsNumber = 6 PS C:\PS> $sureoptions RunManually : True ShutdownTestVms : True EmailNotification : True EmailNotificationAddresses : mailto@veeam.com SnmpNotification : False LinkWithJobs : False RunningVmsNumber : 6 Validation : False SkipValidationForAppGroup : True
Remove-HP3Snapshot
Short Description
Removes a SAN snapshot.
Applies to
Syntax
Remove-HP3Snapshot -Snapshot <CSanSnapshot[]> [<CommonParameters>]
Related Commands
Get-HP3Snapshot
This cmdlet permanently removes the selected SAN snapshot from your storage system. See what else you can perform on HP 3PAR instances
Parameters
Specifies the snapshot(s) you want to remove. You can assign multiple snapshots to this object.
Required
Position

Snapshot
True
Named
False
Example 1
This command removes the snapshot named "vol1_SS_1". The snapshot object is obtained with GetHP3Snapshot and piped down. Get-HP3Snapshot -Name "vol1_SS_1" | Remove-HP3Snapshot
Example 2
This command removes the snapshot represented by the $"snapshot1" variable. The snapshot object is obtained with Get-HP3Snapshot and assigned to the variable beforehand. Remove-HP3Snapshot -Snapshot $"snapshot1"
Remove-HP3Storage
Short Description
Removes a SAN storage from Veeam Backup & Replication.
Applies to
Syntax
Remove-HP3Storage -Storage <CHp3PARHost> [<CommonParameters>]
Related Commands
Get-HP3Storage
This cmdlet removes the selected SAN storage from Veeam Backup & Replication. The SAN storage is not deleted from server. When you remove a SAN storage, you stop managing it via your Veeam Backup & Replication console. See what else you can perform on HP 3PAR instances
Parameters
Storage
Specifies the storage you want to remove.
True
Named
False
Example 1
This command removes the storage named "HP Store 01". The storage object is obtained with GetHP3Storage and piped down. Get-HP3Storage -Name "HP Store 01" | Remove-HP3Storage
Example 2
This command removes the storage represented by the $"store01" variable. The storage object is obtained with Get-HP3Storage and assigned to the variable beforehand. Remove-HP3Storage -Storage $"store01"
Remove-HP4Snapshot
Short Description
Removes a SAN snapshot.
Applies to
Syntax
Remove-HP4Snapshot -Snapshot <CSanSnapshot[]> [<CommonParameters>]
Related Commands
Get-HP4Snapshot
This cmdlet permanently removes the selected SAN snapshot from your storage system. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Remove-VBRHPSnapshot
Parameters
Specifies the snapshot(s) you want to remove. You can assign multiple snapshots to this object.
Required
Position

Snapshot
True
Named
False
Example 1
This command removes the snapshot named "vol1_SS_1". The snapshot object is obtained with GetHP4Snapshot and piped down. Get-HP4Snapshot -Name "vol1_SS_1" | Remove-HP4Snapshot
Example 2
This command removes the snapshot represented by the $"snapshot1" variable. The snapshot object is obtained with Get-HP4Snapshot and assigned to the variable beforehand. Remove-HP4Snapshot -Snapshot $"snapshot1"
Remove-HP4Storage
Short Description
Removes a SAN storage from Veeam Backup & Replication.
Applies to
Syntax
Remove-HP4Storage -Storage <CHpP4Group> [<CommonParameters>]
Related Commands
Get-HP4Storage
This cmdlet removes the selected SAN storage from Veeam Backup & Replication. The SAN storage is not deleted from server. When you remove a SAN storage, you stop managing it via your Veeam Backup & Replication console. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Remove-VBRHPStorage
Parameters
Storage
Specifies the storage you want to remove.
True
Named
False
Example 1
This command removes the storage named "HP Store 01". The storage object is obtained with GetHP4Storage and piped down. Get-HP4Storage -Name "HP Store 01" | Remove-HP4Storage
Example 2
This command removes the storage represented by the $"store01" variable. The storage object is obtained with Get-HP4Storage and assigned to the variable beforehand. Remove-HP4Storage -Storage $"store01"
Remove-VBRBackup
Short Description
Removes a selected backup.
Applies to
Syntax
Remove-VBRBackup [-Backup] <CBackup[]> [-FromDisk] [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRBackup
This cmdlet removes a selected backup. You can remove the backup file completely from disk, or only delete the backup information from Veeam Backup & Replication database. This cmdlet provides syntax for both scenarios accordingly. Please note that you should remove the backup files carefully considering the subsequent backup jobs that may fail to produce valid backup. See what else you can perform on your backup files
Parameters
Specifies the backup you want to remove. You can assign multiple backups to this object. If indicated, the backup file will be permanently removed from disk. Otherwise, only the information about the backup is deleted from database.
Required
Position

Backup
True
False
FromDisk
False
Named
False
False
Example 1
This command removes the backups named "Backup Job 01" and "Backup Job 02" from database only. The backups are obtained with Get-VBRBackup and piped down. Get-VBRBackup -Name "Backup Job 01", "Backup Job 02" | RemoveVBRBackup
Example 2
This command removes the backups with names ending with "2012" from disk. The backups are obtained with Get-VBRBackup and piped down. Get-VBRBackup -Name *2012 | Remove-VBRBackup -FromDisk
Example 3
This command removes the backup represented by the $backup variable from disk. The backup is obtained with Get-VBRBackup and assigned to the variable beforehand. Remove-VBRBackup $backup -FromDisk
Remove-VBRBackupRepository
Short Description
Removes a specified backup repository from Veeam Backup & Replication.
Applies to
Syntax
Remove-VBRBackupRepository -Repository <CBackupRepository[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRBackup
This cmdlet allows you to remove the specified backup repository from Veeam Backup & Replication. When you remove a backup repository, Veeam Backup & Replication unassigns the repository role from the server, so it is no longer used as a backup destination. The actual server remains connected to Veeam Backup & Replication. See what else you can perform on backup repositories
Parameters
Repository
Specifies the backup repository you want to remove.
True
Named
False
Example 1
This command removes the backup repository named "Local Repository 01". The repository is obtained with Get-VBRBackupRepository and piped down. Get-VBRBackupRepository -Name "Local Repository 01" | RemoveVBRBackupRepository
Example 2
This command removes the backup repository represented by the $repository variable. The repository is obtained with Get-VBRBackupRepository and assigned to the variable beforehand. Remove-VBRBackupRepository $repository
Remove-VBRBackupSession
Short Description
Removes a specified backup session.
Applies to
Syntax
Remove-VBRBackupSession [-Session] <CBackupSession[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
This cmdlet removes specified backup session from Veeam Backup & Replication. See what else you can perform on sessions
Parameters
Specifies the backup session you want to remove. You can assign multiple sessions to this object.
Required
Position

Session
True
False
Example 1
This command removes the backup session named "Fileserver Backup". The backup session is obtained with Get-VBRBackupSession and piped down. Get-VBRBackupSession -Name "Fileserver Backup" | RemoveVBRBackupSession
Example 2
This command removes the backup session named "Fileserver Backup". The backup session is obtained with Get-VBRBackupSession and assigned to the variable beforehand. Remove-VBRBackupSession -Session $"Fileserver Backup"
Remove-VBRCredentials
Short Description
Removes a credentials record from Veeam Backup & Replication.
Applies to
Syntax
Remove-VBRCredentials -Credential <CCredentials> [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet permanently removes the selected credentials from the database. See what else you can perform on credentials
Parameters
Credential
Specifies the credentials you want to remove.
True
Named
False
Example 1
This command permanently removes the credentials record with name "Administrator". The credentials object is obtained with Get-VBRCredentials and piped down. Get-VBRCredentials -Name Administrator | Remove-VBRCredentials
Example 2
This command removes the credentials record. The credentials object is obtained with GetVBRCredentials and assigned to $c variable beforehand. Remove-VBRCredentials -Credential $c
Remove-VBRHvProxy
Short Description
Removes a specified Hyper-V backup proxy from Veeam Backup & Replication.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Remove-VBRViProxy.
Syntax
Remove-VBRHvProxy -Proxy <CHvProxy[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRHvProxy
This cmdlet allows you to remove the specified Hyper-V backup proxy from Veeam Backup & Replication. When you remove a backup proxy, Veeam Backup & Replication unassigns the proxy role from the server, so it is no longer used as a backup proxy. The actual server remains connected to Veeam Backup & Replication. See what else you can perform on your virtual proxies Note: You cannot remove a backup proxy that is explicitly selected in any backup, replication or VM copy job. To remove such a proxy, you need to delete all job references to it first. Run Disable-VBRHvProxy to disable a Hyper-V proxy.
Parameters
Proxy
Specifies the Hyper-V backup proxy you want to remove.
True
Named
False
Example 1
This command removes the proxies named "Proxy 01" and "Proxy 03". The proxies are obtained with Get-VBRHvProxy and piped down. Get-VBRHvProxy -Name "Proxy 01", "Proxy 03"| Remove-VBRHvProxy
Example 2
This command removes the proxy represented by the $proxy variable. The proxy is obtained with GetVBRHvProxy and assigned to the variable beforehand. Remove-VBRHvProxy -Proxy $proxy
Remove-VBRJob
Short Description
Removes a selected backup, replication or backup copy job.
Applies to
Syntax
Remove-VBRJob [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet removes a selected backup, replication or backup copy job from Veeam Backup & Replication console and database. Run Remove-VSBJob to remove SureBackup jobs. See what else you can perform on jobs
Parameters
Specifies the job you want to remove. You can assign multiple jobs to this object.
Required
Position

Job
True
False
Example 1
This command removes the file copy jobs. The jobs to remove are obtained with Get-VBRJob and piped down. Get-VBRJob -Name "File Copy*" | Remove-VBRJob
Example 2
This command removes the job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehand. Remove-VBRJob -Job $job
Remove-VBRJobObject
Short Description
Removes VMs or VM containers from the specified job.
Applies to
Syntax
Remove-VBRJobObject [-Objects] <CObjectInJob[]>
Related Commands
Get-VBRJobObject
This cmdlet allows you to remove VMs or VM containers from existing backup, replication or copy job. See what else you can perform on job objects
Parameters
Objects
Specifies objects (VMs and VM containers) you want to remove.
True
False
Remove-VBRReplica
Short Description
Removes a selected replica.
Applies to
Syntax
Remove-VBRReplica [-Backup] <CBackup[]> [-FromDisk] [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRReplica
This cmdlet removes a selected replicated VM. You can delete the replica completely, or only remove it from Veeam Backup & Replication managing console. In the latter case, you will not delete the VM but only stop managing it with Veeam Backup & Replication; the replica VM will stay on target host. When replica is created, Veeam Backup & Replication maintains it in sync with the original VM by running the replication job. When you delete a replica from your managing console, it is no longer synchronized. To stop synchronizing a replica without deleting it from the console, you need to stop or delete the corresponding replication job. Run Stop-VBRJob or Remove-VBRJob to stop or remove a replication job. See what else you can perform on replicas Note: When you remove a replica from Veeam Backup & Replication console, you can not bring it back by means of PowerShell. Use replica seeding option in Veeam Backup & Replication console interface to restore a removed replica in your managing console.
Parameters
Specifies the replica you want to remove. You can assign multiple replicas to this object. If indicated, the replicated VM will be permanently removed from disk. Otherwise, you only exclude the replica from processing with Veeam Backup & Replication.
Required
Position

Backup
True
False
FromDisk
False
Named
False
False
Example 1
This command removes the replicas named "DC_replica01" and "DC_replica02" from Veeam Backup & Replication. The replicated VMs are obtained with Get-VBRReplica and piped down. Get-VBRReplica -Name "DC_replica01", "DC_replica02" | RemoveVBRReplica
Example 2
This command removes the replicas named "DC_replica01" and "DC_replica02" from disk. The replicated VMs are obtained with Get-VBRReplica and piped down. Get-VBRReplica -Name "DC_replica01", "DC_replica02" | RemoveVBRReplica -FromDisk
Example 3
This command removes the replicated VM represented by the $replica variable from disk. The replicated VM is obtained with Get-VBRReplica and assigned to the variable beforehand. $replica | Remove-VBRReplica -FromDisk
Remove-VBRRestorePoint
Short Description
Removes a restore point.
Applies to
Syntax
Remove-VBRRestorePoint [-Oib] <COib[]> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet allows you to remove restore points from Veeam Backup & Replication. See what else you can perform on restore points
Parameters
Specifies the restore point(s) you want to remove. You can assign multiple restore point to this object. Specifies the name of the VM the restore points of which you want to remove, or search conditions. You can specify multiple names separated by commas.
Required
Position

Oib
True
False
Name
False
Named
False
Truse
Example 1
This command removes the increment restore points from all backups with names containing "Fileserver". The restore points are obtained with Get-VBRRestorePoint and piped down. Get-VBRRestorePoint -Name *Fileserver* | Where {$_.type -eq "Increment"} | Remove-VBRRestorePoint
Example 2
This command removes the restore point represented by the $restorepoint variable. The restore point object is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. Remove-VBRRestorePoint -Oib $restorepoint
Remove-VBRRestoreSession
Short Description
Removes a restore session.
Applies to
Syntax
Remove-VBRRestoreSession [-Session] <CRestoreSession[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestoreSession
This cmdlet removes the specified restore session from Veeam Backup & Replication. See what else you can perform on restore See what else you can perform on sessions
Parameters
Session
Specifies the restore session you want to remove.
True
False
Example 1
This command removes the last restore session of the VM named "Fileserver". The restore session is obtained with Get-VBRRestoreSession and piped down. Get-VBRRestoreSession -Name "Fileserver 03" | Select -Last 1 | Remove-VBRRestoreSession
Example 2
This command removes the restore session represented by the $session variable. The restore session object is obtained with Get-VBRRestoreSession and assigned to the variable beforehand. Remove-VBRRestoreSession -Session $session
Remove-VBRServer
Short Description
Removes a selected server from Veeam Backup & Replication.
Applies to
Syntax
Remove-VBRServer [-Server] <CHost[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet removes a specified VMware or Hyper-V host from Veeam Backup & Replication. When you remove a host, you only stop managing it via your Veeam Backup & Replication console. The host is not deleted as well as data stored on it, i.e. the backup files. You can import these backup files later to the Veeam Backup & Replication console by running Import-VBRBackup. Please note that when you remove virtual hosts from your Veeam Backup & Replication managing console, the backups of the removed hosts stay in the Veeam Backup & Replication database and repository. See what else you can perform on your virtual infrastructure instances Note: A server that has any dependencies cannot be deleted. For example, you cannot delete a server that is referenced by a backup or replication job, or that performs the role of a backup proxy or repository. To remove such a server, you will need to delete all referencing jobs or objects first.
Parameters
Specifies the server you want to remove. You can assign multiple servers to this object.
Required
Position

Server
True
False
Example 1
This command removes a Virtual Center named "vCenter01". The server is obtained with GetVBRRestoreSession, selected by -Type and -Name parameters, and piped down. Get-VBRServer -Type VC -Name vCenter01 | Remove-VBRServer
Example 2
This command removes the server represented by the $session variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Remove-VBRServer -Server $server
Remove-VBRTapeMediaPool
Short Description
Removes a media pool from Veeam Backup & Replication.
Applies to
Syntax
Remove-VBRTapeMediaPool -MediaPool <MediaPool[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMediaPool
This cmdlet excludes a selected media pool from Veeam Backup & Replication. Media pool is a logical group of tapes. Media pools are pre-defined service pools and custom pools used as targets for backup to tape and files to tape jobs. See what else you can perform on tapes Important! You can only delete custom media pools; predefined media pools cannot be deleted. You cannot delete a media pool that contains tapes. To be able to delete such a pool, first move tapes from this pool to other media pools. You cannot delete media pools used by an existing backup/files to tape copy job. In case you definitely have to disable this pool, you should first modify the corresponding job to target another media pool.
Parameters
Specifies the media pool(s) you want to remove. You can assign multiple media pools to this object.
Required
Position

MediaPool
True
Named
False
Example 1
This command removes the media pool named "Winserver MediaPool". The media pool is obtained with Get-VBRTapeMediaPool and piped down. Get-VBRTapeMediaPool -Name "Winserver MediaPool" | RemoveVBRTapeMediaPool
Example 2
This command removes the media pool represented by the $pool variable. The media pool is obtained with Get-VBRTapeMediaPool and assigned to $pool variable beforehand. Remove-VBRTapeMediaPool -MediaPool $pool
Remove-VBRViProxy
Short Description
Removes VMware backup proxy from Veeam Backup & Replication.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Remove-VBRHvProxy.
Syntax
Remove-VBRViProxy -Proxy <CViProxy[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRViProxy
This cmdlet removes the specified VMware backup proxy from Veeam Backup & Replication. When you remove a backup proxy, Veeam Backup & Replication unassigns the proxy role from the server, so it is no longer used as a backup proxy. The actual server remains connected to Veeam Backup & Replication. See what else you can perform on your virtual proxies Note: You cannot remove a backup proxy that is explicitly selected in any backup, replication or VM copy job. To remove such a proxy, you need to delete all job references to it first. Run Disable-VBRViProxy to disable a VMware proxy.
Parameters
Proxy
Specifies the proxy you want to remove.
True
Named
False
Example 1
This command removes the proxies named "Proxy 01" and "Proxy 03". The proxies are obtained with Get-VBRViProxy and piped down. Get-VBRViProxy -Name "Proxy 01", "Proxy 03"| Remove-VBRViProxy
Example 2
This command removes the proxy represented by the $proxy variable. The proxy is obtained with GetVBRViProxy and assigned to the variable beforehand. Remove-VBRViProxy -Proxy $proxy
Remove-VBRWANAccelerator
Short Description
Removes a WAN accelerator.
Applies to
Syntax
Remove-VBRWANAccelerator -Accelerator <CWanAccelerator> [<CommonParameters>]
Related Commands
This cmdlet removes the selected WAN accelerator. WAN accelerator is an architecture component that optimizes file transfer via WAN by means of data deduplication. The role of a WAN accelerator can be assigned to a dedicated Windows-based machine (physical or virtual). For best performance you should set a WAN accelerator on both source and target sides. See what else you can perform on backup copy
Parameters
Specifies the WAN accelerator you want to remove.
Required
Position

False

False
Accelerator
True
Named
Example 1
This command removes the WAN Accelerator named "WANAccelerator 1". The accelerator is obtained with Get-VBRWANAccelerator and piped down. Get-VBRWANAccelerator -Name "WANAccelerator 1" | RemoveVBRWANAccelerator
Example 2
This command removes the WAN accelerator represented by the $a variable. The accelerator is obtained with Get-VBRWANAccelerator and assigned to the $a variable beforehand. Remove-VBRWANAccelerator -Accelerator $a
Remove-VSBApplicationGroup
Short Description
Removes a specified application group from Veeam Backup & Replication.
Applies to
Syntax
Remove-VSBApplicationGroup [-AppGroup] <CSbAppGroup[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VSBApplicationGroup
This cmdlet removes a specified application group from Veeam Backup & Replication. An application group is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. See what else you can perform on SureBackup
Parameters
Specifies the application group you want to remove. AppGroup You can assign multiple application groups to this object. True 1
Required
Position

False
Example 1
This command removes the application groups named "AppGroup 01" and "AppGroup 02". The application groups are obtained with Get-VSBApplicationGroup and piped down. Get-VSBApplicationGroup -Name "AppGroup 01", "AppGroup 02"| Remove-VSBApplicationGroup
Example 2
This command removes the application group represented by the $appgroup variable. The application group is obtained with Get-VSBApplicationGroup and assigned to the variable beforehand. Remove-VSBApplicationGroup -AppGroup $appgroup
Remove-VSBHvVirtualLab
Short Description
Removes a Hyper-V virtual lab.
Applies to
Version: 7.0 Platform: Hyper-V For VMware, run Remove-VSBVirtualLab.
Syntax
Remove-VSBHvVirtualLab [-VirtualLab] <CHvSbVirtualLab[]> [WarningAction <ActionPreference>][-WarningVariable <String>] [WhatIf][-Confirm][<CommonParameters>]
Related Commands
Get-VSBHvVirtualLab
This cmdlet removes a virtual lab from Veeam Backup & Replication console. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The virtual lab is not deleted from server where it was created. When you remove a virtual lab, you stop managing it via your Veeam Backup & Replication console. You can add a removed virtual lab to your console by running Connect-VSBHvVirtualLab. See what else you can perform on SureBackup
Parameters
Specifies the virtual lab you want to remove from your Veeam Backup & Replication console.
Required
Position

True(ByValue, ByProperty Name)
VirtualLab
True
Named
False
Example 1
This command removes a virtual lab named "Virtual Lab 01". The virtual lab object is obtained with Get-VSBHvVirtualLab and piped down. Get-VSBHvVirtualLab -Name "Virtual Lab 01" | RemoveVSBHvVirtualLab
Example 2
This command removes a virtual lab represented by the $vlab variable. The virtual lab object is obtained with Get-VSBHvVirtualLab and assigned to variable beforehand. Remove-VSBHvVirtualLab -VirtualLab $vlab
Remove-VSBJob
Short Description
Removes a specified SureBackup job from Veeam Backup & Replication.
Applies to
Syntax
Remove-VSBJob [-Job] <CSbJob[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VSBJob
This cmdlet removes a specified SureBackup job from Veeam Backup & Replication. SureBackup is a Veeam recovery verification technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. Run Remove-VBRJob to remove a backup, replication or copy job. See what else you can perform on SureBackup See what else you can perform on jobs
Parameters
Specifies the SureBackup job you want to remove. You can assign multiple jobs to this object.
Required
Position

Job
True
False
Example 1
This command removes the SureBackup job named "SureJob 01" and "SureJob 12". The SureBackup jobs are obtained with Get-VSBJob and piped down. Get-VSBJob -Name "SureJob 01", "SureJob 12"| Remove-VSBJob
Example 2
This command removes the SureBackup job represented by the $surejob variable. The SureBackup job is obtained with Get-VSBJob and assigned to the variable beforehand. Remove-VSBJob -Job $surejob
Remove-VSBSession
Short Description
Removes a specified SureBackup job session from Veeam Backup & Replication.
Applies to
Syntax
Remove-VSBSession [-Sessions] <CSbSession[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VSBSession
This cmdlet removes a specified SureBackup job session from Veeam Backup & Replication. See what else you can perform on SureBackup See what else you can perform on sessions
Parameters
Specifies the SureBackup job session you want to remove. You can assign multiple sessions to this object.
Required
Position

Sessions
True
False
Example 1
This command removes the SureBackup sessions named "Winserver SureJob" and "Mailserver SureJob". The SureBackup sessions are obtained with Get-VSBSession and piped down. Get-VSBSession -Name "Winserver SureJob", "Mailserver SureJob" | Remove-VSBSession
Example 2
This command removes the SureBackup job session represented by the $suresession variable. The SureBackup job session is obtained with Get-VSBSession and assigned to the variable beforehand. Remove-VSBSession -Sessions $suresession
Remove-VSBVirtualLab
Short Description
Removes a specified VMware virtual lab from Veeam Backup & Replication.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Remove-VSBHvVirtualLab.
Syntax
Remove-VSBVirtualLab [-VirtualLab] <CViSbVirtualLab[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VSBVirtualLab
This cmdlet allows you to remove a specified VMware virtual lab from Veeam Backup & Replication. A virtual lab is a component of SureBackup technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. The virtual lab is not deleted from server where it was created. When you remove a virtual lab, you stop managing it via your Veeam Backup & Replication console. You can add a removed virtual lab to your console by running Connect-VSBVirtualLab. See what else you can perform on SureBackup
Parameters
Specifies the virtual lab you want to remove. You can assign multiple virtual labs to this object.
Required
Position

VirtualLab
True
False
Example 1
This command removes a virtual lab named "Virtual Lab 01". The virtual lab object is obtained with Get-VSBVirtualLab and piped down. Get-VSBVirtualLab -Name "Virtual Lab 01" | Remove-VSBVirtualLab
Example 2
This command removes a virtual lab represented by the $vlab variable. The virtual lab object is obtained with Get-VSBVirtualLab and assigned to the variable beforehand. Remove-VSBVirtualLab -VirtualLab $vlab
Reset-HvVmChangeTracking
Short Description
Clears change tracking data for a specific VM or specific virtual disk (VHD).
Applies to
Syntax
Reset-HvVmChangeTracking [-Server] <CHost> [-VMName <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORReset-HvVmChangeTracking [-Server] <CHost> [-VhdPath <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
This cmdlet clears and resets change tracking data for a VM or specific virtual disk (VHD). Change tracking data is history of changes kept for each data block. Using the changed block tracking (CBT) mechanism allows to reduce the backup time as the backup process compares the CBT data instead of scanning all data. You may need to reset the change tracking data in case it was corrupted. This cmdlet provides two scenarios. You can reset change tracking for a specific VM or for a specific virtual disk (VHD).
Parameters
Specifies the server hosting the VM for which you want to reset change tracking data. Specifies the VM for which you want to reset change tracking data. Specifies the virtual disk (VHD) for which you want to reset change tracking data.
Required
Position

False

False
Server
True
VMName
False
Named
False
False
VhdPath
False
Named
False
False
Example 1
This command resets change tracking data for the VM named "Fileserver". The VM is located on host represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Reset-HvVmChangeTracking -Server $server -VMName "Fileserver"
Example 2
This command resets change tracking data for the specified virtual disk. The VM is located on host represented by the $server variable. The server object is obtained with Get-VBRServer and assigned to the variable beforehand. Reset-HvVmChangeTracking -Server $server -VhdPath "C:\Users\Public\Hyper-V\Virtual Hard Disks\hv_dns.vhdx"
Reset-VBRJobOptions
Short Description
Sets job settings to default.
Applies to
Version: Platform: VMware
Syntax
Reset-VBRJobOptions -Job <CBackupJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet clears the custom settings of the specified job and restores their default values. Note that the VSS settings (application-aware image processing and guest file system indexing) are not reset with this cmdlet. Run Reset-VBRJobVssOptions to clear the job VSS settings. Run DisableVBRJobVSSIntegration or Disable-VBRJobGuestFSIndexing to temporarily disable the applicationaware image processing and guest file system indexing settings. You can run this cmdlet with any kind of jobs. See what else you can perform on job options
Parameters
Job
Specifies the job you want to edit.
True
Named
False
Example 1
This command sets default settings to backup jobs named "Fileserver Backup Job 1" and "Fileserver Backup Job 2". The jobs object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Fileserver Backup Job 1", "Fileserver Backup Job 2" | Reset-VBRJobOptions
Example 2
This command sets default settings to the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Reset-VBRJobOptions -Job $job
Reset-VBRJobScheduleOptions
Short Description
Sets job schedule settings to default.
Applies to
Version: Platform: VMware, Hyper-V
Syntax
Reset-VBRJobScheduleOptions -Job <CBackupJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets the default scheduling options to the selected job. When you clear the schedulling options of a job, you need to run the job manually. You can run this cmdlet with any kind of jobs. See what else you can perform on job options
Parameters
Job
Specifies job you want to edit.
True
Named
True
Example 1
This command sets default schedule options to backup jobs named "Fileserver Backup Job" and "Fileserver Copy Job". The jobs object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Fileserver Backup Job", "Fileserver Copy Job" | Reset-VBRJobScheduleOptions
Example 2
This command sets default schedule options to the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Reset-VBRJobScheduleOptions -Job $job
Reset-VBRJobVssOptions
Short Description
Sets job VSS settings to default.
Applies to
Version: Platform: VMware
Syntax
Reset-VBRJobVssOptions -Job <CBackupJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet clears the custom VSS settings of the specified job and restores their default values. VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently. You can run this cmdlet with any kind of jobs. See what else you can perform on job options
Parameters
Job
Specifies the job you want to edit.
True
Named
False
Example 1
This command sets default VSS settings to backup jobs named "Fileserver Backup Job 1" and "Fileserver Backup Job 2". The jobs object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Fileserver Backup Job 1", "Fileserver Backup Job 2" | Reset-VBRJobVssOptions
Example 2
This command sets default VSS settings to the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. Reset-VBRJobVssOptions -Job $job
Reset-VSBJobOptions
Short Description
Sets SureBackup job settings to default.
Applies to
Syntax
Reset-VSBJobOptions -Job <CSbJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
This cmdlet clears the custom settings of the specified SureBackup job and restores their default values. See what else you can perform on job options See what else you can perform on SureBackup
Parameters
Job
Specifies the SureBackup job you want to edit.
True
Named
False
Example 1
This command sets default settings to SureBackup jobs named "SureBackup Job 1" and "SureBackup Job 2". The jobs object is obtained with Get-VSBJob and piped down. Get-VSBJob -Name "SureBackup Job 1", "SureBackup Job 2" | ResetVSBJobOptions
Example 2
This command sets default settings to the SureBackup job represented by the $SureJob variable. The job object is obtained with Get-VSBJob and assigned to the variable beforehand. Reset-VSBJobOptions -Job $SureJob
Restart-VBRInstantRecovery
Short Description
Restarts a failed instant recovery job.
Applies to
Syntax
Restart-VBRInstantRecovery [-InstantRecovery] <InstantRecovery[]> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
This cmdlet restarts a failed Hyper-V instant recovery job. With instant recovery technology, Veeam Backup & Replication starts a VM directly from a backup, incremental or full, without copying it to production storage. Please note that the instantly recovered VM runs from a backup and does not provide a wholly functioning service. You need to finalize the successful instant recovery by either permanently migrating the recovered VM to the production host or by stopping publishing the recovered VM. Run Start-VBRHvInstantRecoveryMigration or Stop-VBRInstantRecovery respectively. See what else you can perform on instant recovery
Parameters
Specifies the instant recovery session you want to restart. You can assign multiple instant recovery sessions to this object.
Required
Position

Instant Recovery
True
False
Example 1
This command restarts the last instant recovery session. The needed session object is obtained with Get-VBRInstantRecovery, selected by order and piped down. Get-VBRInstantRecovery | Select -Last 1 | RestartVBRInstantRecovery
Example 2
This command restarts the instant recovery session represented by the $"Recovery Session" variable. The needed session object is obtained with Get-VBRInstantRecovery and assigned to the variable beforehand. Restart-VBRInstantRecovery -InstantRecovery $"Recovery Session"
Set-VBRCredentials
Short Description
Edits credentials records properties.
Applies to
Syntax
Set-VBRCredentials -Credential <CCredentials> -Password <string> [<CommonParameters>] -ORSet-VBRCredentials -Credential <CCredentials> -Description <string> [<CommonParameters>]
Related Commands
Get-VBRCredentials
This cmdlet allows editing password or description of a selected credentials record. Select the appropriate syntax for each case. See what else you can perform on credentials
Parameters
Credential
Specifies the credentials you want to edit.
True
Named
False
Password
Specifies the new password for the selected credentials.
True
Named
False
Description
Specifies the new description for the selected credentials.
True
Named
False
Example 1
This command sets a new password for the credentials record with name "Administrator". The new password is "Password_1". The credentials record is obtained with Get-VBRCredentials and piped down. Get-VBRCredentials -Name "Administrator" | Set-VBRCredentials Password "Password_1"
Example 2
This command sets a new description for the credentials record. The credentials record is obtained with Get-VBRCredentials and assigned to the variable beforehand. Set-VBRCredentials -Credential $c -Description "ESXi Host Credentials"
Set-VBRJobAdvancedBackupOptions
Short Description
Customizes advanced job backup settings.
Applies to
Syntax
Set-VBRJobAdvancedBackupOptions -Job <CBackupJob[]> [-Algorithm <JobAlgorithms> {ReverseIncremental | Incremental }] [TransformFullToSyntethic <bool>] [-TransformIncrementsToSyntethic <bool>] [-TransformToSyntethicDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [EnableFullBackup <bool>] [-FullBackupDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [FullBackupScheduleKind <EFullBackupScheduleKind> {Daily | Monthly}] [-Months <EMonth[]> {January | February | March | April | May | June | July | August | September | October | November | December}] [-DayNumberInMonth <EDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [-DayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets advanced backup options for the selected job. You can select backup method: reverse incremental or incremetal, and set schedule settings for synthetic full backups. Read more about advanced backup job settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. See what else you can perform on job options
Parameters
Specifies the job you want to edit. Job You can assign multiple jobs to this object. Specifies backup method: ReverseIncremental : every backup job run creates a full backup file by merging a previous full backup with recent changes. Incremental: the first job run creates a full backup file, and the subsequent runs backups only the changed blocks. Used with incremental backup method. TransformFull ToSyntethic If set to TRUE, the full synthetic backup will be enabled. Otherwise, you will have to perform full backups manually. Used with incremental backup method. If set to TRUE, the previous full backup chain will be transformed into the reversed incremental backup chain. Otherwise all created synthetic fulls will remain on disk. Used to save disk space. Specifies days to perform synthetic fulls: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. If set to TRUE, the active full backup will False Named False False True Named
Required
Position

False
Algorithm
False
Named
False
False
Transform Increments ToSyntethic
False
Named
False
False
TransformTo SyntethicDays
False
Named
False
False
Enable FullBackup
False
Named
False
False
be scheduled. Use FullBackupDays, FullBackupSchedul eKind, -Months, DayNumberInMont h and -DayOfWeek parameters to set the full backup schedule. Sets backup schedule. Specifies days to perform the full backup: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. Sets backup schedule. FullBackup ScheduleKind Sets weekly or monthly period to schedule the full backup: Daily, Monthly. Sets backup schedule. Specifies months to perform the full backup: January, February, March, April, May, June, July, August, September, October, November, December. Sets backup schedule. Specifies the period condition for the monthly backup job run: First, Second, Third, Forth, Last. Use this parameter to set the condition for DayOfWeek parameter, i.e. to run the job on first Saturday every month. Sets backup schedule. DayOfWeek Specifies the day of week to run the backup job: Sunday, Monday, Tuesday, Wednesday, False Named False False False Named False False
FullBackupDays
False
Named
False
False
Months
False
Named
False
False
DayNumber InMonth
False
Named
False
False
Thursday, Friday, Saturday. Use this parameter to set the day for NumberInMonth parameter, i.e. to run the job on first Saturday every month.
Example 1
This command sets the following backup options for the backup job represented by the $job variable: The backup algorithm is set to ReverseIncremental, The active full backup schedule is set to monthly.
The job object is obtained with Get-VBRJob, assigned to the variable beforehand and piped down. $job | Set-VBRJobAdvancedBackupOptions -Algorithm ReverseIncremental -FullBackupScheduleKind Monthly
Example 2
This command sets the following backup options for all backup jobs: The backup algorithm is set to Incremental, The synthetic full backup is enabled on every Sunday and Thursday, The previous fulls are set to rollback to chain of increments to save disk space, The active full backup schedule is set to every second Sunday monthly.
Get-VBRJob -Name Backup* | Set-VBRJobAdvancedBackupOptions Algorithm Incremental -TransformFullToSyntethic True TransformIncrementsToSyntethic True -TransformToSyntethicDays Sunday, Thursday -EnableFullBackup True -FullBackupScheduleKind Monthly -DayNumberInMonth Second -FullBackupDays Sunday
Set-VBRJobAdvancedHvOptions
Short Description
Customizes Hyper-V job settings.
Applies to
Version: 7.0 Platform: Hyper-V
Syntax
Set-VBRJobAdvancedHvOptions -Job <CBackupJob[]> [CanDoCrashConsistent <bool>] [-EnableHvQuiescence <bool>] [UseChangeTracking <bool>] [-ExcludeSwapFile <bool>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets special options for the selected Hyper-V job. In case you cannot use application-aware image processing, you can enable a Hyper-V quiescence mechanism to backup data that can be changed during the backup. Read more about Hyper-V job settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. See what else you can perform on job options
Parameters
Specifies the job you want to edit. You can assign multiple jobs to this object. If set to TRUE, the crash consistent backup will be enabled. Otherwise the VM will be suspended for a short period of time. If set to TRUE, the Hyper-V quiescence mechanism will be enabled. Use this mechanism if the application-aware image processing cannot be used. If set to TRUE, the changed block tracking will be
Required
Position

Job
True
Named
False
CanDoCrash Consistent
False
Named
False
False
EnableHv Quiescence
False
Named
False
False
UseChange Tracking
False
Named
False
False
Parameter
Description
enabled.
Required
Position
Exclude SwapFile
If set to TRUE, the swap file will be excluded from backup.
False
Named
False
False
Example
This command edits advanced job settings to backup job named "Backup Job 01": The Hyper-V quiescence is enabled, The crash consistent backup is enabled, The changed block data is enabled, The swap file is excluded form backup.
The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedHvOptions EnableHvQuiescence True -CanDoCrashConsistent True UseChangeTracking True -ExcludeSwapFile True
Set-VBRJobAdvancedNotificationOptions
Short Description
Customizes job notification settings.
Applies to
Syntax
Set-VBRJobAdvancedNotificationOptions -Job <CBackupJob[]> [SnmpNotification <bool>] [-EmailNotificationAddresses <string>] [-EmailNotification <bool>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets notification options for the selected job. You can set SNMP and email notifications on job run results. Read more about job notification settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. See what else you can perform on job options
Parameters
Specifies the job you want to edit. You can assign multiple jobs to this object. If set to TRUE, the SNMP notification will be sent. You need to have the SNMP notification pre-configured. If set to TRUE, the notifications will be sent to email address(es). Specifies the email address(es) to send the email notification. You can specify multiple addresses separated by semicolon.
Required
Position

Job
True
Named
False
Snmp Notification
False
Named
False
False
Email Notification
False
Named
False
False
Email Notification Addresses
False
Named
False
False
Example
This command sets SNMP and email notifications for the backup job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | SetVBRJobAdvancedNotificationOptions -SnmpNotification True EmailNotification True -EmailNotificationAddresses "administrator@veeam.com"
Set-VBRJobAdvancedOptions
Short Description
Customizes advanced job settings.
Applies to
Syntax
Set-VBRJobAdvancedOptions -Job <CBackupJob[]> [-Periodicity <PeriodicityType> {Cycles | Days}] [-Frequency <uint32>] [Enabled <bool>] [-Days <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-CommandLine <string>] [-EnableIntegrityChecks <bool>] [-RetainDays <int>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets advanced options for the selected job. You can set: Integrity check: Veeam Backup and Replication will check every full backup file for integrity and recovery availability, Custom data retention period: if a VM included in this job is deleted, its data will be stored for the specified period. When this period ends, the backup files are deleted. The default period is 14 days, Post job activity: you can specify a command you want to run after the job run, i.e. to sent a job result report. You can schedule this command to run i.e. every second job run or on specific days.
Read more about advanced job settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. See what else you can perform on job options
Parameters
Specifies the job you want to edit. You can assign multiple jobs to this object. If set to TRUE, automatic backup integrity check will be enabled. Integrity check process verifies the full backup file integrity to avoid data corruption. Otherwise integrity check in not performed. Specifies the integer setting the number of days to keep backup data for deleted VMs. If ommited, the data retention period will be set to 14 days by default. If set to TRUE, the command set in -CommandLine will be executed after the job run. Enabled You need to schedule the command run periodically with -Periodicity and Frequency parameters, or on specific days with -Days parameter. Specifies the command you want to execute after the job run. You can schedule the command run periodically with -Periodicity and Frequency parameters, or on specific days with -Days parameter. Set -Enable parameter to TRUE to enable the command execution. Used to set command run schedule. Specifies the command run schedule type: Periodicity Cycles: the command will be executed in periods set with Frequency parameter, Days: the command will be executed on the days specified with -Days parameter. False Named False False False Named False False
Required
Position

Job
True
Named
False
Enable Integrity Checks
False
Named
False
False
RetainDays
False
Named
False
False
Command Line
False
Named
False
False
Parameter
Description
Used to set command run schedule to Cycle. Specifies the integer setting the number of the backup job runs after which the command will be executed. To set the command run to cycle run, set -Periodicity parameter to Cycle. You can also set the daily schedule with -Days parameter. Used to set command run schedule to Days. Specifies the days to run the command: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday. You can also set the cycle schedule with -Frequency parameter.
Required
Position
Frequency
False
Named
False
False
Days
False
Named
False
False
Example 1
This command edits advanced job settings to backup job named "Backup Job 01": The integrity check is enabled, The data retention period is set to 30 days.
The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedOptions EnableIntegrityChecks True -RetainDays 30
Example 2
This command edits advanced job settings to backup job named "Backup Job 01": The integrity check is enabled, The data retention is not set to leave the default settings, The post job activity is enabled to run the "report.exe" command periodically after every fifth job run.
The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedOptions EnableIntegrityChecks -Enabled True -CommandLine "report.exe" Periodicity Cycles -Frequency 5
Set-VBRJobAdvancedStorageOptions
Short Description
Customizes advanced job storage settings.
Applies to
Syntax
Set-VBRJobAdvancedStorageOptions -Job <CBackupJob[]> [EnableDeduplication [<Boolean>]] [-CompressionLevel <Int32>] [StorageBlockSize <EKbBlockSize>] [-WarningAction <ActionPreference>] [-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets storage options for the selected job. You can enable backup data deduplication and customize data units compression level and size. Read more about job storage settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. See what else you can perform on job options
Parameters
Specifies the job you want to edit. You can assign multiple jobs to this object. If set to TRUE, the data will be deduplicated during the backup job run (recommended). Otherwise, no data will be checked for duplication. Specifies the compression level for the created backup: Compression Level AUTO _COMPRESSION _LEVEL = -1, NONE _COMPRESSION _LEVEL = 0, False Named False False
Required
Position

Job
True
Named
False
Enable Deduplication
False
Named
False
False
Parameter
Description
DEDUPE _COMPRESSION _LEVEL = 4, OPTIMAL _COMPRESSION _LEVEL = 5, HIGH _COMPRESSION _LEVEL = 6, EXTREME _COMPRESSION _LEVEL = 9 Specifies the integer defining the data blocks size. Larger sized blocks provide faster procession but lower deduplication level.
Required
Position
Storage BlockSize
0 = KbBlockSize256, 1 = KbBlockSize512, 3 = KbBlockSize1024, 4 = KbBlockSize2048, 5 = KbBlockSize4096, 6 = KbBlockSize8192, 7= Automatic. False Named False False
Example 1
This command edits advanced storage settings for the backup jobs named "Backup Job 01" and "Backup Job 02". The -EnableDeduplication parameter is set to $TRUE to enable data deduplication, The compression level is set to none (0), The storage blocks size is set to Automatic.
The jobs are obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | SetVBRJobAdvancedStorageOptions -EnableDeduplication $TRUE CompressionLevel 0 -StorageBlockSize 7
Example 2
This command applies the optimal compression level (=5) to all jobs. The jobs are obtained with GetVBRJob and piped down. Get-VBRJob | Set-VBRJobAdvancedStorageOptions -CompressionLevel 5
Set-VBRJobAdvancedViOptions
Short Description
Customizes VMware job settings.
Applies to
Syntax
Set-VBRJobAdvancedViOptions -Job <CBackupJob[]> [-ExcludeSwapFile <bool>] [-VmAttributeName <string>] [-SetResultsToVmAttribute <bool>] [-DoubleSnapshotThresholdMb <long>] [EnableDoubleSnapshot <bool>] [-EnableChangeTracking <bool>] [UseChangeTracking <bool>] [-VMToolsQuiesce <bool>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets special options for the selected VMware job. Read more about VMware job settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. See what else you can perform on job options
Parameters
Parameter Descripti on
Specifies the job you want to edit. Job You can asign multiple jobs to this object. If set to TRUE, the VMware quiescenc e mechanis m will be enabled. Use this mechanis m if the True Named
Required
Position
False
VMTools Quiesce
False
Named
False
False
Parameter
Descripti on
applicatio n-aware image processing cannot be used. If set to TRUE, the changed block tracking will be enabled. If set to TRUE, the changed block tracking will be used even if CBT is disabled on the ESX(i) host. If set to TRUE, the delta data will be written to several delta files with specified volume limit. A new delta file will be created when the previous file reaches the threshold value set in DoubleSn apshotThr esholdMb parameter. Specifies threshold limit value for the delta file in Mb.
Required
Position
EnableChange Tracking
False
Named
False
False
UseChange Tracking
False
Named
False
False
EnableDouble Snapshot
False
Named
False
False
Double Snapshot Threshold Mb
False
Named
False
False
Parameter
Descripti on
If set to TRUE, the swap file will be excluded from backup. If set to TRUE, the job results will be written to custom attributes field of the VM. Specifies the custom attributes field name.
Required
Position
Exclude SwapFile
False
Named
False
False
SetResults ToVm Attribute
False
Named
False
False
VmAttribute Name
False
Named
False
False
Example
This command edits advanced job settings to backup job named "Backup Job 01": The VMware quiescence is enabled, The changed block data is enabled, The CBT is forced to use despite the ESX host settings, The swap file is excluded form backup, The job results are written to the custom attributes field named "backup Results", The delta file is set to duplicate when reaching 500 Mb volume.
The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "Backup Job 01" | Set-VBRJobAdvancedViOptions VMToolsQuiesce True -EnableChangeTracking True -UseChangeTracking True -ExcludeSwapFile True -VmAttributeName "Backup Results" SetResultsToVmAttribute True -EnableDoubleSnapshot True DoubleSnapshotThresholdMb 500
Set-VBRJobObjectVssOptions
Short Description
Customizes job VSS settings.
Applies to
Syntax
Set-VBRJobObjectVssOptions [-Object] <CObjectInJob> [-Options] <CVssOptions> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORSet-VBRJobObjectVssOptions [-Object] <CObjectInJob> -Credentials <CCredentials> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJobObject New-VBRJobVssOptions ([-ForObject]) Get-VBRCredentials
This cmdlet applies a set of customized VSS settings to the specific objects in job or sets credentials to authenticate with a specific objects in job. VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently. To apply the set of customized settings you need to first create a CVssOptions object which unifies all the VSS options you want to apply to the job object. The CVssOptions object is created with the help of the New-VBRJobVssOptions cmdlet. See what else you can perform on job options See what else you can perform on job objects Run Set-VBRJobVssOptions to set the VSS options to the whole job.
Parameters
Object
Specifies the VMs and VM containers for which you want to change VSS settings. Specifies the option that you want to change. Specifies the credentials you want to use for authenticating with the guest VM.
True
False
Options
True
False
Credentials
True
Named
False
False
Example 1
This command applies custom VSS options to the VM named "AD_01" included in the backup job named "Active Directory Backup". The job object and the VM object are obtained with Get-VBRJob and Get-VBRJobObject accordingly and piped down. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions ([-ForObject] option) and assigned to the $options variable beforehand. Get-VBRJob -Name "Active Directory Backup" | Get-VBRJobObject Name "AD_01" | Set-VBRJobVssOptions -Options $options
Example 2
This command applies custom VSS options to the VMs running Active Directory represented by the $"AD_VMs" variable. The VMs object is obtained with Get-VBRJobObject and assigned to the variable beforehand. The object containing the set of customized VSS options is obtained with NewVBRJobVssOptions ([-ForObject] option) and assigned to the $options variable beforehand. Set-VBRJobObjectVssOptions -Object $"AD_VMs" -Options $options
Example 3
This command sets credentials to authenticate with the SQL server included in the SharePoint backup job. The VM object is obtained with Get-VBRJobObject and piped down. The job object to look for the VM in is obtained with Get-VBRJob and assigned to the $"SharePoint Backup" variable beforehand. The credentials record to apply to the VM is obtained with Get-VBRCredentials and assigned to the $"Administrator" variable beforehand. Get-VBRJobObject -Job $"SharePoint Backup" -Name "SharePoint_SQL" | Set-VBRJobObjectVssOptions -Credentials $"Administrator"
Example 4
This command sets credentials to authenticate with the VM represented by the $"SharePoint_SQL" variable. The VM object is obtained with Get-VBRJobObject and assigned to the variable beforehand. The credentials record to apply to the VM is obtained with Get-VBRCredentials and assigned to the $"Administrator" variable beforehand. Set-VBRJobObjectVssOptions -Object $"SharePoint_SQL" -Credentials $"Administrator"
Set-VBRJobOptions
Short Description
Applies custom job settings.
Applies to
Syntax
Set-VBRJobOptions [-Job] <CBackupJob[]> [-Options] <CJobOptions> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob New-VBRJobOptions
This cmdlet applies a set of customized settings to a selected job. To apply the set of customized settings you need to first create a CJobOptions object which unifies all the options you want to apply to the job. The CJobOptions object is created with the NewVBRJobOptions cmdlet. See what else you can perform on job options
Parameters
Job
Specifies the job you want to edit. Specifies the set of parameters you want to apply to the job.
True
False
Options
True
False
Example 1
This command applies custom settings to the backup job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. The object containing the set of customized options is obtained with New-VBRJobOptions and assigned to the $options variable beforehand. Get-VBRJob -Name "Backup Job 01" | Set-VBRJobOptions -Options $options
Example 2
This command applies custom settings to the backup job represented by the $job variable. The job object is obtained with Get-VBRJob andassigned to the variable beforehand. The object containing the set of customized options is obtained with New-VBRJobOptions and assigned to the $options variable beforehand. Set-VBRJobOptions -Job $job -Options $options
Set-VBRJobProxy
Short Description
Assigns a specific proxy to a job or enables automatic proxy selection.
Applies to
Syntax
Set-VBRJobProxy -Job <CBackupJob[]> -Proxy <IProxy[]> [-Target] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORSet-VBRJobProxy -Job <CBackupJob[]> -AutoDetect [-Target] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob Get-VBRViProxy / Get-VBRHvProxy
This cmdlet assigns a specific proxy to a job or enables automatic proxy selection. When you create a job, the proxy server is set automatically by default. With this cmdlet, you can assign a custom proxy to a job or set the automatic proxy selection back. This cmdlet provides two scenarios for each case. You can run this cmdlet with backup and replica jobs. See what else you can perform on job assigned proxies Important! Please note that if you want to set a custom proxy you should make sure that the proxy server is added to Veeam Backup & Replication console, otherwise you will not be able to assign it to the job. The custom proxy server should be configured appropriately. Read more about proxy server settings in Veeam Backup & Replication user guide at http://www.veeam.com/vmware-backup/help-center. Run Get-VBRJobProxy to get the list of proxies assigned to a specific job.
Parameters
Specifies the job you want to set proxy to. You can assign multiple backup jobs to this object. Specifies the proxy server you want to assign to the job. If set, the command returns the list of target proxy servers. If omitted, the command returns the list of source proxy servers. If set, the proxy server selection mode is set to automatic. If you do not set this parameter, you should specify the custom proxy server.
Required
Position

Job
True
Named
False
Proxy
True
Named
False
Target
False
Named
False
False
AutoDetect
True
Named
False
False
Example 1
This command assigns the custom VMware source proxy to the jobs named "Backup Job 01" and "Backup Job 02". The jobs are obtained with Get-VBRJob and piped down. The proxy to assign is obtained with Get-VBRViProxy and assigned to the $"SourceProxy" variable beforehand. The -Target parameter is not set to enable the source proxy allocation. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | SetVBRJobProxy -Proxy $"SourceProxy"
Example 2
This command assigns the custom Hyper-V target proxy to the job represented by the $job variable. The proxy to assign is obtained with Get-VBRHvProxy and assigned to the $proxy variable beforehand. The -Target parameter is set to enable target proxy allocation. Set-VBRJobProxy -Job $job -Proxy $proxy -Target
Example 3
This command sets the automatic source proxy selection mode to the jobs named "Backup Job 01" and "Backup Job 02". The jobs are obtained with Get-VBRJob and piped down. The -Target parameter is not set to enable the source proxy allocation. Get-VBRJob -Name "Backup Job 01", "Backup Job 02" | SetVBRJobProxy -AutoDetect
Set-VBRJobSchedule
Short Description
Sets job schedule options.
Applies to
Syntax
Set-VBRJobSchedule -Job <CBackupJob[]> [-Daily] [-At <DateTime>] [-DailyKind <DailyOptions+DailyKinds>] [-Days <DayOfWeek[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORSet-VBRJobSchedule -Job <CBackupJob[]> [-At <DateTime>] [-Days <DayOfWeek[]>] [-Monthly] [-NumberInMonth <EDayNumberInMonth>] [Months <EMonth[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>][<CommonParameters>] -ORSet-VBRJobSchedule -Job <CBackupJob[]> [-Periodicaly] [FullPeriod <Int32>] [-PeriodicallyKind <PeriodicallyOptions+PeriodicallyKinds>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORSet-VBRJobSchedule -Job <CBackupJob[]> [-After] [-AfterJob <CBackupJob>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet sets custom schedule settings to the selected job. You can schedule the job to run: Daily on specific time, on specific days of week, Monthly on specific time, on specific days of month, on specific months, Periodically within specified period of time or continuously, After a certain job you specify.
See what else you can perform on job options
Parameters
Specifies the job you want to set schedule to. You can assign multiple jobs to this object.
Required
Position

Job
True
Named
False
Daily: Daily Sets job schedule to daily run. Specifies the job start time. If not set, the job will start at 10:00 by default. Specifies the days to run the job: Everyday: the job will run everyday, Weekdays: the job will run Monday through Friday, Selected days: the job will run on specific days (i.e. Saturdays). Use -Days parameter to set the specific days. Days Specifies the days of week to run the job. False Monthly: Specifies the job start time. If not set, the job will start at 10:00 by default. Specifies the day of week to run the job. Use this parameter to set the day for NumberInMonth parameter, i.e. to run the job on first Saturday every month. Specifies the period condition for the job run: First/Second/Third/F orth/Last. Use this parameter to set the condition for Named False False False Named False False
At
False
Named
False
False
DailyKind
False
Named
False
False
At
False
Named
False
False
Days
False
Named
False
False
Number InMonth
False
Named
False
False
Parameter
Description
Days parameter, i.e. to run the job on first Saturday every month.
Required
Position
Monthly Months
Sets job schedule to monthly run. Specifies the months to run the job.
False False Periodically:
Named Named
False False
False False
Periodicaly
Sets job schedule to periodical run. Sets the integer specifying value for the time period to run the job. Use this parameter to set the value for PeriodicallyKind parameter. Specifies the measurement unit for the time period: Hours: the job will run periodically in number of hours set in FullPeriod parameter, Minutes: the job will run periodically in number of minutes set in -FullPeriod parameter, Continuously: the job will run continuously starting right after it has finished. Use this parameter to set the measure unit for the value set in FullPeriod parameter.
False
Named
False
False
FullPeriod
False
Named
False
False
Periodically Kind
False
Named
False
False
After this job: After Sets job schedule to run after a specific job. Specifies the job after which you want to run this job. False Named False False
AfterJob
False
Named
False
False
Example 1
This command sets a new schedule to jobs named "Backup Job 01" and "Backup Job 05". The jobs are obtained with Get-VBRJob and piped down. The jobs are scheduled to run daily at 23:00 on weekdays. Get-VBRJob -Name "Backup Job 01", "Backup Job 05" | SetVBRJobSchedule -Daily -At "23:00" -DailyKind Weekdays
Example 2
This command schedules all replication jobs to monthly run. The replication jobs are obtained with Get-VBRJob and piped down. The jobs are scheduled to run every last Saturday at 12:00 in February, May, August and December. Get-VBRJob -Name Replica* | Set-VBRJobSchedule -Monthly -At "12:00" -NumberInMonth Last -Days Saturday -Months February, May, August, December
Example 3
This command schedules the job represented by the $job variable to run every 12 hours. The job is obtained with Get-VBRJob and assigned to the variable beforehand. Set-VBRJobSchedule -Job $job -Periodicaly -FullPeriod 12 PeriodicallyKind Hours
Example 4
This command schedules the job represented by the $job variable to run after the SureBackup job named SureBackup Job 01. The SureBackup Job 01 is obtained with Get-VSBJob and piped down. The backup job is obtained with Get-VBRJob and assigned to $job variable beforehand. Get-VSBJob -Name "SureBackup Job 01" | Set-VBRJobSchedule -After -AfterJob $job
Set-VBRJobScheduleOptions
Short Description
Applies customized job scheduling settings to a selected backup, replication or copy job.
Applies to
Syntax
Set-VBRJobScheduleOptions [-Job] <CBackupJob[]> [-Options] <ScheduleOptions> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob New-VBRJobScheduleOptions
This cmdlet applies customized scheduling options to a selected backup, replication or copy job. To customize the scheduling options you need to first run the New-VBRJobScheduleOptions cmdlet. New-VBRJobScheduleOptions returns the ScheduleOptions object containing the set of default scheduling options. See what else you can perform on job options Run Set-VSBJobScheduleOptions to set scheduling options to SureBackup job.
Parameters
Specifies the job for which you want to change the scheduling options. You can assign multiple jobs to this object. Options Specifies the custom scheduling options. True 2
Required
Position

Job
True
False
False
False
Example 1
This command applies the customized scheduling options to the jobs named "DC Backup" and "DC File Copy". The jobs are obtained with Get-VBRJob and piped down. The options to apply are set to the $"Schedule Options" variable beforehand by running New-VBRJobScheduleOptions. Get-VBRJob -Name "DC Backup", "DC File Copy" | SetVBRJobScheduleOptions -Options $"Schedule Options"
Example 2
This command applies the customized scheduling options to the job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehand. The options to apply are set to the $"Schedule Options" variable beforehand by running New-VBRJobScheduleOptions. Set-VBRJobScheduleOptions -Job $job -Options $"Schedule Options"
Set-VBRJobVssOptions
Short Description
Applies custom VSS settings to a selected job.
Applies to
Syntax
Set-VBRJobVssOptions [-Job] <CBackupJob[]> [-Options] <CVssOptions> -Credential <CCredentials> [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob New-VBRJobVssOptions
This cmdlet applies a set of customized VSS settings to a selected job. VSS (Volume Shadow Services) is a Windows OS service allowing to copy files of running applications that can be modified at the moment of copying. The VSS-aware applications typically are Active Directory, Microsoft SQL, Microsoft Exchange, Sharepoint, etc. To create a transactionally consistent backup of a VM running VSS-aware applications without shutting them down, Veeam Backup & Replication uses application-aware image processing. It allows backup the data fully and consistently. To apply the set of customized settings you need to first create a CVssOptions object which unifies all the VSS options you want to apply to the job. The CVssOptions object is created with the help of the New-VBRJobVssOptions cmdlet. See what else you can perform on job options Run Set-VBRJobObjectVssOptions to apply VSS settings to specific objects in job.
Parameters
Job
Specifies the job you want to edit. Specifies the set of parameters you want to apply to the job. Specifies the credentials you want to use for authenticating with the guest VM.
True
False
Options
True
False
Credential
True
Named
False
False
Example 1
This command applies custom VSS options to the backup job named "Backup Job 01". The job object is obtained with Get-VBRJob and piped down. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions and assigned to the $options variable beforehand. Get-VBRJob -Name "Backup Job 01" | Set-VBRJobVssOptions -Options $options
Example 2
This command applies custom VSS options to the job represented by the $job variable. The job object is obtained with Get-VBRJob and assigned to the variable beforehand. The object containing the set of customized VSS options is obtained with New-VBRJobVssOptions and assigned to the $options variable beforehand. Set-VBRJobVssOptions -Job $job -Options $options
Set-VSBJobOptions
Short Description
Applies custom SureBackup job options.
Applies to
Syntax
Set-VSBJobOptions [-Job] <CSbJob> [-Options] <CDRJobOptions> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
This cmdlet applies customized job options to SureBackup jobs. To customize the SureBackup job options you need to first run the New-VSBJobOptions cmdlet. NewVSBJobOptions returns the CDRJobOptionsobject containing the set of default SureBackup job options. You can customize any of these options and apply further to a SureBackup job. Run Set-VBRJobOptions to edit job options of backup, replication or copy job. See what else you can perform on job options See what else you can perform on SureBackup
Parameters
Specifies the SureBackup job for which you want to customize the job options. You can assign multiple jobs to this object. Options Specifies the custom SureBackup job options. True 2
Required
Position

Job
True
False
False
False
Example 1
This command applies the customized options to the SUreBackup job named "SureBackup Job 01". The job object is obtained with Get-VSBJob and piped down. The options to apply are set to the $"Sure Options" variable beforehand by running New-VSBJobOptions. Get-VBRJob -Name "SureBackup Job 01" | Set-VSBJobOptions -Options $"Sure Options"
Example 2
This command applies the customized job options to the SureBackup job represented by the $SureJob variable. The job is obtained with Get-VSBJob and assigned to the variable beforehand. The options to apply are set to the $"Sure Options" variable beforehand by running New-VSBJobOptions. Set-VBRJobScheduleOptions -Job $SureJob -Options $"Sure Options"
Set-VSBJobSchedule
Short Description
Sets SureBackup job schedule options.
Applies to
Syntax
Set-VSBJobSchedule [-Job] <CSbJob> [-Daily] [-At <DateTime>] [DailyKind <DailyOptions+DailyKinds>] [-Days <DayOfWeek[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORSet-VSBJobSchedule [-Job] <CSbJob> [-At <DateTime>] [-Days <DayOfWeek[]>] [-Monthly] [-NumberInMonth <EDayNumberInMonth>] [Months <EMonth[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>] -ORSet-VSBJobSchedule [-Job] <CSbJob> [-After] [-AfterJob <CBackupJob>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob Get-VBRJob
This cmdlet sets custom schedule settings to the selected SureBackup job. You can schedule the job to run: Daily on specific time, on specific days of week, Monthly on specific time, on specific days of month, on specific months, After a certain job you specify.
See what else you can perform on job options See what else you can perform on SureBackup
Parameters
Specifies the SureBackup job you want to set schedule to. You can include multiple jobs into this object.
Required
Position

Accept Wildcard Char acters
Job
True
Named
False
Daily: Daily Sets SureBackup job schedule to daily run. Specifies the SureBackup job start time. If not set, the job will start at 10:00 by default. Specifies the days to run the SureBackup job: Everyday: the job will run everyday, DailyKind Weekdays: the job will run Monday through Friday, Selected days: the job will run on specific days (i.e. Saturdays). Use -Days parameter to set the specific days. Days Specifies the days of week to run the SureBackup job. False Monthly: Specifies the SureBackup job start time. If not set, the job will start at 10:00 by default. Specifies the day of week to run the SureBackup job. Use this parameter to set the day for NumberInMonth parameter, i.e. to run the job on first Saturday every month. Specifies the period condition for the SureBackup job run: Named False False False Named False False False Named False False
At
False
Named
False
False
At
False
Named
False
False
Days
False
Named
False
False
Number InMonth
False
Named
False
False
Parameter
Description
First/Second/Third/F orth/Last. Use this parameter to set the condition for Days parameter, i.e. to run the job on first Saturday every month.
Required
Position
Accept Wildcard Char acters
Monthly
Sets SureBackup job schedule to monthly run. Specifies the months to run the SureBackup job.
False
Named
False
False
Months
False After this job:
Named
False
False
After
Sets SureBackup job schedule to run after a specific job. Specifies the job after which you want to run the SureBackup job.
False
Named
False
False
AfterJob
False
Named
False
False
Example 1
This command schedules the jobs named "SureBackup Job 01" and "SureBackup Job 05" to run daily at 23:00 on weekdays. The SureBackup jobs object is obtained with Get-VSBJob and piped down. Get-VSBJob -Name "SureBackup Job 01", "SureBackup Job 05" | SetVSBJobSchedule -Daily -At "23:00" -DailyKind Weekdays
Example 2
This command schedules all SureBackup jobs to run every last Saturday at 12:00 in February, May, August and December. The SureBackup jobs object is obtained with Get-VSBJob and piped down. Get-VSBJob -Name *SureJob* | Set-VSBJobSchedule -Monthly -At "12:00" -NumberInMonth Last -Days Saturday -Months February, May, August, December
Example 3
This command schedules the job represented by the $job variable to run after the SureBackup job named "SureBackup Job 01". The SureBackup job object is obtained with Get-VSBJob and piped down.. The backup job object is obtained with Get-VBRJob and assigned to $job variable beforehand. Get-VBRJob -Name "SureBackup Job 01" | Set-VBRJobSchedule -After -AfterJob $job
Set-VSBJobScheduleOptions
Short Description
Applies customized job scheduling options to a selected SureBackup job.
Applies to
Syntax
Set-VSBJobScheduleOptions [-Job] <CSbJob> [-Options] <ScheduleOptions> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob New-VBRJobScheduleOptions
This cmdlet applies customized scheduling options to a selected SureBackup job. To customize the scheduling options you need to first run the New-VBRJobScheduleOptions cmdlet. New-VBRJobScheduleOptions returns the ScheduleOptions object containing the set of default scheduling options. You can customize any of these options and apply further to any kind of jobs. Run Set-VBRJobScheduleOptions to set scheduling options of backup, replication or copy job. See what else you can perform on job options See what else you can perform on SureBackup
Parameters
Specifies the SureBackup job for which you want to change the scheduling options. You can assign multiple SureBackup jobs to this object. Options Specifies the custom scheduling options. True 2
Required
Position
Job
True
False
False
False
Example 1
This command applies the customized scheduling options to the SureBackup jobs named "SharePoint SureJob" and "MailServer SureJob". The jobs are obtained with Get-VSBJob and piped down. The options to apply are set to the $"Schedule Options" variable beforehand by running NewVBRJobScheduleOptions. Get-VSBJob -Name "SharePoint SureJob", "MailServer SureJob" | Set-VSBJobScheduleOptions -Options $"Schedule Options"
Example 2
This command applies the customized scheduling options to the SureBackup job represented by the $SureJob variable. The job object is obtained with Get-VSBJob and assigned to the variable beforehand. The options to apply are set to the $"Schedule Options" variable beforehand by running New-VBRJobScheduleOptions. Set-VSBJobScheduleOptions -Job $SureJob -Options $"Schedule Options"
Start-VBRHvInstantRecovery
Short Description
Starts a VM instant recovery.
Applies to
Syntax
Start-VBRHvInstantRecovery [-RestorePoint] <COib> [-Server] <CHost> [-Path] <String> [-VMName <String>][-PreserveVmID [<Boolean>]] [-PowerUp [<Boolean>]] [-NICsEnabled [<Boolean>]] [PreserveMACs [<Boolean>]] [-Reason <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Get-VBRServer
This cmdlet allows to perform instant VM recovery. When you run this cmdlet, Veeam Backup & Replication creates a copy of a VM in your Hyper-V environment and starts it immediately (if needed). The VM is started directly from a compressed and deduplicated backup file. Please note that the instantly recovered VM runs from a backup and does not provide a wholly functioning service. You need to finalize the successful instant recovery by either permanently migrating the recovered VM to the production host or by stopping publishing the recovered VM. Run Start-VBRHvInstantRecoveryMigration or Stop-VBRInstantRecovery respectively. Run Restart-VBRInstantRecovery to restart a failed instant recovery session. See what else you can perform on instant recovery
Parameters
RestorePoint
Specifies the VM restore point you want to restore the VM to. Specifies the server where you want to restore the VM. Specifies the path to the folder to store the redo logs. Specifies the name of the VM you want to restore. If not set, the name of the backup will be used. If set to TRUE, the restored VM will get the ID of the original VM. Otherwise, the restored VM will get a new ID. Please note that if the original VM keeps running, preserving the ID will cause conflict. Preserving the ID is useful in case the original VM will not be used in future - in this case, Veeam Backup & Replication will recognize the restored VM as its original and perform all backup and other operations that were scheduled for the original VM. If set to $True, the VM will be powered up right after it is restored. Otherwise, you will need to power up the VM manually. If set to $True, the restored VM will be connected to the network. Otherwise the VM will have no network connections. Specifies the reason for performing restore of the selected VM.
True
False
Server
True
False
Path
True
False
False
VMName
False
Named
False
False
PreserveVmID
PowerUp
False
Named
False
False
NICsEnabled
False
Named
False
False
Reason
The information you provide will be saved in the session history so that you can reference it later.
False
Named
False
False
Example
This command starts instant recovery of the VM. The VM to restore is obtained together with the restore point to which the VM will be restored with Get-VBRRestorePoint and assigned to the $rpoint variable beforehand. The Hyper-V host where the restored VM will be located in obtained with Get-VBRServer and assigned to the $server variable beforehand, The file path for redo logs is c:\Hyper-V\Virtual Hard Disks\Redo, The VM will be restored with name "New-Exch01", The -PowerUp parameter is set to $True to enable the VM power up automatically.
Start-VBRHvInstantRecovery -RestorePoint $rpoint -Server $server -Path "c:\Hyper-V\Virtual Hard Disks\Redo" -VMName New-Exch01 PowerUp $True
Start-VBRHvInstantRecoveryMigration
Short Description
Performs VM migration to a Hyper-V host.
Applies to
Syntax
Start-VBRHvInstantRecoveryMigration [-InstantRecovery] <InstantRecovery[]> [-WarningAction <ActionPreference>][WarningVariable <String>] [<CommonParameters>]
Related Commands
This cmdlet migrates a recovered VM to the production host. You finalize the instant recovery of the VM initiated with Start-VBRHvInstantRecovery by migrating the VM to production. Run Stop-VBRInstantRecovery to terminate the recovery session by unpublishing the VM. See what else you can perform on instant recovery
Parameters
Specifies the session(s) started with the StartVBRHvInstantRecovery cmdlet to finalize migration of a recovered VM to a HyperV host. You can assign multiple instant recovery sessions to this object.
Required
Position
Instant Recovery
True
False
Example 1
This command finalizes the current instant recovery session. The session is obtained with GetVBRInstantRecovery and piped down. Get-VBRInstantRecovery | Start-VBRHvInstantRecoveryMigration
Example 2
This command finalizes the instant recovery session represented by the $"Hv Instant Recovery" variable. The session is obtained with Get-VBRInstantRecovery and assigned to the variable beforehand. Start-VBRHvInstantRecoveryMigration -InstantRecovery $"Hv Instant Recovery"
Start-VBRHvReplicaFailback
Short Description
Performs failback to the production host.
Applies to
Syntax
Start-VBRHvReplicaFailback -RestorePoint <COib> [-Reason <String>] [-RunAsync] [-WarningAction <ActionPreference>] [WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet stars failing back to the production host after failover to its replica. This cmdlet lets you finalize the replica failover started with Start-VBRViReplicaFailover by switching back to the production VM with data synchronization. When you perform failback, you switch back to the original VM on the production site. The failback process collects all the changes that were made to the replica while you failed over to it, and implies them to the source VM. This allows you to switch between source and replica VMs without data loss. To switch back to the production VM and discard the changes made to the replica while failover, start an undo failover process. In this case you return to the production VM in the state preceeding failover. Run Stop-VBRReplicaFailover to undo failover. Undo Failback: If you tried to fail back to the original VM but was unable to, because i.e. it was nonfunctional or corrupted, you can undo the failback and return to the working replica. Run StopVBRViReplicaFailback to undo failback. See what else you can perform on replicas
Parameters
RestorePoint
Specifies the replica restore point which you want to fail back. Specifies the reason for performing a failback. Indicates that the command returns immediately without waiting for the task to
True
Named
False
Reason
False
Named
False
RunAsync
False
Named
False
False
Parameter
Description
complete.
Required
Position
Example 1
This command fails back from the VM replica named "WebServer_ replica". The restore point is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The reason is "Configuration recovery". The RunAsync parameter is set to bring the process to the background. Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | StartVBRHvReplicaFailback -Reason "Configuration recovery" -RunAsync
Example 2
This command fails back from the VM replica represented by the $"WebServer_replica restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The reason is "Data recovery". The RunAsync parameter is set to bring the process to the background. Start-VBRHvReplicaFailback -RestorePoint $"WebServer_replica restorepoint" -Reason "Data recovery" -RunAsync
Start-VBRHvRestoreVM
Short Description
Starts restore of the entire VM.
Applies to
Version: 7.0 and earlier Platform: Hyper-V For VMware, run Start-VBRRestoreVM.
Syntax
Start-VBRHvRestoreVM [-RestorePoint] <COib> [-Server <CHost>] [Path <String>] [-VMName <String>] [-PreserveVmID [<Boolean>]] [PowerUp] [-RegisterAsClusterResource] [-NICsEnabled [<Boolean>]] [-PreserveMACs [<Boolean>]] [-User <String>] [-Password <String>] [-Credential <PSCredential>] [-Reason <String>] [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Get-VBRServer
Starts restore of the entire VM. See what else you can perform on restore
Parameters
RestorePoint
Specifies the VM restore point to which you want to restore. Specifies the host where you want to locate the restored VM. Specifies the path to the folder where you want to restore the VM. Specifies the name you want to apply to the restored VM. By default, the original VM name is applied. If set to TRUE, the restored VM will get the
True
False
Server
False
Named
False
Path
False
Named
False
False
VMName
False
Named
False
False
PreserveVmID
False
Named
False
False
Parameter
Description
ID of the original VM. Otherwise, the restored VM will get a new ID. Please note that if the original VM keeps running, preserving the ID will cause conflict. Preserving the ID is useful in case the original VM will not be used in future - in this case, Veeam Backup & Replication will recognize the restored VM as its original and perform all backup and other operations that were scheduled for the original VM. If set, the restored VM will be powered up immediately after the restore. Otherwise, you will have to power up the VM manually. If set, the restored VM will be registered as a part of a cluster in case you restore the VM to a clustered host. If set to True, the restored VM will be connected to the network. Otherwise the VM will have no network connections. If set to TRUE, the restored VM will get the MAC address of the original VM. Otherwise, the restored VM will get a new MAC address. Please note that if the original VM keeps running, preserving the MAC address will cause conflict. Preserving the MAC address is useful in case the original VM will not be used in future - in this case, the restored VM will be able to use the MAC settings used by its applications, if any are installed.
Required
Position
PowerUp
False
Named
False
False
RegisterAs ClusterResource
False
Named
False
False
NICsEnabled
False
Named
False
False
PreserveMACs
False
Named
False
False
Parameter
Description
Specifies the user name you want to use for authenticating with the VM.
Required
Position
User
If you use the Username/Password scenario, the Credentials parameter must be omitted. Specifies the password you want to use for authenticating with the VM.
False
Named
False
False
Password
If you use the Username/Password scenario, the Credentials parameter must be omitted. Specifies the credentials you want to use for authenticating with the VM.
False
Named
False
False
Credential
If you use the Credentials scenario, the -User and -Password parameters must be omitted. Specifies the reason for performing restore of the selected VM.
False
Named
False
False
Reason
The information you provide will be saved in the session history so that you can reference it later. Indicates that the command returns immediately without waiting for the task to complete.
False
Named
False
False
RunAsync
False
Named
False
False
Start-VBRInstantRecovery
Short Description
Starts instant VM recovery.
Applies to
Syntax
Start-VBRInstantRecovery [-RestorePoint] <COib> [-VMName <String>] [-Server] <CHost> [-ResourcePool] <CViResourcePoolItem> [-Datastore <CViDatastoreItem>] [-Folder <CViFolderItem>] [PowerUp] [-NICsEnabled] [-Reason <String>] [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Get-VBRServer Find-VBRViResourcePool Find-VBRViDatastore Find-VBRViFolder
This cmdlet starts VM instant recovery. With instant recovery technology, Veeam Backup & Replication starts a VM directly from a backup, incremental or full, without copying it to production storage. Please note that the instantly recovered VM runs from a backup and does not provide a wholly functioning service. You need to finalize the successful instant recovery by either permanently migrating the recovered VM to the production host or by stopping publishing the recovered VM. Run Start-VBRQuickMigration or Stop-VBRInstantRecovery respectively. See what else you can perform on instant recovery
Parameters
RestorePoint
Specifies the restore point to which you want to recover the VM. Specifies the name you want to apply to the restored VM. By default, the original VM name is applied.
True
False
VMName
False
Named
False
False
Parameter
Description
Specifies the target host where you want to locate the restored VM. Specifies the resource pool where you want to locate the restored VM. Specifies the datastore to which you want to connect the restored VM. Specifies the folder where you want to locate the restored VM. If set, the restored VM will be powered up immediately after the restore. Otherwise, you will have to power up the VM manually. If set to True, the restored VM will be connected to the network. Otherwise the VM will have no network connections. Specifies the reason for performing restore of the selected VM.
Required
Position

False

False
Server
True
ResourcePool
False
False
False
Datastore
False
Named
False
False
Folder
False
Named
False
False
PowerUp
False
Named
False
False
NICsEnabled
False
Named
False
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Example 1
This command starts the instant recovery of the VM named "MSExchange". The VM is restored to the original location and to the last restore point. The backup and the restore point are obtained with Get-VBRBackup and Get-VBRRestorePoint respectively and piped down. The server to locate the restored VM is obtained with Get-VBRServer and assigned to the $server variable beforehand. Get-VBRBackup -Name "MSExchange Backup" | Get-VBRRestorePoint | Select -Last 1 | Start-VBRInstantRecovery -Server $server
Example 2
This command restores the VM to another location and with different settings. The following parameters are set: The restore point is obtained with Get-VBRRestorePoint and assigned to the $restorepoint variable, The VM is restored with name "MSExchange_Restored", The server to locate the restored VM is obtained with Get-VBRServer and assigned to the $server variable, The resource pool is obtained with Find-VBRViResourcePool and assigned to the $pool variable, The datastore is obtained with Find-VBRViDatastore and assigned to the $store variable, The folder to locate the restored VM is C:\Restored, The -PowerUp parameter is set to TRUE to enable the auto power up of the restored VM, The -NICsEnabled parameter is set to TRUE to connect the restored VM to the host network, The restore reason is "Data recovery", The RunAsync parameter is set to bring the process to the background.
Start-VBRInstantRecovery -RestorePoint $restorepoint -VMName "MSExchange_Restored" -Server $server -ResourcePool $pool Datastore $store -Folder "C:\Restored" -PowerUp TRUE -NICsEnabled TRUE -Reason "Data recovery" -RunAsync
Start-VBRJob
Short Description
Starts backup, replication or copy job.
Applies to
Syntax
Start-VBRJob [-Job] <CBackupJob[]> [-FullBackup] [-RetryBackup] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet allows you to start a created or stopped backup, replication or copy job.You can start the job for an ordinary run, or force a full backup, or set the job to try to restart in case it fails. When you create a job, you need to run it manually unless you enable a job schedule. Run SetVBRJobSchedule to schedule the job to run automatically. You can start the job for an ordinary run, or force a full backup, or set the job to try to restart in case it fails. Run Stop-VBRJob to stop a running job. Run Enable-VBRJob to enable a disabled job. Run Start-VSBJob to start a SureBackup job. See what else you can perform on jobs
Parameters
Specifies the job you want to start. You can assign multiple jobs to this object. Specify this parameter if you want to perform an active full backup. Specify this parameter if you want the job to try to restart in case it fails. By default, the job automatically tries to restart for 3 times.
Required
Position

Job
True
False
FullBackup
False
Named
False
False
RetryBackup
False
Named
False
False
Parameter
Description
Indicates that the command returns immediately without waiting for the task to complete.
Required
Position
RunAsync
False
Named
False
False
Example 1
This command starts the jobs named "WebApplications Server Backup" and "Fileserver Copy Job". The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "WebApplications Server Backup", "Fileserver Copy Job" | Start-VBRJob
Example 2
This command starts the vCloud backup job right after it the job is created. (See Add-VBRvCloudJob for creating a vCloud job). The RunAsync parameter is set to bring the process to the background. Add-VBRvCloudJob -Entity $"vCloud Server" -Name "vCloud Server Backpup" | Start-VBRJob -RunAsync
Example 3
This command starts the job named "WebApplications Server Backup" and requires to perform a full backup. The job is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "WebApplications Server Backup" | Start-VBRJob FullBackup
Example 4
This command starts the job represented by the $job variable. The job is obtained with Get-VBRJob and assigned to the variable beforehand. The -RetryBackup parameter is set to enable the automatic retry. The RunAsync parameter is set to bring the process to the background. Start-VBRJob -Job $job -RetryBackup -RunAsync
Start-VBRQuickMigration
Short Description
Starts Quick Migration of a virtual machine.
Applies to
Syntax
Start-VBRQuickMigration -Entity <CViVmItem[]> -Server <CHost> [ResourcePool <CViResourcePoolItem>] [-Datastore <CViDatastoreItem>] [-Folder <CViFolderItem>] [-SourceProxy <CViProxy[]>] [-TargetProxy <CViProxy[]>] [-ForceVeeamQM] [DeleteSorceVmFiles] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>][<CommonParameters>]
Related Commands
Find-VBRViEntity Get-VBRServer Find-VBRViResourcePool Find-VBRViDatastore Find-VBRViFolder Get-VBRViProxy
This cmdlet starts Quick Migration for a selected virtual machine(s). Quick Migration is a service allowing to promptly migrate a VM between ESX(i) hosts, datastores or both in any state with minimum disruption to business operations and end user access to services.
Parameters
Specifies the virtual machine(s) you want to migrate. You can assign multiple VMs to this object. Specifies the destination server to where you want to migrate the VM. Specifies the destination resource pool to where you want to migrate the VM.
Required
Position

True (ByValue, ByProperty Name) True (ByValue, ByProperty Name) False
Entity
True
Named
False
Server
True
Named
False
ResourcePool
False
Named
False
Parameter
Description
Specifies the destination datastore to where you want to migrate the VM. Specifies the destination folder to where you want to migrate the VM. Specifies the source backup proxy(ies). If not specified, Veeam Backup & Replication provides automatic selection of the proxy (recommended). For best migration performance you should deploy at least one source backup proxy. You can assign multiple proxies to this object. Specifies the target backup proxy(ies). If not specified, Veeam Backup & Replication provides automatic selection of the proxy (recommended). For best migration performance you should deploy at least one target backup proxy. You can assign multiple proxies to this object. Forces using Veeam Quick Migration.
Required
Position

False

False
Datastore
False
Named
Folder
False
Named
False
False
SourceProxy
False
Named
False
False
TargetProxy
False
Named
False
False
Force VeeamQM
If omitted, migration process will use VMware VMotion given that the migration scenario and VMware licensing allows it. If set, the original VM will be deleted upon receiving the heartbeat from the VM on the target host. Indicates that the command returns immediately without waiting for the task to complete.
False
Named
False
False
DeleteSorce VmFiles
False
Named
False
False
RunAsync
False
Named
False
False
Example
This command starts Quick Migration of the selected VM. The VM to migrate is obtained with Find-VBRViEntity and assigned to the $vm variable beforehand, The host to where the VM will be migrated is obtained with Get-VBRServer and assigned to the $server variable beforehand, The resource pool to where the VM will be migrated is obtained with FindVBRViResourcePool and assigned to the $pool variable beforehand, The datastore to connect the VM to is obtained with Find-VBRViDatastore and assigned to the $datastore variable beforehand, The folder to where the VM will be migrated is obtained with Find-VBRViFolder and assigned to the $folder variable beforehand.
The source and target proxies are not set enabling the Quick Migration mechanism to select them automatically. The -ForceVeeamQM parameter is not set enabling the use of VMware VMotion. The DeleteSourceVmFiles parameter is set to enable the clear up of the original VM files upon successful migration. The -RunAsync parameter is not set. Start-VBRQuickMigration -Entity $vm -Server $server -ResourcePool $pool -Datastore $d -Folder $folder -DeleteSorceVmFiles
Start-VBRReplicaFailover
Short Description
Fails over a corrupted VM to its replica. Note: In Backup & Replication v6 this cmdlet was replaced by Start-VBRViReplicaFailover. The cmdlet will still work but it is advised to rewrite your scripts using new cmdlets for added benefits.
Applies to
Syntax
Start-VBRReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-WarningAction <ActionPreference>] [WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet allows you fail over a corrupted VM to its successfully created replica. Performing failover is switching to a VM replica in case the original VM is damaged. You can fail over to the latest state of a replica or to any of its good known restore points. See what else you can perform on replicas
Parameters
RestorePoint
Specifies the replica restore point to which you want to fail over. Specifies the reason for performing a failover. Indicates that the command returns immediately without waiting for the task to complete.
True
False
Reason
False
Named
False
RunAsync
False
Named
False
False
Example 1
This command fails over to the VM replica named "WebServer_ replica" to its latest restore point. The restore point is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The reason is "Configuration recovery". The RunAsync parameter is set to bring the process to the background. Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | StartVBRReplicaFailover -Reason "Configuration recovery" -RunAsync
Example 2
This command fails over to the VM replica represented by the $"WebServer_replica restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The reason is "Data recovery". The RunAsync parameter is set to bring the process to the background. Start-VBRReplicaFailover -RestorePoint $"WebServer_replica restorepoint" -Reason "Data recovery" -RunAsync
Start-VBRRestoreVM
Short Description
Starts restore of the entire VM.
Applies to
Version: 7.0 and earlier Platform: VMware For Hyper-V, run Start-VBRHvRestoreVM
Syntax
Start-VBRRestoreVM [-RestorePoint] <COib> [-Server] <CHost> [[ResourcePool] <CViResourcePoolItem>] [[-Datastore] <CViDatastoreItem>] [-Folder <CViFolderItem>] [-VMName <String>] [-DiskType <EDiskCreationMode>] [-PowerUp [<Boolean>]] [-Reason <String>] [-RunAsync] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Get-VBRServer Find-VBRViResourcePool Find-VBRViDatastore Find-VBRViFolder
This cmdlet starts the entire VM restore. With this cmdlet, you can restore the VM to the original location or to another location, or with different settings. See what else you can perform on restore
Parameters
RestorePoint
Specifies the VM restore point to which you want to restore. Specifies the host where you want to locate the restored VM. Specifies the resource pool where you want to locate the restored VM.
True
False
Server
True
False
ResourcePool
False
False
False
Parameter
Description
Specifies the datastore to which you want to connect the restored VM. Specifies the folder where you want to locate the restored VM. Specifies the name you want to apply to the restored VM. By default, the original VM name is applied. Specifies the disk type foryou want to apply to the restored VM: Thin, Thick or AsOriginal. If set, the restored VM will be powered up immediately after the restore. Otherwise, you will have to power up the VM manually. Specifies the reason for performing restore of the selected VM.
Required
Position

False

False
Datastore
False
Folder
False
Named
False
False
VMName
False
Named
False
False
DiskType
False
Named
False
False
PowerUp
False
Named
False
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Example
This example allows you to restore the VM from the restore point specified in the $point variable and start it on the host specified in the $server variable and resource pool specified in the $rpool variable, putting it on the datastore specified in the $dstore variable. Start-VBRRestoreVM RestorePoint $point Server $server ResourcePool $rpool Datastore $dstore PowerUp TRUE
Start-VBRRestoreVMFiles
Short Description
Restores VM configuration files.
Applies to
Syntax
Start-VBRRestoreVMFiles [-RestorePoint] <COib> [-Server] <CHost> [-Path] <String> [-Files <COIBFileInfo[]>] [-Reason <String>] [RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Get-VBRServer Get-VBRFilesInRestorePoint
This cmdlet allows you to restore configuration file (.vmx) or virtual disks (.vmdk) of a selected VM. Run Start-VBRWindowsFileRestore to restore VM disks data. See what else you can perform on restore
Parameters
Specifies the VM restore point to which you want to restore. Specifies the host to which the VM guest files should be restored. Specifies the string with the path to the folder where restored files should be saved Specifies the files you want to restore (by default, all files from the VM will be restored). Specifies the string with the reason for performing the VM guest OS file restore. Indicates that the command returns immediately without waiting for the task to
Required
Position

True

False
RestorePoint
True
Server
True
False
False
Path
True
False
False
Files
False
Named
True (ByName)
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Parameter
Description
complete.
Required
Position
Example
This example allows you to restore all VM guest OS files from the restore point specified in the $point variable and save them on the host specified in the $server variable to the C:\BackupFiles folder. Start-VBRRestoreVMFiles RestorePoint $point Server $server Path C:\BackupFiles
Start-VBRTapeCatalog
Short Description
Indexes library or tape.
Applies to
Syntax
Start-VBRTapeCatalog -Library <TapeLibrary> [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORStart-VBRTapeCatalog -Medium <TapeMedium[]> [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary Get-VBRTapeMedium
This cmdlet starts indexing process for files stored on tapes. You can catalog for a library or for a tape or a group of tapes. This cmdlet provides scenarios for both cases. See what else you can perform on tapes
Parameters
Library
Specifies the tape library you want to catalog.
True
Named
False
Medium
Specifies the tape(s) you want to catalog. Indicates that the command returns immediately without waiting for the task to complete.
True
Named
False
RunAsync
False
Named
False
False
Example 1
This command starts indexing the tapes with names starting with "001". The tapes are obtained with Get-VBRTapeMedium and piped down. The -RunAsync parameter is set to enable the background processing of the job. Get-VBRTapeMedium -Name 001* | Start-VBRTapeCatalog -RunAsync
Example 2
This command starts indexing the library represented by $lib variable. The library object is obtained with Get-VBRTapeLibrary and assigned to the variable beforehand. The -RunAsync parameter is set to enable the background. Start-VBRTapeCatalog -Library $lib -RunAsync
Start-VBRTapeInventory
Short Description
Inventories library or tape.
Applies to
Syntax
Start-VBRTapeInventory -Library <TapeLibrary> [-RunAsync] [WarningAction <ActionPreference>][-WarningVariable <String>] [<CommonParameters>] -ORStart-VBRTapeInventory -Medium <TapeMedium[]> [-RunAsync] [WarningAction <ActionPreference>][-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary Get-VBRTapeMedium
This cmdlet launches an inventory session. You can run an inventory session either for a library or for a tape. The cmdlet provides syntax for both scenarios. When you launch the Tape library inventory job for a specific library, Veeam Backup & Replication gets updated information on the components (i.e. media pools, drives, and tapes) of the selected library. When you launch the Tape library inventory job for a specific tape, Veeam Backup & Replication recognizes its contents. You can then move the tapes to appropriate media pools according to their contents. See what else you can perform on tapes
Parameters
Library
Specifies the tape library you want to inventory.
True
Named
False
Medium
Specifies the tape you want to inventory. Indicates that the command returns immediately without waiting for the task to complete.
True
Named
False
RunAsync
False
Named
False
False
Example 1
This command starts the Tape library inventory job for the tape named "00110000". The tape is obtained with Get-VBRTapeMedium and piped down. The -RunAsync parameter is set to bring the process to the background. Get-VBRTapeMedium -Name 00110000 | Start-VBRTapeInventory
Example 2
This command starts the Tape library inventory job for the library represented by $lib variable. The library object is obtained with Get-VBRTapeLibrary and assigned to the variable beforehand. The RunAsync parameter is set to bring the process to the background. Start-VBRTapeInventory -Library $lib -RunAsync
Start-VBRTapeRestore
Short Description
Starts VM restore from tape.
Applies to
Syntax
Start-VBRTapeRestore -RestorePoint <COib[]> -Repository <CBackupRepository> [-Reason <string>] [RunAsync][<CommonParameters>] -ORStart-VBRTapeRestore -RestorePoint <COib[]> -Server <CHost> -Path <string> [-Reason <string>] [-RunAsync][<CommonParameters>]
Related Commands
Get-VBRRestorePoint Get-VBRBackupRepository Get-VBRServer
This cmdlet starts restoring VMs from backup copied to tape. You can restore VMs to a chosen backup repository or to a folder on the server you specify. Choose an appropriate syntax for each option. See what else you can perform on tapes See what else you can perform on restore
Parameters
Specifies the particular restore point(s) of the VM. You can assign multiple restore points to this object. Specifies the backup repository where you want to restore the VM. Specifies the reason for restore. Specifies the server where you want to restore the VM.
Required
Position

RestorePoint
True
Named
False
Repository
True
Named
False
False
Reason Server
False True
Named Named
False False
False False
Parameter
Description
Specifies the path to the folder where you want to restore the VM. Indicates that the command returns immediately without waiting for the task to complete.
Required
Position

False

False
Path
True
Named
RunAsync
False
Named
False
False
Example 1
This command starts restoring a VM named "VM01" to a specified backup repository. The VM01 restore point is obtained with Get-VBRRestorePoint. The backup to get the restore point from is represented by the $backup variable. The most recent restore point is selected with Select method and piped down. The repository to where the VM will be restored is obtained with Get-VBRBackupRepository and assigned to the $repository variable beforehand, The reason for restore is "Data recovery", The -RunAsync parameter is set to bring the process to the background.
Get-VBRRestorePoint -Backup $backup | Where {$_.Name -eq "VM01"} |Select -First 1 | Start-VBRTapeRestore -Repository $repository Reason "Data recovery" -RunAsync
Example 2
This command starts restoring a VM to a specified backup repository. The restore point to which the VM wil be restored is obtained with Get-VBRRestorePoint and assigned to the $rpoint variable beforehand, The host to where the VM will be restored is obtained with Get-VBRServer and assigned to the $server variable beforehand, The path to the folder where the VM will be restored is "c:\Restored", The -Reason parameter is not set, The -RunAsync parameter is set to bring the process to the background.
Start-VBRTapeRestore -RestorePoint $rpoint -Server $server -Path "c:\Restored' -RunAsync
Start-VBRTapeRestoreFiles
Short Description
Starts files restore from tape.
Applies to
Syntax
Start-VBRTapeRestoreFiles [-Files <CatalogueFile[]>] [-Version <CatalogueFileVersion[]>] -Server <CHost> -Path <String> [PreserveHierarhy] [-Overwrite <RestoreOverwrite>] [-Security] [RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer Find-VBRTapeCatalog Find-VBRTapeCatalogVersion
This cmdlet starts restoring files from backup copied to tape. You can restore file to its most recent state or to any of its backup version. The versions of files are used as restore points. See what else you can perform on tapes See what else you can perform on restore
Parameters
True (ByValue, ByProperty Name) True (ByValue, ByProperty Name) False
Files
Specifies the files to restore. The most recent file version is used.
False
Named
False
Version
Specifies the version of the files you want to restore. Specifies the source host where the files to restore are located. Specifies the path to the files to restore. If indicated, the files and folders will be restored in respect to the original folder
False
Named
False
Server
True
Named
False
Path Preserve Hierarhy
True False
Named Named
False False
False False
Parameter
Description
hierarchy. Otherwise all files and folders are restored into a plain sequence. Indicates the overwrite options in case the file exists on the target side:
Required
Position
Overwrite
None - leave the original file, Newer - overwrite the file if the restore file in newer, Always - overwrite the existing file. If indicated, the files will be restored with with the original security settings. Otherwise the file/folder security settings will be inherited from parent item. Indicates that the command returns immediately without waiting for the task to complete.
False
Named
False
False
Security
False
Named
False
RunAsync
False
Named
False
False
Example 1
This command starts restoring the file named "VM01 Backup Job 1.vbm". The file to restore is obtained with Find-VBRTapeCatalog and piped down. The host to look for files on is obtained with Get-VBRServer and assigned to the $server variable beforehand, The file path is "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm", The -PreserveHierarhy parameter is set to retain the original folder hierarchy, The -Overwrite parameter is set to Newer, The RunAsync parameter is set to bring the process to the background.
Find-VBRTapeCatalog -Name "VM01 Backup Job 1.vbm" | StartVBRTapeRestoreFiles Server $server -Path "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm" -PreserveHierarhy -Overwrite Newer Security -RunAsync
Example 2
This command restores a specific version of the file named "VM01 Backup Job 1.vbm". The file version is obtained with Find-VBRTapeCatalogVersion and assigned to the $fileversion variable beforehand. The host to look for files on is obtained with Get-VBRServer and assigned to the $server variable beforehand, The file path is "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm", The -PreserveHierarhy parameter is set to retain the original folder hierarchy, The -Overwrite parameter is set to Always, The RunAsync parameter is set to bring the process to the background.
Start-VBRTapeRestoreFiles -Version $fileversion -Server $server Path "C:\backup\Backup Job 1\VM01 Backup Job 1.vbm" PreserveHierarhy -Overwrite Always
Start-VBRvCloudInstantRecovery
Short Description
Starts a vCloud VM instant recovery.
Applies to
Syntax
Start-VBRvCloudInstantRecovery [-RestorePoint] <COib> [-vApp <CVcdVappItem>] [-VmName <String>] [-Datastore <CVcdDatastoreRestoreInfo>] [-PowerOn] [-Reason <String>] [RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Find-VBRvCloudEntity
This cmdlet performs instant recovery of the selected vCloud VM. You can restore the VM to the original location or to another vApp. To restore the VM to another vApp indicate the desired vApp object for the -vApp parameter. To perform restore to the original location, omit this parameter. The VM that you want to restore and its parameters are derived from the specified restore point data. See what else you can perform on vCloud See what else you can perform on instant recovery
Parameters
RestorePoint
Specifies the restore point of the VM. Specifies the vApp you want to restore the VM to. If omitted, the VM will be restored to the original vApp. Specifies the name under which the VM should be restored and registered. By default, the original name of the VM is used. If you are restoring the VM to the
True
False
vApp
False
Named
False
False
VmName
False
Named
False
False
Parameter
Description
same vApp where the original VM is registered and the original VM still resides there, it is recommended that you change the VM name to avoid conflicts. Specifies the datastore you want to connect the restored VM to. If ommited, the VM will be connected to the original datastore.
Required
Position
Datastore
Note: If you restore the VM to another vApp, make sure that the datastore is available in the Organization VCD hosting the vApp to which the VM is restored. If set, the VM will be powered up right after it is restored. Otherwise you will need to power up the VM manually. Specifies the reason for performing restore of the selected VM.
False
Named
False
False
PowerOn
False
Named
False
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Example 1
This command starts instant recovery for the VM. The VM is restored to the original location with all its settings unchanged. The restore point object is obtained with Get-VBRRestorePoint and assigned to the $rpoint variable beforehand. Start-VBRvCloudInstantRecovery -RestorePoint $rpoint
Example 2
This command starts instant recovery for the VM named "VM01". The VM is restored to another vApp and is connected to another datastore. The VM restore point is obtained with Get-VBRRestorePoint and piped down. The most resent restore point is selected with Select method, The VM is restored to a new vApp represented by the $vapp variable, the vApp is obtained with Find-VBRvCloudEntity ([-VApp] option) and assigned to the variable beforehand, The -VmName parameter is omitted to restore the VM with its original name, The new datastore the VM will be connected to is represented by $datastore variable, the datastore is obtained with Find-VBRDatastore and assigned to the variable beforehand, The -PowerOn parameter is set to power up the VM automatically right after it is restored, The reason for restore is "Configuration test", The RunAcync parameter is set to bring the process to the background.
Get-VBRRestorePoint -Backup $backup | where {$_.Name -eq "VM01"} | Select -First 1 | Start-VBRvCloudInstantRecovery -vApp $vapp Datastore $datastore -PowerOn -Reason "Configuration test" RunAsync
Start-VBRvCloudRestoreVApp
Short Description
Starts a vApp restore.
Applies to
Syntax
Start-VBRvCloudRestoreVApp [-RestoreParams] <CVcdVAppRestoreSettings> [-PowerUp][-Reason <string>][RunAsync][<CommonParameters>] -ORStart-VBRvCloudRestoreVApp [-RestorePoint] <COib> [-PowerUp] [Reason <string>][-RunAsync][<CommonParameters>]
Related Commands
New-VBRvCloudVAppRestoreSettings Get-VBRRestorePoint
This cmdlet starts a restore session for a selected vApp. With this cmdlet, you can restore the vApp to the original location or to another location, or with different settings. To restore the vApp to the original location you only need to indicate the desired restore point. Be careful to specify the restore point of the vApp, not an individual VM which is not a valid value for this cmdlet. Veeam Backup & Raplication gets all the information needed for restore from the restore point data. To run restore to another location or with different settings you need to first create aCVcdVAppRestoreSettingsobject which unifies all the settings options required for restore. TheCVcdVAppRestoreSettingsobject is created with the help of the NewVBRvCloudVAppRestoreSettings cmdlet. See the New-VBRvCloudVAppRestoreSettings topic for detailed instructions for advanced setup options. This cmdlet provides two scenarios for each case. See what else you can perform on vCloud See what else you can perform on restore
Parameters
Specifies the CVcdVAppRestoreSetti ngs object containing all settings required for the vApp restore. Specifies the restore point of the vApp. Used to restore vApp with all the same settings unchanged. If set, the vApp will be powered up right after it is restored. Otherwise you will need to power up the vApp manually. Specifies the reason for performing restore of the selected vApp. Reason The information you provide will be saved in the session history so that you can reference it later. Indicates that the command returns immediately without waiting for the task to complete. False Named False False
Required
Position

RestoreParams
True
False
RestorePoint
False
Named
False
False
PowerUp
False
Named
False
False
RunAsync
False
Named
False
False
Example 1
This command starts a vApp restore. The vApp named "vApp_01" is restored to the original location and with all settings unchanged. The vApp restore point is obtained with Get-VBRRestorePoint and assigned to the $restorepoint variable beforehand. Start-VBRvCloudRestoreVApp -RestorePoint $restorepoint
Example 2
This command restores a vApp to another location. The vApp named "vApp_01" is restored to organization named "Org_02" with all other settings remaining unchanged. To restore the vApp to another organization, you need to first customize the CVcdVAppRestoreSettings object The CVcdVAppRestoreSettings object is obtained with NewVBRvCloudVAppRestoreSettings: The restore point of the vApp is obtained with Get-VBRRestorePoint by selecting the vApp named "vApp_01" from the backup objects using the Where method. The restore point is piped down to the New-VBRvCloudVAppRestoreSettings cmdlet. The obtained CVcdVAppRestoreSettings object is assigned to the $restoreparams variable. $restoreparams=Get-VBRRestorePoint -Backup $backup | Where {$_.Name -eq "vApp_01"} | New-VBRvCloudVAppRestoreSettings Further you need to change the organization in the CVcdVAppRestoreSettings object: The Org.Vdc property of the $restoreparams variable is changed to the target organization named "Org_02". The needed organization is obtained with Find-VBRvCloudEntity ([-OrganizationVdc] option). $restoreparams.OrgVdc=Find-VBRvCloudEntity -OrganizationVdc -Name "Org_02" Now you need to run Start-VBRvCloudRestoreVApp with the customized $restoreparams variable. The RunAcync parameter is set to bring the process to the background: Start-VBRvCloudRestoreVApp -RestoreParams $restoreparams RunAsync
Start-VBRvCloudRestoreVm
Short Description
Starts a vCloud VM restore.
Applies to
Syntax
Start-VBRvCloudRestoreVm [-RestorePoint] <COib> [-vApp <CVcdVappItem>] [-StorageProfile <CVcdOrgVdcStorageProfile>] [vCloudDatastore <CVcdDatastoreRestoreInfo>] [-VmTemplate <IVcdItem>] [-VMName <String>] [-PowerUp] [-Reason <String>] [RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint Find-VBRvCloudEntity
This cmdlet starts a restore session of a selected vCloud VM. With this cmdlet, you can restore the VM to the original location or to another location, or with different settings. To restore a VM to the original location you only need to indicate the desired restore point. Be careful to specify the restore point of the VM, not the vApp which is not a valid value for this cmdlet. Veeam Backup & Raplication gets all the information needed for restore from the restore point data. To run restore to another location or with different settings you need to set the new settings values with the parameters available in this cmdlet. These parameters are not obligatory, so you can type only those that you want to change. You cannot restore multiple VM with one command, to restore several VMs you need to start a restore session for each one. See what else you can perform on vCloud See what else you can perform on restore
Parameters
Specifies the restore point of the VM. If you specify no other parameters of the VM, it will be restored with its initial settings, i.e. the datastore or VM template. A multiple VMs object is not valid in this cmdlet. vApp Storage Profile vCloud Datastore Specifies the vApp where to you want to restore the VM. Specifies the storage profile you want to apply to the restored VM. Specifies the datastore you want to use with the restored VM. Specifies the template you want to apply to the restored VM. Specifies the VM name you want to apply to the restored VM. If set, the VM will be powered up right after it is restored. Otherwise you will need to power up the VM manually. Specifies the reason for performing restore of the selected VM. Reason The information you provide will be saved in the session history so that you can reference it later. Indicates that the command returns immediately without waiting for the task to complete. False Named False False False Named False False
Required
Position
RestorePoint
True
False
False
Named
False
False
False
Named
False
False
VmTemplate
False
Named
False
False
VMName
False
Named
False
False
PowerUp
False
Named
False
False
RunAsync
False
Named
False
False
Example 1
This command starts a vCloud VM restore. The VM is restored to the original location and with all settings unchanged. All the information needed for restore is taken from the restore point represented by the $restorepoint variable. The restore point object is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. Start-VBRvCloudRestoreVm -RestorePoint $restorepoint
Example 2
This command restores a VM to another vApp and with another storage profile. The VM to restore and the restore point to which it should be restored is represented by the $restorepoint variable. The restore point object is obtained with Get-VBRRestorePoint and assigned to the variable beforehand, The vApp object to where the VM will be restored is represented by the $vapp variable. The vApp object is obtained with Find-VBRvCloudEntity ([-VApp] option) and assigned to the variable beforehand. The storage profile object that will be applied to the restored VM is represented by the $profile variable. The storage profile object is obtained with Find-VBRvCloudEntity ([StorageProfile] option) and assigned to the variable beforehand.
Start-VBRvCloudRestoreVm -RestorePoint $restorepoint -vApp $vapp -StorageProfile $profile
Start-VBRViReplicaFailback
Short Description
Fails back to the production host.
Applies to
Syntax
Start-VBRViReplicaFailback -RestorePoint <COib> [-Reason <String>] [-RunAsync] [-Complete] [-PowerOn] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet stars failing back to the production host after failover to its replica. This cmdlet lets you finalize the replica failover started with Start-VBRViReplicaFailover by switching back to the production VM with data synchronization. When you perform failback, you switch back to the original VM on the production site. The failback process collects all the changes that were made to the replica while you failed over to it, and implies them to the source VM. This allows you to switch between source and replica VMs without data loss. To switch back to the production VM and discard the changes made to the replica while failover, start an undo failover process. In this case you return to the production VM in the state preceeding failover. Run Stop-VBRReplicaFailover to undo failover. Undo Failback: If you tried to fail back to the original VM but was unable to, because i.e. it was nonfunctional or corrupted, you can undo the failback and return to the working replica. Run StopVBRViReplicaFailback to undo failback. See what else you can perform on replicas
Parameters
RestorePoint
Specifies the replica restore point which you want to fail back. Specifies the reason for performing a failback. Indicates that the command returns immediately without waiting for the task to
True
Named
False
Reason
False
Named
False
RunAsync
False
Named
False
False
Parameter
Description
complete.
Required
Position
Complete
If set, the failback will be commited. If set, the production VM will be powered on after the failback. Otherwise, you will have to power the VM on manually.
False
Named
False
False
PowerOn
False
Named
False
False
Example 1
This command fails back from the VM replica named "WebServer_ replica". The restore point is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The reason is "Configuration recovery". The RunAsync parameter is set to bring the process to the background. Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | StartVBRViReplicaFailback -Reason "Configuration recovery" -RunAsync
Example 2
This command fails back from the VM replica represented by the $"WebServer 01_replica restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The reason is "Data recovery". The RunAsync parameter is set to bring the process to the background. Start-VBRViReplicaFailback -RestorePoint $"WebServer_replica restorepoint" -Reason "Data recovery" -RunAsync
Start-VBRViReplicaFailover
Short Description
Fails over a corrupted VM to its replica.
Applies to
Syntax
Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [-RunAsync] [-Definite] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet allows you fail over a corrupted VM to its successfully created replica. Performing failover is switching to a VM replica in case the original VM is damaged. You can fail over to the latest state of a replica or to any of its good known restore points. In Veeam Backup & Replication, failover is a temporary stage that needs to be finalized: You can perform permanent failover to permanently move your workload to the target host if the source is nonrecoverable. Your target host should have adequate recources. The replica starts acting like source in this case. To perform the permanent failover, run this cmdlet with -Definite parameter. You can perform failback to recover the original VM on the source host or in a new location. Failback is used in case you failed over to a DR site that is not intended for continuous operations, and would like to move the operations back to the production site when the consequences of a disaster are eliminated. Run Start-VBRViReplicaFailback for VMware or Start-VBRHvReplicaFailback for Hyper-V to failback to the original VM. You can undo failover to switch back to the original VM, revert replication operations and discard changes made to the working VM replica. In this case you loose all the changes that were made to the replica while you failed over to it. Run Stop-VBRReplicaFailover to undo failover. See what else you can perform on replicas
Parameters
RestorePoint
Specifies the replica restore point to which you want to fail over. Specifies the reason for performing a failover. Indicates that the command returns immediately without waiting for the task to complete. Performs permanent failover.
True
False
Reason
False
Named
False
RunAsync
False
Named
False
False
Definite
False
Named
False
False
Example 1
This command fails over to the VM replica named "WebServer_ replica" to its latest restore point. The restore point is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The reason is "Configuration recovery". The RunAsync parameter is set to bring the process to the background. Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | StartVBRViReplicaFailover -Reason "Configuration recovery" -RunAsync
Example 2
This command starts permanent failover to the VM replica named "WebServer_ replica" to its latest restore point. The restore point is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The reason is "Configuration recovery". The RunAsync parameter is set to bring the process to the background. The -Definite parameter is set to perform the permanent failover. Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | StartVBRViReplicaFailover -Reason "Configuration recovery" -RunAsync Definite
Example 3
This command fails over to the VM replica represented by the $"WebServer_replica restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The reason is "Data recovery". The RunAsync parameter is set to bring the process to the background. Start-VBRViReplicaFailover -RestorePoint $"WebServer_replica restorepoint" -Reason "Data recovery" -RunAsync
Start-VBRWindowsFileRestore
Short Description
Starts VM files restore.
Applies to
Syntax
Start-VBRWindowsFileRestore [-RestorePoint] <COib> [-Reason <String>] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet allows you to restore files stored on disks of VM running Windows. Run Start-VBRRestoreVMFiles to restore VM configuration files. See what else you can perform on restore
Parameters
RestorePoint
Specifies the VM restore point to which you want to restore. Specifies the string with the reason for performing the VM file restore.
True
False
Reason
False
Named
False
Example
This command starts a Windows file restore session. The restore point is selected by getting the backup job named "Job 1", sorting its restore points and selecting the most recent one.The file to restore "readme.txt" located on FirstDrive is copied to disk "C". The restore session is assigned to the $result variable. $result = Get-VBRBackup | where {$_.jobname -eq "Job 1"} | GetVBRRestorePoint | where {$_.name -eq "VM1"} | Sort-Object creationtime -Descending | Select-Object -First 1 | StartVBRWindowsFileRestore $file = $result.FirstDrive + ":\readme.txt" Copy $file c:\
Start-VBRZip
Short Description
Performs VeeamZIP on the selected VM.
Applies to
Syntax
Start-VBRZip [-BackupRepository <CBackupRepository>] -Entity <IItem[]> [-Compression <Int32>] [-DisableQuiesce] [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>] -ORStart-VBRZip [-Folder <String>] -Entity <IItem[]> [-Compression <Int32>] [-DisableQuiesce] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository Find-VBRViEntity / Find-VBRHvEntity
This cmdlet performs VeeamZIP backup of the selected VM. VeeamZIP is a quick backup procedure always producing a full backup. The VeeamZIP task runs once the time it is created and does not appear in the jobs list. The result backup file is stored in the specified folder and does not appear automatically in the backups list. Run Import-VBRBackup to start managing the backup file with Veeam Backup & Replication.
Parameters
Specifies the backup repository where you want to save the backup file. If none is specified, the default repository will be used. Specifies the VM for which you want to create a VeeamZIP file. You can assign multiple VMs to this object. Compression Specifies then integer number corresponding to False Named
Required
Position
Backup Repository
False
Named
False
False
Entity
True
Named
False
False
Parameter
Description
the desired compression level: 0 = None. Consider disabling compression to achieve better deduplication ratios on deduplicating storage appliances at the cost of reduced backup performance. 4 = Dedupe-friendly. This is the recommended setting for using with deduplicating storage devices and caching WAN accelerators. This setting is used by default. 5 = Optimal (recommended). Optimal compression provides for the best compression to performance ratio, and lowest backup proxy CPU usage. 6 = High. High compression provides additional 10% compression ratio over Optimal, at the cost of 8x higher CPU usage. 9 = Extreme. Extreme compression provides additional 3% compression ratio over High, at the cost of 2x higher CPU usage. If set, the VM will be backed up without using the VMware tools quiescence. Otherwise, the applications running on the target VM will be quiesced to provide transactionally consistent backup with use of VMware Tools. Indicates that the command returns immediately without waiting for the task to complete. Specifies the full path to the folder on the server where you want to store the created backup file. If omitted, the created
Required
Position
DisableQuiesce
False
Named
False
False
RunAsync
False
Named
False
False
Folder
False
Named
False
False
Parameter
Description
backup file will be saved to the C:\backup folder on the Veeam Backup server.
Required
Position
Example 1
This command starts a VeeamZIP for the VM named "Fileserver01". The VM object is obtained with Find-VBRViEntity and piped down. The backup repository to store the result backup file is obtained with Get-VBRBackupRepository and assigned to the $"Repository 01" variable beforehand. The RunAsync parameter is set to bring the process to the background. Find-VBRViEntity -Server $server -Name "Fileserver01" | StartVBRZip -BackupRepository $"Repository 01" -RunAsync
Example 2
This command starts a VeeamZIP for the VM repersented by the $vm variable. The VM object is obtained with Find-VBRViEntity and assigned to the variable beforehand. The path to the folder where the backup file will be stored is D:\Repository\VeeamZIP. The compression level is set to 4 (Dedupefriendly). The VMware quiescence is disabled. The The -RunAsync parameter is set to bring the process to the background. Start-VBRZip -Folder "D:\Repository\VeeamZIP" -Entity $vm Compression 4 -DisableQuiesce -RunAsync
Start-VSBJob
Short Description
Starts a created SureBackup job.
Applies to
Syntax
Start-VSBJob [-Job] <CSbJob[]> [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
This cmdlet allows you to start a created SureBackup job. SureBackup is a Veeam recovery verification technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. When you create a job, you need to run it manually unless you enable a job schedule. Run SetVSBJobSchedule to schedule the SureBackup job to run automatically. Run Stop-VSBJob to stop a running SureBackup job. Run Start-VBRJob to start a backup, replication or copy job. See what else you can perform on SureBackup See what else you can perform on jobs
Parameters
Specifies the SureBackup job you want to run. You can assign multiple jobs to this object. Indicates that the command returns immediately without waiting for the task to complete.
Required
Position

Job
True
False
RunAsync
False
Named
False
False
Example 1
This command starts the SureBackup jobs named "SharePoint SureJob 01" and "SharePoint SureJob 02". The jobs are obtained with Get-VSBJob and piped down. Get-VSBJob -Name "SharePoint SureJob 01", "SharePoint SureJob 02" | Start-VSBJob
Example 2
This command starts the SureBackup job represented by the $SureJob variable. The job object is obtained with Get-VSBJob and assigned to the variable beforehand. Start-VSBJob -Job $SureJob
Stop-VBRInstantRecovery
Short Description
Stops a running instant VM recovery process.
Applies to
Syntax
Stop-VBRInstantRecovery [-InstantRecovery] <InstantRecovery[]> [RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
This cmdlet stops publishing a VM within an instant recovery process. With instant recovery technology, Veeam Backup & Replication starts a VM directly from a backup, incremental or full, without copying it to production storage. You need to finalize the successful instant recovery by either migrating the recovered VM to production or by stopping publishing the recovered VM. To migrate the VM, run Start-VBRQuickMigration. See what else you can perform on instant recovery
Parameters
Instant Recovery
Specifies the running instant VM recovery process that you want to stop. Indicates that the command returns immediately without waiting for the task to complete.
True
False
RunAsync
False
Named
False
False
Example 1
This command stops the last instant recovery session. The needed session object is obtained with GetVBRInstantRecovery, selected by order and piped down. Get-VBRInstantRecovery | Select -Last 1 | Stop-VBRInstantRecovery
Example 2
This command storps the instant recovery session represented by the $"Recovery Session" variable. The needed session object is obtained with Get-VBRInstantRecovery and assigned to the variable beforehand. Stop-VBRInstantRecovery -InstantRecovery $"Recovery Session"
Stop-VBRJob
Short Description
Stops a selected running backup, replication or copy job.
Applies to
Syntax
Stop-VBRJob [-Job] <CBackupJob[]> [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet stops a running backup, replication or copy job. The job is stopped once, the scheduled job will start the next scheduled time. Run Start-VBRJob to start the job manually. Run Disable-VBRJob to temporarily disable a job. Run Stop-VSBJob to stop a SureBackup job. See what else you can perform on jobs
Parameters
Specifies the job you want to stop. You can assign multiple jobs to this object. Indicates that the command returns immediately without waiting for the task to complete.
Required
Position

Job
True
False
RunAsync
False
Named
False
False
Example 1
This command stops the copy job named "SharePoint File Copy Job". The needed job object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "SharePoint File Copy Job" | Stop-VBRJob
Example 2
This command stops the copy job represented by the $"SharePoint File Copy Job" variable. The needed session object is obtained with Get-VBRJob and assigned to the variable beforehand. Stop-VBRJob -Job $"SharePoint File Copy Job"
Stop-VBRReplicaFailover
Short Description
Undoes the replica failover.
Applies to
Syntax
Stop-VBRReplicaFailover [-RestorePoint] <COib> [-RunAsync] [Force] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet allows you to undo the replica failover. This cmdlet lets you finalize the replica failover started with Start-VBRViReplicaFailover by reverting back to the production VM discarding changes. When you undo the failover, you switch back to the original VM, revert replication operations and discard changes made to the working VM replica. In this case you loose all the changes that were made to the replica while you failed over to it. You can select a restore point to revert to. To switch back to the production VM and synchronize the changes made to the replica while failover, start a failback process. Run Start-VBRViReplicaFailback or Start-VBRHvReplicaFailback to fail back to the VMware or Hyper-V production VM respectively. See what else you can perform on replicas
Parameters
RestorePoint
Specifies the restore point of the production VM to recover to. Indicates that the command returns immediately without waiting for the task to complete. Indicates that the replica job starts running without waiting for the target host to power off. Otherwise the replica job will start only after the target host is powered off.
True
False
RunAsync
False
Named
False
False
Force
False
Named
False
False
Example 1
This command stops failover process by reverting to the production VM. The restore point of the replica VM is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The reason is "Configuration recovery". The RunAsync parameter is set to bring the process to the background. The -Force parameter is set to start the replica job running anyway. Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | StopVBRReplicaFailover -Reason "Configuration recovery" -RunAsync Force
Example 2
This command stops failover process by reverting to the production VM. The restorepoint of the replica VM is represented by the $"WebServer_replica restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The reason is "Data recovery". The RunAsync parameter is set to bring the process to the background. Stop-VBRReplicaFailover -RestorePoint $"WebServer_replica restorepoint" -Reason "Data recovery" -RunAsync
Stop-VBRViReplicaFailback
Short Description
Undoes the replica failback.
Applies to
Syntax
Stop-VBRViReplicaFailback -RestorePoint <COib> [-RunAsync] [WarningAction <ActionPreference>] [-WarningVariable <String>] [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
This cmdlet allows you to undo the replica failback started with Start-VBRViReplicaFailback or StartVBRHvReplicaFailback. If you tried to fail back to the production VM but was unable to, because i.e. it was non-functional or corrupted, you can undo the failback and return to the working replica. See what else you can perform on replicas
Parameters
Specifies the restore point of the replica VM for which you want to undo the failback. Indicates that the command returns immediately without waiting for the task to complete.
Required
Position

RestorePoint
True
False
RunAsync
False
Named
False
False
Example 1
This command stops failback from the replica VM named "WebServer_replica". The restore point is obtained with Get-VBRRestorePoint and piped down. The restore points of the VM are filtered with Sort-Object method by the "creationtime" property to get the most recent one. The RunAsync parameter is set to bring the process to the background. Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object $_.creationtime -Descending | Select -First 1 | StopVBRViReplicaFailback -RunAsync
Example 2
This command stops failback from the replica VM named "WebServer_replica". The restorepoint to revert to is represented by the $"WebServer_replica restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the variable beforehand. The RunAsync parameter is set to bring the process to the background. Stop-VBRViReplicaFailback -RestorePoint $"WebServer_replica restorepoint" -RunAsync
Stop-VBRWindowsFileRestore
Short Description
Stops guest OS file recovery session for VMs running Windows.
Applies to
Syntax
Stop-VBRWindowsFileRestore [[-FileRestore] <FileRestore>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
This cmdlet allows you to stop the initiated guest OS file recovery session for VMs running Windows or to disconnect the drive you have mounted to restore data. This cmdlet provides syntax for both scenarios accordingly. See what else you can perform on restore
Parameters
Specifies the running file-level restore session you want to stop.
Required
Position

False

False
FileRestore
False
Example
This command stops a file restore session initiated with Start-VBRWindowsFileRestore and assigned to $result variable. $result = Get-VBRBackup | where {$_.jobname -eq "Job 1"} | GetVBRRestorePoint | where {$_.name -eq "VM1"} | Sort-Object creationtime -Descending | Select-Object -First 1 | StartVBRWindowsFileRestore $file = $result.FirstDrive + ":\readme.txt" Copy $file c:\ Stop-VBRWindowsFileRestore $Result
Stop-VSBJob
Short Description
Stops a selected running SureBackup job.
Applies to
Syntax
Stop-VSBJob [-Job] <CSbJob[]> [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VSBJob
This cmdlet stops a running SureBackup job. The job is stopped once, the scheduled SureBackup job will start the next scheduled time. SureBackup is a Veeam recovery verification technology providing verification of virtual machines that need other virtual machines or services running, i.e. a domain controller, a DSN server or SQL database. To test such machines for recoverability, you need to create a SureBackup job and provide the copy of the production architecture running in a fenced-off environment that is performed by creating a virtual lab and an application group. Run Start-VSBJob to start the job manually. Run Stop-VBRJob to stop a backup, replication or copy job. See what else you can perform on SureBackup See what else you can perform on jobs
Parameters
Specifies the SureBackup job you want to stop. You can assign multiple jobs to this object. Indicates that the command returns immediately without waiting for the task to complete.
Required
Position

Job
True
False
RunAsync
False
Named
False
False
Example 1
This command stops the SureBackup job named "AD SureJob". The needed job object is obtained with Get-VSBJob and piped down. Get-VSBJob -Name "AD SureJob" | Stop-VSBJob
Example 2
This command stops the SureBackup job represented by the $"AD SureJob" variable. The needed job object is obtained with Get-VSBJob and assigned to the variable beforehand. Stop-VSBJob -Job $"AD SureJob"
Sync-HP3Storage
Short Description
Rescans a SAN storage.
Applies to
Syntax
Sync-HP3Storage [-Storage <CHp3PARHost>] [<CommonParameters>]
Related Commands
Get-HP3Storage
This cmdlet rescans the selected SAN storage to synchronize its infrastructure with Veeam Backup & Replication. Rescanning discovers new or checks for deleted volumes and snapshots. Veeam Backup & Replication runs rescan automatically every 3 minutes. You can perform rescan manually if you want to display the newly added or deleted volumes or snapshots. Run Sync-HP3Volume to rescan the selected volumes only. See what else you can perform on HP 3PAR instances
Parameters
Storage
Specifies the storage you want to rescan.
False
Named
False
Example 1
This command synchronizes the storage named "HP Store 01". The storage object is obtained with Get-HP3Storage and piped down. Get-HP3Storage -Name "HP Store 01" | Sync-HP3Storage
Example 2
This command synchronizes the storage represented by the $"store01" variable. The storage object is obtained with Get-HP3Storage and assigned to the variable beforehand. Sync-HP3Storage -Storage $"store01"
Sync-HP3Volume
Short Description
Rescans a SAN volume.
Applies to
Syntax
Sync-HP3Volume -Volume <CSanVolume[]> [<CommonParameters>]
Related Commands
Get-HP3Volume
This cmdlet rescans the selected SAN volume(s) to synchronize the storage system infrastructure with Veeam Backup & Replication. Rescanning discovers new or checks for deleted snapshots. Veeam Backup & Replication runs rescan automatically every 3 minutes. You can perform rescan manually if you want to display the newly added or deleted snapshots. Run Sync-HP3Storage to rescan the SAN storage. See what else you can perform on HP 3PAR instances
Parameters
Specifies the volume(s) you want to synchronize. You can assign multiple volumes to this object.
Required
Position

Volume
True
Named
False
Example 1
This command synchronizes the volume named "HP Vol 01". The volume object is obtained with GetHP3Volume and piped down. Get-HP3Volume -Name "HP Vol 01" | Sync-HP3Volume
Example 2
This command synchronizes the volume named "HP Vol 01". The volume object is obtained with GetHP3Volume and assigned to the variable beforehand. Sync-HP3Volume -Volume $"HP Vol 01"
Sync-HP4Storage
Short Description
Rescans a SAN storage.
Applies to
Syntax
Sync-HP4Storage -Storage <CHpP4Group> [<CommonParameters>]
Related Commands
Get-HP4Storage
This cmdlet rescans the selected SAN storage to synchronize its infrastructure with Veeam Backup & Replication. Rescanning discovers new or checks for deleted volumes and snapshots. Veeam Backup & Replication runs rescan automatically every 3 minutes. You can perform rescan manually if you want to display the newly added or deleted volumes or snapshots. Run Sync-HP4Volume to rescan the selected volumes only. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Sync-VBRHPStorage
Parameters
Storage
Specifies the storage you want to synchronize.
True
Named
False
Example 1
This command synchronizes the storage named "HP Store 01". The storage object is obtained with Get-HP4Storage and piped down. Get-HP4Storage -Name "HP Store 01" | Sync-HP4Storage
Example 2
This command synchronizes the storage named "HP Store 01". The storage object is obtained with Get-HP4Storage and assigned to the variable beforehand. Sync-HP4Storage -Storage $"HP Store 01"
Sync-HP4Volume
Short Description
Rescans a SAN volume.
Applies to
Syntax
Sync-HP4Volume -Volume <CSanVolume[]> [<CommonParameters>]
Related Commands
Get-HP4Volume
This cmdlet rescans the selected SAN volume(s) to synchronize the storage system infrastructure with Veeam Backup & Replication. Rescanning discovers new or checks for deleted snapshots. Veeam Backup & Replication runs rescan automatically every 3 minutes. You can perform rescan manually if you want to display the newly added or deleted snapshots. Run Sync-HP4Storage to rescan the SAN storage. See what else you can perform on HP LeftHand P4000 or HP StoreVirtual VSA instances
Alias
Sync-VBRHPVolume
Parameters
Specifies the volume(s) you want to synchronize. You can assign multiple volumes to this object.
Required
Position

Volume
True
Named
False
Example 1
This command synchronizes the volume named "HP Vol 01". The volume object is obtained with GetHP4Volume and assigned to the variable beforehand. Get-HP4Volume -Name "HP Vol 01" | Sync-HP4Volume
Example 2
This command synchronizes the volume named "HP Vol 01". The storage object is obtained with GetHP4Volume and piped down. Sync-HP4Volume -Volume $"HP Vol 01"
Sync-VBRBackupCopyJob
Short Description
Rescans a selected backup repository.
Applies to
Syntax
Sync-VBRBackupCopyJob -Job <IJob> [-WarningAction <ActionPreference>] [-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
This cmdlet starts manual data synchronization for the selected backup copy job. The backup copy job is copying backup files from the source backup repository to the target backup repository. The backup copy job runs continuously synchronizing the backup repositories in userdefined time periods. With this cmdlet, you can synchronize the source and the target repositories manually. See what else you can perform on backup copy
Parameters
Specifies the backup copy job for which you want to start manual synchronization.
Required
Position

Job
True
Named
False
Example 1
This command synchronizes data for the backup copy job named "AD Backup Copy". The needed job object is obtained with Get-VBRJob and piped down. Get-VBRJob -Name "AD Backup Copy" | Sync-VBRBackupCopyJob
Example 2
This command synchronizes data for the backup copy job represented by the $"AD backup" variable. The needed job object is obtained with Get-VBRJob and assigned to the variable beforehand. Sync-VBRBackupCopyJob -Job $"AD backup"
Sync-VBRBackupRepository
Short Description
Rescans a selected backup repository.
Applies to
Syntax
Sync-VBRBackupRepository -Repository <CBackupRepository[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
This cmdlet allows you to rescan a specified backup repository for details about backups stored on it. You can perform the repository rescan i.e. in case you have imported or copied backups. See what else you can perform on backup repositories
Parameters
Repository
Specifies backup repository you want to rescan.
True
Named
False
Example 1
This command rescans the repository named "Local Repository 01". The needed repository object is obtained with Get-VBRBackupRepository and piped down. Get-VBRBackupRepository -Name "Local Repository 01" | SyncVBRBackupRepository
Example 2
This command rescans the repository represented by the $repository variable. The needed repository object is obtained with Get-VBRBackupRepository and assigned to the variable beforehand. Sync-VBRBackupRepository -Repository $repository

Veeam Backup 7 Powershell

Încărcat de

Informații document

Descriere originală:

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Veeam Backup 7 Powershell

Încărcat de

Drepturi de autor:

Formate disponibile

Veeam Backup & Replication PowerShell

2 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

3 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

4 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

5 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

6 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

7 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

CONTACTING VEEAM SOFTWARE

8 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

ABOUT THIS GUIDE

Document Revision History

9 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

10 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Backup Job 3 Hyper-V Backup Stopped Success

Backup Job 3 Hyper-V Backup Stopped Success

11 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

12 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Backup Job 1 Backup Job 2 Backup Job 7

VMware Backup VMware Backup VMware Backup

8/1/2013 4:47:19 AM 8/1/2013 5:00:28 AM 8/6/2013 3:15:13 AM

13 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Backup Job 7 8/6/2013 3:45:52 AM Increment

Let's get them and save into variables.

14 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

esx18.veeam.local ESXi esx18.veeam.local

15 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

And then selecting the resource pool:

WinXPx86 Stopped 8/6/2013 5:01:18 AM

16 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

17 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

To learn more about PowerShell remoting and its configuration, see:

18 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Interactive PowerShell Help

19 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

20 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

VEEAM BACKUP & REPLICATION CMDLETS

21 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Managing virtualization hosts and clusters

Managing proxy servers

Managing job assigned proxy servers

22 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Managing backup repositories

Looking for virtual instances

23 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Managing HP 3PAR StoreServ infrastructure

Managing HP LeftHand P4000 or HP StoreVirtual VSA infrastructure

24 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

VMware Work with SAN storages:

Add-HP4Storage Get-HP4Storage Remove-HP4Storage Sync-HP4Storage Look for SAN clusters:

Looks for SAN clusters

Get-HP4Cluster Work with SAN volumes:

Looks for SAN volumes Rescans a SAN volume

Working with tapes

25 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

VMware Look for backup files:

Looks for backup files archived to tapes

Get-VBRTapeBackup Inventory your tape archive:

Start-VBRTapeCatalog Start-VBRTapeInventory Find-VBRTapeCatalog

Start-VBRTapeCatalog Start-VBRTapeInventory Find-VBRTapeCatalog

26 | Veeam Backup PowerShell Reference | USER GUIDE | REV 3

Set-VSBJobOptions Reset-VSBJobOptions Set-VSBJobSchedule Set-VSBJobScheduleOptions Manage SureBackup sessions:

Set-VSBJobOptions Reset-VSBJobOptions Set-VSBJobSchedule Set-VSBJobScheduleOptions

Copying backups to a secondary location