Professional Documents
Culture Documents
Version 9.0
Reference
January, 2016
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.
CONTENTS
CONTENTS............................................................................................................................................ 3
CONTACTING VEEAM SOFTWARE..................................................................................................... 14
GETTING STARTED............................................................................................................................. 15
UNDERSTANDING VEEAM CMDLETS .................................................................................................................................16
USING GET-VBRCOMMAND .............................................................................................................................................17
USING GET-HELP................................................................................................................................................................18
EXAMPLES OF USE ..............................................................................................................................................................19
POWERSHELL REMOTING...................................................................................................................................................20
VEEAM POWERSHELL CMDLETS ....................................................................................................... 21
ADD-HP3SNAPSHOT ........................................................................................................................................................22
ADD-HP3STORAGE ...........................................................................................................................................................24
ADD-HP4SNAPSHOT ........................................................................................................................................................26
ADD-HP4STORAGE ...........................................................................................................................................................28
ADD-NETAPPHOST ...........................................................................................................................................................30
ADD-NETAPPSNAPSHOT ..................................................................................................................................................32
ADD-VBRBACKUPREPOSITORY ........................................................................................................................................34
ADD-VBRBACKUPTOTAPEJOB.........................................................................................................................................39
ADD-VBRCLOUDGATEWAY..............................................................................................................................................44
ADD-VBRCLOUDGATEWAYCERTIFICATE ........................................................................................................................46
ADD-VBRCLOUDPROVIDER..............................................................................................................................................47
ADD-VBRCLOUDPUBLICIP...............................................................................................................................................50
ADD-VBRCLOUDTENANT .................................................................................................................................................51
ADD-VBRCOPYJOB ...........................................................................................................................................................54
ADD-VBRCREDENTIALS ....................................................................................................................................................56
ADD-VBRENCRYPTIONKEY ...............................................................................................................................................59
ADD-VBREPBACKUPCOPYJOB ........................................................................................................................................61
ADD-VBRESX ....................................................................................................................................................................64
ADD-VBRESXI ...................................................................................................................................................................66
ADD-VBRFAILOVERPLAN .................................................................................................................................................68
ADD-VBRFILETOTAPEJOB................................................................................................................................................71
ADD-VBRHVBACKUPCOPYJOB .......................................................................................................................................75
ADD-VBRHVBACKUPJOB .................................................................................................................................................78
ADD-VBRHVCLOUDHARDWAREPLAN ............................................................................................................................80
ADD-VBRHVCLOUDREPLICAJOB.....................................................................................................................................82
ADD-VBRHVCLUSTER .......................................................................................................................................................85
ADD-VBRHVHOST ............................................................................................................................................................87
ADD-VBRHVJOBOBJECT ..................................................................................................................................................89
ADD-VBRHVPROXY ..........................................................................................................................................................91
ADD-VBRHVREPLICAJOB .................................................................................................................................................93
ADD-VBRHVSCVMM .........................................................................................................................................................96
ADD-VBRLINUX .................................................................................................................................................................98
ADD-VBRSCALEOUTBACKUPREPOSITORY .................................................................................................................. 101
ADD-VBRSMBV3CLUSTER ............................................................................................................................................ 103
ADD-VBRSMBV3HOST.................................................................................................................................................. 105
ADD-VBRTAPEGFSMEDIAPOOL .................................................................................................................................. 107
ADD-VBRTAPEMEDIAPOOL .......................................................................................................................................... 110
ADD-VBRTAPESERVER ................................................................................................................................................... 115
ADD-VBRTAPEVAULT .................................................................................................................................................... 117
ADD-VBRVCENTER ......................................................................................................................................................... 119
ADD-VBRVCLOUD.......................................................................................................................................................... 121
ADD-VBRVCLOUDBACKUPCOPYJOB ........................................................................................................................... 123
ADD-VBRVCLOUDJOB ................................................................................................................................................... 126
ADD-VBRVCLOUDVC .................................................................................................................................................... 128
ADD-VBRVIBACKUPCOPYJOB ...................................................................................................................................... 131
ADD-VBRVIBACKUPJOB ................................................................................................................................................ 134
ADD-VBRVICLOUDHARDWAREPLAN........................................................................................................................... 136
ADD-VBRVICLOUDREPLICAJOB ................................................................................................................................... 138
ADD-VBRVIJOBOBJECT ................................................................................................................................................. 141
ADD-VBRVIPROXY ......................................................................................................................................................... 143
ADD-VBRVIREPLICAJOB ................................................................................................................................................ 145
ADD-VBRWANACCELERATOR ..................................................................................................................................... 150
ADD-VBRWINSERVER .................................................................................................................................................... 152
ADD-VNXHOST .............................................................................................................................................................. 154
ADD-VNXSNAPSHOT ..................................................................................................................................................... 156
ADD-VSBHVAPPLICATIONGROUP ................................................................................................................................ 157
ADD-VSBHVJOB............................................................................................................................................................. 159
ADD-VSBHVVIRTUALLAB .............................................................................................................................................. 162
ADD-VSBJOB .................................................................................................................................................................. 163
ADD-VSBVIAPPLICATIONGROUP ................................................................................................................................. 166
ADD-VSBVIRTUALLAB ................................................................................................................................................... 168
CLEAR-VBRWANCACHE ............................................................................................................................................... 170
CONNECT-VBRSERVER ................................................................................................................................................... 172
CONNECT-VSBHVVIRTUALLAB ..................................................................................................................................... 174
CONNECT-VSBVIRTUALLAB........................................................................................................................................... 176
COPY-VBRJOB ................................................................................................................................................................ 178
DISABLE-VBRCLOUDGATEWAY .................................................................................................................................... 180
DISABLE-VBRCLOUDTENANT ........................................................................................................................................ 182
DISABLE-VBREPJOB ...................................................................................................................................................... 184
DISABLE-VBRHVPROXY ................................................................................................................................................. 186
DISABLE-VBRJOB ........................................................................................................................................................... 188
DISABLE-VBRJOBGUESTFSINDEXING........................................................................................................................... 190
DISABLE-VBRJOBSCHEDULE ......................................................................................................................................... 192
DISABLE-VBRJOBVSSINTEGRATION ............................................................................................................................. 194
DISABLE-VBRREPOSITORYEXTENTMAINTENANCEMODE ........................................................................................... 196
DISABLE-VBRTAPEDRIVE ............................................................................................................................................... 198
DISABLE-VBRTAPEPROTECTION.................................................................................................................................... 200
DISABLE-VBRVIPROXY ................................................................................................................................................... 202
DISABLE-VSBJOB ............................................................................................................................................................ 204
DISABLE-VSBJOBSCHEDULE.......................................................................................................................................... 205
GET-VBRCLOUDGATEWAYCERTIFICATE....................................................................................................................... 296
GET-VBRCLOUDHARDWAREPLAN ............................................................................................................................... 297
GET-VBRCLOUDPROVIDER ............................................................................................................................................ 299
GET-VBRCLOUDPROVIDERNETWORKAPPLIANCE ....................................................................................................... 301
GET-VBRCLOUDPUBLICIP ............................................................................................................................................. 302
GET-VBRCLOUDSERVER ................................................................................................................................................ 303
GET-VBRCLOUDSERVERNETWORKINFO....................................................................................................................... 305
GET-VBRCLOUDTENANT ............................................................................................................................................... 307
GET-VBRCLOUDTENANTNETWORKAPPLIANCE........................................................................................................... 309
GET-VBRCLOUDVLANCONFIGURATION ..................................................................................................................... 311
GET-VBRCOMMAND ...................................................................................................................................................... 312
GET-VBRCONFIGURATIONBACKUPJOB ........................................................................................................................ 314
GET-VBRCREDENTIALS .................................................................................................................................................. 315
GET-VBRDEFAULTGATEWAYCONFIGURATION............................................................................................................ 316
GET-VBRENCRYPTIONKEY ............................................................................................................................................. 317
GET-VBREPJOB .............................................................................................................................................................. 319
GET-VBREPPERMISSION................................................................................................................................................ 321
GET-VBREPSESSION ...................................................................................................................................................... 323
GET-VBRFAILOVERPLAN................................................................................................................................................ 325
GET-VBRFILESINRESTOREPOINT ................................................................................................................................... 328
GET-VBRHVPROXY ........................................................................................................................................................ 330
GET-VBRHVREPLICAREIPRULE ..................................................................................................................................... 332
GET-VBRHVSERVERNETWORKINFO .............................................................................................................................. 333
GET-VBRINSTANTRECOVERY ......................................................................................................................................... 335
GET-VBRJOB ................................................................................................................................................................... 336
GET-VBRJOBOBJECT ...................................................................................................................................................... 338
GET-VBRJOBOBJECTVSSOPTIONS................................................................................................................................ 340
GET-VBRJOBOPTIONS ................................................................................................................................................... 342
GET-VBRJOBPROXY ....................................................................................................................................................... 343
GET-VBRJOBSCHEDULEOPTIONS ................................................................................................................................. 345
GET-VBRJOBVSSOPTIONS ............................................................................................................................................ 347
GET-VBRLOCALHOST ..................................................................................................................................................... 349
GET-VBRREPLICA ........................................................................................................................................................... 350
GET-VBRREPOSITORYEXTENT ....................................................................................................................................... 352
GET-VBRRESTOREPOINT................................................................................................................................................ 354
GET-VBRRESTORESESSION ............................................................................................................................................ 356
GET-VBRSERVER ............................................................................................................................................................. 357
GET-VBRSERVERSESSION .............................................................................................................................................. 359
GET-VBRSESSION ........................................................................................................................................................... 360
GET-VBRSQLDATABASE ............................................................................................................................................... 362
GET-VBRSQLDATABASERESTOREINTERVAL................................................................................................................ 363
GET-VBRTAPEDRIVE ...................................................................................................................................................... 365
GET-VBRTAPEJOB .......................................................................................................................................................... 367
GET-VBRTAPELIBRARY................................................................................................................................................... 368
GET-VBRTAPEMEDIAPOOL ........................................................................................................................................... 370
GET-VBRTAPEMEDIUM.................................................................................................................................................. 372
NEW-VBRTAPEGFSMEDIASETPOLICY......................................................................................................................... 453
NEW-VBRTAPEGFSSCHEDULEOPTIONS...................................................................................................................... 455
NEW-VBRTAPEMEDIAPOOLRETENTIONPOLICY .......................................................................................................... 459
NEW-VBRTAPEMEDIASETCREATIONPOLICY ............................................................................................................... 461
NEW-VBRVCLOUDVAPPRESTORESETTINGS ................................................................................................................ 463
NEW-VBRVICLOUDHWPLANDATASTORE .................................................................................................................. 466
NEW-VBRVIREPLICAREIPRULE...................................................................................................................................... 467
NEW-VSBJOBOPTIONS .................................................................................................................................................. 469
REMOVE-HP3SNAPSHOT ............................................................................................................................................... 470
REMOVE-HP3STORAGE .................................................................................................................................................. 472
REMOVE-HP4SNAPSHOT ............................................................................................................................................... 474
REMOVE-HP4STORAGE .................................................................................................................................................. 476
REMOVE-NETAPPHOST .................................................................................................................................................. 478
REMOVE-NETAPPSNAPSHOT ......................................................................................................................................... 479
REMOVE-VBRBACKUP .................................................................................................................................................... 480
REMOVE-VBRBACKUPREPOSITORY ............................................................................................................................... 482
REMOVE-VBRCLOUDGATEWAY .................................................................................................................................... 484
REMOVE-VBRCLOUDHARDWAREPLAN ........................................................................................................................ 486
REMOVE-VBRCLOUDPROVIDER .................................................................................................................................... 488
REMOVE-VBRCLOUDPUBLICIP ..................................................................................................................................... 490
REMOVE-VBRCLOUDTENANT........................................................................................................................................ 491
REMOVE-VBRCLOUDVLANCONFIGURATION ............................................................................................................. 493
REMOVE-VBRCREDENTIALS ........................................................................................................................................... 494
REMOVE-VBRDEFAULTGATEWAY ................................................................................................................................. 495
REMOVE-VBRENCRYPTIONKEY...................................................................................................................................... 496
REMOVE-VBRFAILOVERPLAN ........................................................................................................................................ 498
REMOVE-VBRHVPROXY ................................................................................................................................................. 500
REMOVE-VBRJOB ........................................................................................................................................................... 502
REMOVE-VBRJOBOBJECT .............................................................................................................................................. 504
REMOVE-VBRREPLICA .................................................................................................................................................... 506
REMOVE-VBRRESTOREPOINT ........................................................................................................................................ 508
REMOVE-VBRRESTORESESSION .................................................................................................................................... 510
REMOVE-VBRSERVER ..................................................................................................................................................... 512
REMOVE-VBRTAPELIBRARY ........................................................................................................................................... 514
REMOVE-VBRTAPEMEDIAPOOL.................................................................................................................................... 516
REMOVE-VBRTAPEMEDIUM .......................................................................................................................................... 518
REMOVE-VBRTAPESERVER............................................................................................................................................. 519
REMOVE-VBRTAPEVAULT .............................................................................................................................................. 521
REMOVE-VBRVIPROXY................................................................................................................................................... 523
REMOVE-VBRWANACCELERATOR ............................................................................................................................... 525
REMOVE-VNXHOST........................................................................................................................................................ 527
REMOVE-VNXSNAPSHOT............................................................................................................................................... 528
REMOVE-VSBAPPLICATIONGROUP ............................................................................................................................... 529
REMOVE-VSBHVVIRTUALLAB........................................................................................................................................ 531
REMOVE-VSBJOB............................................................................................................................................................ 533
REMOVE-VSBVIRTUALLAB ............................................................................................................................................. 535
Customer Support
Should you have a technical concern, suggestion or question, please visit our Customer Center Portal
at www.veeam.com/support.html 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 PowerShell, you can use the following resources:
GETTING STARTED
Veeam Backup & Replication comes with PowerShell extension a snap-in to Microsoft Windows
PowerShell 2.0. The Veeam Backup PowerShell snap-in allows you to do almost all operations that are
available in the user interface.
Veeam PowerShell cmdlets mirror actions you can perform via Veeam Backup & Replication UI. Keep in
mind that actions performed with PowerShell have the same force as actions performed via Veeam
Backup & Replication: for example, if you delete a job with a PowerShell script, the job will be removed
from the Veeam Backup & Replication database, and you will not be able to undo changes.
If your machine is running Microsoft Windows 2008, make sure that the Microsoft Windows
PowerShell 2.0 is installed on your machine. To download Microsoft Windows PowerShell, use the
following link: http://support.microsoft.com/kb/968929.
Platform
Some Veeam cmdlets differ for VMware and Hyper platforms. A prefix indicates the platform: 'Vi'
stands for VMware, and 'Hv' stands for Hyper-V. A Vi-cmdlet will not work for Hyper-V instances, and
vice versa. For example, Add-VBRViBackupJob creates a backup job for VMware VMs, but if you need
to back up Hyper-V VMs, you need Add-VBRHvBackupJob. Some cmdlet work for both platforms, like
Get-VBRJob. You can additionally check the platform in the Applies to section on the online help
page for each cmdlet.
That means that to add a new Hyper-V proxy, you need to indicate a server that will act as the proxy,
the description of the new proxy and a number of tasks that the proxy can perform simultaneously.
Some cmdlets have two or more parameter sets. For example, restore cmdlets offer a 'simplified'
parameter set for restoring to original location, while the parameter set for restoring to another
location allows to indicate the target server and other detail and these parameters are mandatory for
this set.
Note:
Since Veeam Backup & Replication v5 uses 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.
Using Get-VBRCommand
The Get-VBRCommand cmdlet returns the list of cmdlets available in the Veeam PowerShell SnapIn.
Note:
This cmdlet is available only in sessions started from Veeam Backup & Replication main menu.
You can additionally filter the list of commands using Name, Noun or Verb parameters:
Using Get-Help
The Get-Help cmdlet is a Microsoft cmdlet that works for Veeam PowerShell SnapIn as well. Get-Help
<cmdletname> displays a full description of the specified cmdlet along with its syntax and full
parameter description.
Note:
The online help is always a more accurate source of information than the help integrated in the
product. The online help is updated regularly and contains all fixes based on customers' feedback.
Examples of Use
In this example, we will review how to restore a VM to another location by means of the 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.
To restore a VM, you will need the Start-VBRRestoreVm cmdlet. The cmdlet has two parameter sets: to
restore to the original location or to another location. The parameters of the cmdlet allows you to
choose various restore details, but for a basic restore the following settings will be enough:
The restore point: choose the restore point to restore the VM to a particular date.
The target server: choose the server where the VM will be registered.
The target resource pool: choose the resource pool on the target server where you want to
restore the VM.
To get the restore point, we will need first to get the backup job that processed the VM. Get
the backup job and save it to a variable:
Then get the restore point of this backup. Remember that the backup contains all VM
processed by the job, so use the -Name parameter to indicate the name of the needed VM.
The command returns the list of the restore points. We will need the last one and we will save
it to another variable:
PS C:\PS> $restorepoint = Get-VBRRestorePoint -Backup $backup -Name
"vdi001" | Select -Last 1
2.
Now you will need to get the server. Save it to yet another variable:
3.
And now we need to get the resource pool on this server. We will save it to the variable, too:
4.
Finally, we can start the restore. We will need the saved variables:
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:
Enable PowerShell remoting. Start Windows PowerShell 2.0 as an administrator and type in
Enable-PSRemoting
Add-HP3Snapshot
Short Description
Creates a HPE 3PAR StoreServ storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 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 HPE 3PAR StoreServ storage volume.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Volume
True
Named
False
Name
False
Named
False
False
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".
PS C:\PS> 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".
PS C:\PS> Add-HP3Snapshot -Volume $volume -Name "vol_SS_01" -Description
"Vol 01 snapshot"
Add-HP3Storage
Short Description
Adds HPE 3PAR StoreServ storage to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
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
Detailed Description
This cmdlet adds the selected HPE 3PAR StoreServ 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 storage infrastructure manually, run Sync-HP3Storage
or Sync-HP3Volume.
When adding a storage, you will need to provide either username/password or credentials. This
cmdlet provides syntax for both scenarios accordingly.
Parameters
Parameter
UserName
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
True
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Password
True
Named
False
False
False
Named
False
False
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 adds a HPE 3PAR StoreServ 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.
PS C:\PS> 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 HPE 3PAR StoreServ 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.
PS C:\PS> Add-HP3Storage -Credentials $creds -Name 167.16.2.134 Description "HPE 3PAR Storage" -Url https://172.18.44.8:8080
Add-HP4Snapshot
Short Description
Creates a HPE StoreVirtual storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
Syntax
Add-HP4Snapshot -Volume <CSanVolume> [-Name <string>] [-Description
<string>][-ApplicationManagedShapshot] [<CommonParameters>]
Related Commands
Get-HP4Volume
Detailed Description
This cmdlet creates a snapshot of the selected HPE StoreVirtual storage volume.
Alias
Add-VBRHPSnapshot
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Volume
True
Named
False
False
Name
False
Named
False
False
False
Named
False
False
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-HP4Volume and piped down. The application-managed
snapshot is enabled. The description is "Vol 01 snapshot".
PS C:\PS> 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".
PS C:\PS> Add-HP4Snapshot -Volume $volume -Name "vol_SS_01" ApplicationManagedShapshot -Description "Vol 01 snapshot"
Add-HP4Storage
Short Description
Adds HPE StoreVirtual storage to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
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
Detailed Description
This cmdlet adds the selected HPE StoreVirtual 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 storage infrastructure manually, run Sync-HP4Storage
or Sync-HP4Volume.
When adding a storage, you will need to provide either username/password or credentials. This
cmdlet provides syntax for both scenarios accordingly.
Alias
Add-VBRHPStorage
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
DnsOr
IpAddress
True
Named
True
(ByValue,
ByProperty
Name)
False
UserName
False
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
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 adds a storage with IP address 167.16.2.134. The username is "Administrator" and the
password is "Password".
PS C:\PS> Add-HP4Storage -DnsOrIpAddress 167.16.2.134 -UserName
"Administrator" -Password "Password" -Description "HPE Storage"
Example 2
This command adds a storage with IP address 167.16.2.134. The credentials object is obtained with
Get-VBRCredentials and assigned to the $creds variable beforehand.
PS C:\PS> Add-HP4Storage -DnsOrIpAddress 167.16.2.134 -Credentials $creds Description "HPE Storage"
Add-NetAppHost
Short Description
Adds NetApp storage.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-NetAppHost -Name <String> [-Description <String>] -UserName <String> Password <String> [-IsHTTP [<Boolean>]] [-Port <Int32>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
-ORAdd-NetAppHost -Name <String> [-Description <String>] -Credentials
<CCredentials> [-IsHTTP [<Boolean>]] [-Port <Int32>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCredentials
Detailed Description
This cmdlet adds the selected NetApp storage to Veeam Backup & Replication.
When adding a storage, you will need to provide either username/password or credentials. This
cmdlet provides syntax for both scenarios accordingly.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
True
Named
False
False
True
Named
False
False
False
Named
False
False
Password
IsHTTP
False
Named
False
False
True
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 adds a NetApp storage with IP address 167.16.2.134. The username is "Administrator"
and the password is "_Password_".
PS C:\PS> Add-NetAppHost -UserName "Administrator" -Password "_Password_" Name 167.16.2.134 -Description "NetApp Storage"
Example 2
This command adds a NetApp storage with IP address 167.16.2.134. The credentials object is obtained
with Get-VBRCredentials and assigned to the $creds variable beforehand.
PS C:\PS> Add-NetAppHost -Credentials $creds -Name 167.16.2.134 Description "NetApp Storage"
Add-NetAppSnapshot
Short Description
Creates storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-NetAppSnapshot -Volume <CSanVolume> [-Name <String>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-NetAppVolume
Detailed Description
This cmdlet creates a snapshot of the selected NetApp volume.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Volume
True
Named
False
Name
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
This command creates a snapshot of the "Vol 01" volume. The snapshot is named "vol_SS_01".
Run Get-NetAppHost to get the host where the volume is located. Save the result to the
$apphost variable.
Run Get-NetAppVolume with the $apphost variable to get the volume. Pipe it down to AddNetAppSnapshot.
Add-VBRBackupRepository
Short Description
Adds a new backup repository.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server
<CHost>] [-MountServer <CHost>] -Folder <String> -Type
<CBackupRepositoryInfo+EType> [-ImportIndex] [-ImportBackup] [RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>]
[-LimitConcurrentJobs] [-MaxConcurrentJobs <Int32>] [-LimitDatarate] [DataRateLimit <Int32>] [-AlignDataBlocks] [-DecompressDataBlocks] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
-ORAdd-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server
<CHost>] [-MountServer <CHost>] -Folder <String> -Type
<CBackupRepositoryInfo+EType> [-ImportIndex] [-ImportBackup] [RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>]
[-UserName <String>] [-Password <String>] [-LimitConcurrentJobs] [MaxConcurrentJobs <Int32>] [-LimitDatarate] [-DataRateLimit <Int32>]
[AlignDataBlocks] [-DecompressDataBlocks] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
-ORAdd-VBRBackupRepository [-Name <String>] [-Description <String>] [-Server
<CHost>] [-MountServer <CHost>] -Folder <String> -Type
<CBackupRepositoryInfo+EType> [-ImportIndex] [-ImportBackup] [RotatedDrive] [-VPowerNFSFolder <String>] [-UseFc] [-DDServerName <String>]
[-Credentials <CCredentials>] [-LimitConcurrentJobs] [-MaxConcurrentJobs
<Int32>] [-LimitDatarate] [-DataRateLimit <Int32>] [-AlignDataBlocks] [DecompressDataBlocks] [-WarningAction <ActionPreference>] [-WarningVariable
<String>][<CommonParameters>]
Related Commands
Get-VBRServer
Get-VBRCredentials
Detailed Description
This cmdlet adds a new backup repository 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
authentication.
To add a scale-out backup repository, run Add-VBRScaleOutBackupRepository.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
False
Named
False
False
Description
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
Server
CifsShare
DataDomain
ExaGrid
HPStoreOnce
LinuxLocal
WinLocal
Mount
Server
Folder
Import
Index
False
Named
False
False
Import
Backup
False
Named
False
False
Rotated
Drive
False
Named
False
False
VPower
NFSFolder
False
Named
False
False
DDServer
Name
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Max
Concurrent
Jobs
Limit
Datarate
Data
Rate
Limit
Align
Data
Blocks
deduplication ratio.
UserName
False
Named
False
False
False
Named
False
False
False
Named
False
False
Credentials
<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 adds a Windows server as a new backup repository named "Win2012Repo". No
authentication is used. All repository settings are used as set default.
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".
Example 2
This command adds a Windows server as a new backup repository named "Backups Vol 01". The
authentication with the server is provided with the credentials record.
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 credentials to authenticate with the source server are obtained with Get-VBRCredentials
and assigned to the $Administrator variable beforehand.
Example 3
This command adds an EMC DataDomain storage appliance as a backup repository. The DataDomain
storage is connected over the TCP. The storage appliance is connected to an explicitly set gateway
server.
The DataDomain appliance is set with the IP address. The "DFC-" prefix is not set to enable the
connection over TCP.
The host that will be used as the gateway server is obtained with Get-VBRServer and assigned
to the $server variable beforehand.
Example 4
This command adds backup repository on a rotated drive connected to a Windows server.
The "Rotated Drive" switch parameter is used to enable the rotated drive repository
technology.
The host to which the rotated drive is connected is obtained with Get-VBRServer and
assigned to the $server variable beforehand.
Add-VBRBackupToTapeJob
Short Description
Creates backup to tape job or a GFS job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Related Commands
Get-VBRTapeMediaPool
New-VBRFullBackupToTapePolicy
New-VBRBackupToTapeScheduleOptions
Get-VBRJob
Get-VBREPJob
New-VBRNotificationOptions
New-VBRJobScriptOptions
New-VBRBackupToTapeScheduleOptions
New-VBRTapeGFSScheduleOptions
Get-VBRBackupRepository
Return Type
VBRBackupToTapeJob
Detailed Description
This cmdlet creates a new backup to tape job or a GFS job. Target the job to a simple or a GFS media
pool respectively.
The backup to tape job archives backups that were produced by particular backup or Endpoint jobs or
stored on particular backup repositories. Use the Object parameter to set a backup job or a backup
repository as source to the tape job.
Note:
If you choose to archive data from backup repositories, the backup to tape job will process only the
backups that were created with backup jobs configured on this Veeam backup server. Imported
backups and configuration backups will be skipped from processing.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
False
Named
False
False
Eject
Current
Medium
Export
Current
MediaSet
Incremental
Backup
Media
Pool
tape job.
Accepts VBRTapeMediaPool object, GUID or
string type.
GFSMedia
Pool
ExportDays
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Schedule
Options
Object
Process
Incremental
Backup
WaitPeriod
False
Named
False
False
False
Named
False
False
Notification
Options
False
Named
False
False
JobScript
Options
False
Named
False
False
CopyFrom
LatestFull
False
Named
False
False
AlwaysCopy
FromLatest
Full
False
Named
False
False
GFS
Schedule
Options
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
This example shows how to create a tape job that has a backup job as source. The tape job will use the
same media pool to back up full and incremental backups.
1.
Run Get-VBRJob to get the backup job that will be the source. Save the job to the $sqljob
variable.
2.
Run Get-VBRTapeMediaPool to get the media pool. Use the same media pool to write full and
incremental backups. Save the media pool to the $mediapool variable.
3.
Create an object containing the job schedule. First run New-VBRDailyOptions to set the day
and time. Save the result to the $dailyoptions variable. Then run NewVBRBackupToTapeScheduleOptions to create the schedule object. Save the schedule to the
$scheduleoptions variable.
4.
Run Add-VBRBackupToTapeJob to create the tape job. Use the saved variables.
Add-VBRCloudGateway
Short Description
Adds a new cloud gateway.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Add-VBRCloudGateway [-Description <string>] [-Server <CHost>] [-IpAddress
<ipaddress>] [-IncomingPort <int>] [-NATPort <int>] [-NetworkMode
<VBRGatewayNetworkMode> {Direct | NAT}] [<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRCloudGateway
Detailed Description
This cmdlet creates a cloud gateway.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
IpAddress
Incoming
Port
NATPort
False
Named
False
False
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 adds a new cloud gateway with a direct network connection.
The server that will be used as the cloud gateway is obtained with Get-VBRServer and
assigned to the '$server' variable beforehand.
The port that will be used by Veeam Backup & Replication to connect to the gateway server is
'6260'.
Example 2
This command adds a new cloud gateway in the local network behind the NAT gateway.
The server that will be used as the cloud gateway is obtained with Get-VBRServer and
assigned to the '$server' variable beforehand.
The port that will be used by Veeam Backup & Replication to connect to the gateway server is
'6180'.
Add-VBRCloudGatewayCertificate
Short Description
Sets the SSL certificate on the service provider side.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRCloudGatewayCertificate -Certificate <VBRCloudCertificate> [-WhatIf]
[-Confirm] [<CommonParameters>]
Related Commands
Get-VBRCloudGatewayCertificate
Detailed Description
This cmdlet sets the SSL certificate on the service provider side. This certificate will be used to
authenticate with the users.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
WhatIf
False
Named
False
False
Confirm
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.
Add-VBRCloudProvider
Short Description
Adds a new service provider.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Add-VBRCloudProvider -Address <string> -Credentials <CCredentials> [Description <string>] [-Port <int>] [-Appliance
<VBRCloudProviderNetworkAppliance[]>] [-VerifyCertificate] [CertificateThumbprint <string>] [-InstallManagementAgent] [-Force]
[<CommonParameters>]
Related Commands
Get-VBRCredentials
Get-VBRCloudProviderNetworkAppliance
Return Type
VBRCloudProvider
Detailed Description
This cmdlet adds a new service provider to Veeam Backup & Replication.
You can add several providers using one cloud gateway to your Veeam backup console. The providers'
credentials must have different user names.
Parameters
Parameter
Address
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
False
Named
False
False
Port
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Verify
Certificate
Certificate
Thumbprint
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 adds a cloud service provider to Veeam Backup & Replication using default settings.
The credentials record to authenticate with the user account is obtained with GetVBRCredentials and assigned to the '$credentials' variable beforehand.
Example 2
This command adds a cloud service provider. A custom port is used for connection and the SSL
certificate thumbprint verification is enabled for the service provider.
The port that will be used for enabling connection between the user's Veeam backup server
and the cloud gateway is set to '6252'.
The credentials used to authenticate with the service provider is obtained with GetVBRCredentials and assigned to the '$credentials' variable beforehand.
The VerifyCertificate parameter is used to enable the SSL certificate verification with
thumbprints. The thumbprint is 'e6 c0 e5 1a db 73 0c 13 b3 c3 74 d4 ee 93 ab d0 08 3f 7a a8'.
Add-VBRCloudPublicIP
Short Description
Adds public IP address or a pool of IP addresses.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Add-VBRCloudPublicIP -FirstIpAddress <ipaddress> [-LastIpAddress
<ipaddress>] [<CommonParameters>]
Related Commands
None
Return Type
VBRCloudIP
Detailed Description
This cmdlet adds a single IP address or a range of IP addresses to the public IP address pool.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True (by
Value
FromPipeline)
False
LastIpAddress
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.
Add-VBRCloudTenant
Short Description
Creates a new cloud user account.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Add-VBRCloudTenant -Name <string> -Password <string> [-Description
<string>] [-EnableLeaseExpiration] [-LeaseExpirationDate <datetime>] [Resources <VBRCloudTenantResource[]>] [-HashedPassword] [-EnableThrottling]
[-ThrottlingValue <decimal>] [-ThrottlingUnit <VBRSpeedUnit> {MbitPerSec |
MbytePerSec | KbytePerSec}] [-ReplicationResources
<VBRCloudTenantReplicationResources>] [<CommonParameters>]
Related Commands
New-VBRCloudTenantResource
Return Type
VBRCloudTenant
Detailed Description
This cmdlet creates a new cloud user account.
Parameters
Parameter
Name
Description
Required Position
True
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Lease
Expiration
Date
Resources
Hashed
Password
Enable
Throttling
Throttling
Value
Throttling
Unit
Replication
Resources
ReplicationResources parameter, or a
combination of both, to create a cloud user.
Accepts the
VBRCloudTenantReplicationResources object.
<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 adds a user account with lease expiration settings enabled.
The user name is "ABC Company" and the description is the "User account for ABC company".
The EnableLeaseExpiration parameter is used to enable the lease expiration settings. The
lease expiration date is set to 12.30.2015.
Example 2
This command adds a user account without lease expiration settings.
The user name is "ABC Company" and the description is the "User account for ABC company".
Add-VBRCopyJob
Short Description
Creates a new VM copy job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRCopyJob [-Name] <String> [-Type] <CDbBackupJobInfo+ESourceType> Server <CHost> -Folder <String> [-FileName <String>] -SourceServer <CHost>
-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
Detailed Description
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.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
True
False
False
Type
True
False
False
Server
True
Named
False
False
Folder
True
Named
False
False
FileName
False
Named
False
False
True
Named
False
False
True
Named
True
(ByValue,
ByProperty
Name)
False
Description
False
Named
False
False
True
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.
Add-VBRCredentials
Short Description
Creates a credentials record.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRCredentials -User <String> -Password <String> [-Description
<String>] [-Type <VBRCredentialsType>] [-SshPort <Int32>] [-ElevateToRoot]
[-AddToSudoers] [-RootPassword <String>] [-PrivateKeyPath <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
-ORAdd-VBRCredentials [-Description <String>] -Credential <PSCredential> [Type <VBRCredentialsType>] [-SshPort <Int32>] [-ElevateToRoot] [AddToSudoers] [-RootPassword <String>] [-PrivateKeyPath <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRCredentials
Detailed Description
This cmdlet creates a new credentials record for authenticating with the instances of your virtual
infrastructure. You can add Windows or Linux credentials records including authentication using the
Identity/Pubkey method.
You can add a new credentials record by indicating strings for user name and password (unprotected
mode), or by supplying a PSCredential object.
Parameters
Parameter
User
Description
Specifies the user name you want to use for
authenticating with the instances of your
virtual infrastructure.
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
True
Named
False
False
True
Named
False
False
Description
False
Named
False
False
False
Named
False
False
Type
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Default: Windows.
SshPort
ElevateToRoot
AddToSudoers
RootPassword
<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 new Windows credentials record for the administrator.
PS C:\PS> Add-VBRCredentials -Type Windows -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.
PS C:\PS> Get-Credential | Add-VBRCredentials -Description "Administrator
Credentials"
Example 3
This command adds a Linux credentials record for the administrator. The credentials record will use
the 23 SSH port. The root password privileges are given to the user.
PS C:\PS> Add-VBRCredentials -Type Linux -User Administrator -Password
password -SshPort 23 -ElevateToRoot -AddToSudoers -RootPassword rootpwd
Example 4
This command adds a Linux Pubkey credentials record for the 'User1'.
PS C:\PS> Add-VBRCredentials -Type LinuxPubKey -User user1 Password
password -PrivateKeyPath c:\temp\deneb.ppk
Add-VBREncryptionKey
Short Description
Creates encryption key.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBREncryptionKey [-Password] <securestring> [[-Description] <string>]
[<CommonParameters>]
Related Commands
None
Return Type
PSCryptoKey
Detailed Description
This cmdlet creates a new encryption key.
This cmdlet accepts SecureString type. Use Microsoft PowerShell standard capabilities to convert your
password into the SecureString.
Parameters
Parameter
Password
Description
Required Position
Accept
Wildcard
Characters
True
False
False
False
False
Accept
Pipeline
Input
<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 'Veeam Administrator' encryption key.
The password is turned into a SecureString by running ConvertTo-SecureString and assigned to the
'$securepassword' variable.
PS C:\PS> $plainpassword = "VeeamPassword"
PS C:\PS> $securepassword = $plainpassword | ConvertTo-SecureString AsPlainText -Force
PS C:\PS> Add-VBREncryptionKey -Password $securepassword -Description
"Veeam Administrator"
Add-VBREPBackupCopyJob
Short Description
Creates an Endpoint backup copy job.
Syntax
This cmdlet provides two parameter sets.
Related Commands
Get-VBRBackup
Get-VBRBackupRepository
Get-VBRWANAccelerator
Detailed Description
This cmdlet creates a backup copy job for Endpoint backups.
The backup copy job is copying Endpoint backup files from the source backup repository to the target
backup repository. The backup copy job runs continuously synchronizing the backup repositories in
user-defined time periods.
The cmdlet provides two parameters sets that can be used for on-site and off-site modes:
Note that the backup copy job is created in disabled state. Run Enable-VBRJob to start the job running
on the defined schedule.
Return Type
CBackupJob or VBREPJob
Parameters
Parameter
Backup
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
True
Named
False
False
Accept
Pipeline
Input
Direct
Operation
True
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 backup copy job using the direct operation method.
The Endpoint backup is obtained with Get-VBRBackup and assigned to the '$EPbackup'
variable.
The target backup repository is obtained with Get-VBRBackupRepository and assigned to the
'$repository' variable.
Example 2
This command creates a backup copy job using WAN accelerators.
The target backup repository is obtained with Get-VBRBackupRepository and assigned to the
'$repository' variable.
The source and target WAN accelerators are obtained with Get-VBRWANAccelerator and
assigned to $wansource and $wantarget variables accordingly.
Add-VBRESX
Short Description
Adds an ESX host to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
False
False
User
True
False
False
Password
True
False
False
False
Named
False
False
SSHUser
False
Named
False
False
False
Named
False
False
SSHPort
False
Named
False
False
SSHEnable
False
Named
False
False
Description
False
Named
False
False
True
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 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 $Administrator variable
beforehand.
Add-VBRESX Name 172.16.11.188 -Credentials $Administrator
Add-VBRESXi
Short Description
Adds an ESXi host to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
False
False
User
True
False
False
True
False
False
False
Named
False
False
False
Named
False
False
True
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 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 $Administrator variable
beforehand.
Add-VBRESXi Name 172.16.11.188 -Credentials $Administrator
Add-VBRFailoverPlan
Short Description
Creates failover plan or cloud failover plan.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Related Commands
New-VBRFailoverPlanObject
New-VBRCloudFailoverPlanObject
Return Type
VBRFailoverPlan
Detailed Description
This cmdlet creates a failover plan or a cloud failover plan.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
Failover
PlanObject
True
Named
False
False
Accepts VBRFailoverPlanObject.
You can assign multiple VMs to this object.
Description
False
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
False
Named
False
False
Enable
PublicIp
Rule
<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 failover plan for a group of a DNS server and two Microsoft Exchange servers
named "MS Exchange Group Failover". The VMs are assigned to the '$DNS', '$MSExchange01',
'$MSExchange02' variables by running New-VBRFailoverPlanObject beforehand.
PS C:\PS> Add-VBRFailoverPlan -Name "MS Exchange Group Failover" FailoverPlanObject $DNS, $MSexchange01, $MSExchange02 -Description
"Failover plan for the mail servers group: DNS Server, MS Exchange 01
Server, MS Exchange 02 Server"
Example 2
This command creates a failover plan for a group of a DNS server and two Microsoft Exchange servers
named "MS Exchange Group Failover".
The VMs are assigned to the '$DNS', '$MSExchange01', '$MSExchange02' variables by running NewVBRFailoverPlanObject beforehand. The VM objects are first consolidated into a massive named
'$"MS_Exchange_Group"'.
PS C:\PS> $"MS_Exchange_Group" = $DNS, $MSexchange01, $MSExchange02
PS C:\PS> Add-VBRFailoverPlan -Name "MS Exchange Group Failover" Description "Failover plan for the mail servers group: DNS Server, MS
Exchange 01 Server, MS Exchange 02 Server" -FailoverPlanObject
$"MS_Exchage_Group"
Add-VBRFileToTapeJob
Short Description
Creates file to tape job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRFileToTapeJob -Name <String> [-Description <String>] [EjectCurrentMedium] [-ExportCurrentMediaSet] -FullBackupMediaPool
<VBRTapeMediaPool> [-IncrementalBackupMediaPool <VBRTapeMediaPool>] [ExportDays <DayOfWeek[]>] [-FullBackupPolicy <VBRFileToTapeBackupPolicy>]
[-IncrementalBackupPolicy <VBRFileToTapeBackupPolicy>] [-Object
<VBRFileToTapeObject[]>] [-UseVSS] [-UseHardwareCompression] [NotificationOptions] [-JobScriptOptions] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMediaPool
New-VBRFileToTapeBackupPolicy
New-VBRFileToTapeObject
New-VBRNotificationOptions
New-VBRJobScriptOptions
Return Type
VBRFileToTapeJob
Detailed Description
This cmdlet creates a new file to tape job.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
False
Named
False
False
Eject
Current
Medium
Export
Current
MediaSet
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Incremental
Backup
MediaPool
Export
Days
FullBackup
Policy
Incremental
Backup
Policy
False
Named
False
False
False
Named
False
False
False
Named
False
False
Notification
Options
False
Named
False
False
JobScript
Options
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
This command creates a file to tape job that backs up the "Payroll Reports" folder. The job runs once a
month and creates only full backups.
Run Get-VBRServer to get the server where the files are located. Save it to the $server
variable.
Run Get-VBRCredentials to get the credentials to access the Fileserver08. Save the credentials
to the $creds variable.
Run New-VBRFileToTapeObject. Use the $server and the $creds variables to create the object
for the job.
Get the media pool with the Get-VBRTapeMediaPool and save it to the $mediapool
variable.
Run New-VBRMonthlyOptions to create the monthly options object and save it to the
$monthlyoptions variable.
Create the tape job. Run Add-VBRFileToTapeJob and use the saved variables.
Add-VBRHvBackupCopyJob
Short Description
Creates a Hyper-V backup copy job.
Applies to
Platform: Hyper-V
For VMware, run Add-VBRViBackupCopyJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Related Commands
Get-VBRWANAccelerator
Find-VBRHvEntity
Get-VBRBackup
Get-VBRJob
Get-VBRBackupRepository
Detailed Description
This cmdlet creates a new Hyper-V backup copy job.
To add the VMs for the backup copy job, you can add VMs, backups or backup jobs. Veeam will use
this data to copy the backups of the needed VM.
You can transfer data in the following ways:
Directly. 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
True
Named
False
False
True
Named
False
False
Name
False
Named
False
False
Entity
False
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
BackupJob
Repository
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 backup copy job that will use WAN accelerators:
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.
PS C:\PS> Add-VBRHvBackupCopyJob -SourceAccelerator $wansource TargetAccelerator $wantarget -Name CopyJob1 -Entity $vms -Repository
$repository
Example 2
This command creates a direct backup copy job that will copy backups to the default backup
repository:
The backup job named "DC Backup" with the VMs to be copied is obtained with GetVBRBackup and piped down.
PS C:\PS> Get-VBRBackup -Name "DC Backup" | Add-VBRHvBackupCopyJob DirectOperation -Name "DC CopyJob"
Add-VBRHvBackupJob
Short Description
Creates a new Hyper-V backup job.
Applies to
Platform: Hyper-V
For VMware, run Add-VBRViBackupJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRHvBackupJob [-Name <String>] [-BackupRepository <CBackupRepository>]
-Entity <IHvItem[]> [-Description <String>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Find-VBRHvEntity
Detailed Description
This cmdlet creates a new Hyper-V backup job.
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
Backup
Repository
False
Named
False
False
True
Named
True
(ByValue,
ByProperty
Name)
False
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
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".
PS C:\PS> Find-VBRHvEntity -Name Exchange* | Add-VBRHvBackupJob -Name
"Exchange Backup" -BackupRepository $Repository -Description "Hyper-V
Exchange Backup"
Add-VBRHvCloudHardwarePlan
Short Description
Creates a Hyper-V hardware plan.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Add-VBRHvCloudHardwarePlan -Name <String> [-Description <String>] -Server
<CHost> [-CPU <Int32>] [-Memory <Int32>] [-NumberOfNetWithInternet <Int32>]
[-NumberOfNetWithoutInternet <Int32>] -Datastore
<VBRHvCloudHardwarePlanDatastore[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
New-VBRHvCloudHWPlanDatastore
Return Type
VBRHvCloudHardwarePlan
Detailed Description
This cmdlet creates a new hardware plan for Hyper-V environments.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
Server
True
Named
False
False
CPU
False
Named
False
False
Memory
False
Named
False
False
Number
OfNetWith
Internet
False
Named
False
False
Number
OfNet
Without
Internet
False
Named
False
False
Datastore
False
Named
False
False
Accepts VBRHvCloudHardwarePlanDatastore
object.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Add-VBRHvCloudReplicaJob
Short Description
Creates a new Hyper-V cloud replication job.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRHvCloudReplicaJob -Server <VBRCloudServer> -Datastore
<VBRCloudDatastore> -Entity <IHvItem[]> [-Name <string>] [-Suffix <string>]
[-Description <string>] [-SourceRepository <CBackupRepository[]>] [BackupRepository <CBackupRepository>] [-EnableNetworkMapping] [SourceNetwork <VBRHvServerNetworkInfo[]>] [-TargetNetwork
<VBRCloudServerNetworkInfo[]>] [-SourceWANAccelerator <CWanAccelerator>] [SourceProxy <CHvProxy[]>] [<CommonParameters>]
Related Commands
Get-VBRCloudServer
Get-VBRCloudDatastore
Find-VBRHvEntity
Get-VBRBackupRepository
Get-VBRHvServerNetworkInfo
Get-VBRCloudServerNetworkInfo
Get-VBRWANAccelerator
Get-VBRHvProxy
Detailed Description
This cmdlet creates a new Hyper-V cloud replication job. Cloud replication creates a VM replica on a
cloud host and maintains it in synch with the original VM.
Note that cloud replication does not support replica from backup.
When you create a replication job, you can configure the following additional settings:
Network mapping: this option allows you to configure network mapping rules if the
production site and the cloud host uses separate virtual networks. Use the
EnableNetworkMapping parameter to enable the network mapping and the
SourceNetwork and the TargetNetwork parameters to select the networks.
Proxy server: this options allow you to assign a particular proxy server for the data
transfer. Use the SourceProxy parameter to set the proxy.
WAN accelerators: this options allow you to use the built-in WAN accelerators to optimize
the data transfer. Note that WAN accelerators must work in pair, so you can use the WAN
acceleration only if the cloud provider has a WAN accelerator on the target side. Use the
SourceWANAccelerator parameter to set the source WAN accelerator.
Ri-IP rules: this option allows you to configure different IP addressing scheme for the
production site and the cloud host. You need to create an object containing the re-IP rules
beforehand by running New-VBRHvReplicaReIpRule. Then pass the created object to the
ReIpRule parameter of this cmdlet.
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 manually.
Run Set-VBRJobSchedule to set schedule for the job and run it automatically.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Server
Datastore
Suffix
Source
Repository
Backup
Repository
Mapping
Source
Network
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Source
Proxy
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Add-VBRHvCluster
Short Description
Adds a Hyper-V cluster to Veeam Backup & Replication.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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 parameter sets for both scenarios accordingly. When you provide
authentication with the Hyper-V cluster, you get equal rights for all clustered VMs.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
User
True
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Password
True
Named
False
False
False
Named
False
False
True
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Description Specifies the description of the Hyper-V cluster.
If not set, Veeam Backup & Replication will enter
date and time of creation by default.
Credentials Specifies the credentials you want to use for
authenticating with the Hyper-V cluster.
If you use the Credentials scenario, the -User and
-Password parameters must be omitted.
<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 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
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet adds Hyper-V host to the Veeam Backup & Replication managing 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 parameter sets for both scenarios accordingly.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
User
True
Named
False
False
True
Named
False
False
False
Named
False
False
True
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 adds a new Hyper-V host 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
Platform: Hyper-V
For VMware, run Add-VBRViJobObject.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRHvJobObject -Job <CBackupJob> -Entities <IHvItem[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Find-VBRHvEntity
Detailed Description
This cmdlet allows to add VM(s) to an existing job.
You can run this cmdlet with any kind of jobs.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
True
Named
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Add-VBRHvJobObject -Job $"Backup Hv Job" -Entities $Vm
Add-VBRHvProxy
Short Description
Adds a Hyper-V backup proxy to Veeam Backup & Replication.
Applies to
Platform: Hyper-V
For VMware, run Add-VBRViProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRHvProxy -Server <CHost> [-Description <String>] [-MaxTasks <Int32>]
[-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet adds a Hyper-V backup proxy server to the Veeam Backup & Replication managing
console.
When you add a proxy, you set a role to a Microsoft Windows server. To add a new proxy, you need to
have the server added to your Veeam Backup & Replication managing console.
Run Add-VBRWinServer to add a Microsoft Windows server.
Parameters
Parameter
Server
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
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 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
Platform: Hyper-V
For VMware, run Add-VBRViReplicaJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRHvReplicaJob -Server <CHost> -Entity <IHvItem[]> [-Name <string>] [Path <string>] [-Suffix <string>] [-Description <string>] [SourceRepository <CBackupRepository[]>] [-BackupRepository
<CBackupRepository>] [-ReIpRule <VBRHvReplicaReIpRule[]>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Find-VBRHvEntity
Get-VBRBackupRepository
Detailed Description
This cmdlet creates a new Hyper-V replication job.
You can select a data source from which VM data must be read:
Actual VM: Veeam Backup & Replication will copy an actual VM from production storage. The
created replica will mirror an actual VM state.
Use the Entity parameter to indicate the VMs you want to replicate.
Replica from backup files: Veeam Backup & Replication will build a replica from backup files
stored on a backup repository. The created replica will be in the latest state the VM is
available in backups.
Use the Entity parameter to indicate the VMs you want to replicate and the
BackupRepository parameter to set the repository from where the backup files must be
read.
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 manually.
Run Set-VBRJobSchedule to set schedule for the job and run it automatically.
Parameters
Parameter
Name
Description
Specifies the name you want to assign to the
replication job.
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
True
Named
False
False
Path
True
Named
False
False
Entity
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Suffix
Backup
Repository
ReIpRule
<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 job that replicates an SQL02 server. The replica is located on another host.
The host to locate the replicated VM on is obtained with Get-VBRServer and assigned to the
'$targetserver' variable beforehand.
Example 2
This command creates a replica of an SQL server from backup. The replica is located on another host.
The VM to replicate is obtained with Find-VBRHvEntity and assigned to the '$sql02' variable.
The host to locate the replicated VM on is obtained with Get-VBRServer and assigned to the
'$targetserver' variable beforehand.
The replica will be built from the SQL02 backup files that are located on a backup repository.
The repository is obtained with Get-VBRBackupRepository and assigned to the '$repository'
variable beforehand.
Add-VBRHvScvmm
Short Description
Adds a SCVMM server to Veeam Backup & Replication.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
User
True
Named
False
False
True
Named
False
False
True
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Password
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 adds the SCVMM server using a username and a password.
Add-VBRHvScvmm -Name "SCVMM1" -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 $SCVMMAdministrator variable beforehand.
Add-VBRHvScvmm -Name "SCVMM1" -Description "SCVMM Server" -Credentials
$SCVMMAdministrator
Add-VBRLinux
Short Description
Adds a Linux server to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Related Commands
Get-VBRCredentials
Detailed Description
This cmdlet adds 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.
To add a Linux host using an SSH key fingerprint, run this cmdlet with the Confirm parameter.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Name
True
False
False
SSHUser
True
False
False
True
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
Description
WhatIf
False
Named
False
False
Confirm
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 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"
Example 3
This command adds the Linux server with the 172.11.16.13 IP address using an SSH key fingerprint.
The Confirm parameter is used to verify the connection with SSH key fingerprint.
PS C:\PS> Add-VBRLinux -Name "172.11.16.13" -SSHUser "Administrator" SSHPassword "Password" -SSHPort 22 -Confirm
Confirm
Are you sure you want to perform this action?
Performing operation "Add-VBRLinux" on Target "172.11.16.13"
"SSH key fingerprint:
ssh-dss 1024 7a:64:8d:7d:12:72:e9:e1:28:42:94:51:55:65:13:7a
Do you trust this server?".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help
(default is "Y"): Y
Add-VBRScaleOutBackupRepository
Short Description
Adds a new scale-out backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRScaleOutBackupRepository -PolicyType
<VBRScaleOutBackupRepositoryPolicyType> {DataLocality | Performance} Extent <CBackupRepository[]> [-Name <string>] [-Description <string>] [UsePerVMBackupFiles] [-PerformFullWhenExtentOffline] [<CommonParameters>]
Related Commands
Get-VBRRepositoryExtent
Return Type
VBRScaleOutBackupRepository
Detailed Description
This cmdlet creates a scale-out backup repository.
You can create a repository with a selected policy:
With the DataLocality policy, the dependent backups are placed to the same extent (for
example, restore points of one VM).
With the Performance policy, Veeam distributes backups in order to provide better
performance. With this policy, you can additionally configure extents to store only full
backups, only incremental backups or full and incremental backups (default). Run SetVBRRepositoryExtent to set the backup placement mode.
Parameters
Parameter
Name
Description
Required Position
Accept
Wildcard
Characters
False
Named
True
(ValueFromPipeline
ByPropertyName)
False
False
Named
True
(ValueFromPipeline
ByPropertyName)
False
Accept
Pipeline
Input
Policy
Type
True
Named
True
(ValueFromPipeline
ByPropertyName)
False
Extent
True
Named
False
False
Named
True
(ValueFromPipeline
ByPropertyName)
False
False
Named
True
(ValueFromPipeline
ByPropertyName)
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
This command creates a performance scale-out repository.
PS C:\PS> Add-VBRScaleOutBackupRepository -Name "Veeam Performance ScaleOut Repository" PolicyType Performance Extent Backup Repository 1,
Backup Repository 2
Add-VBRSmbV3Cluster
Short Description
Adds an SMB3 cluster to Veeam Backup & Replication.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
User
True
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Password
True
Named
False
False
False
Named
False
False
True
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Description Specifies the description of the SMB3 cluster.
If not set, Veeam Backup & Replication will enter
date and time of creation by default.
Credentials Specifies the credentials you want to use for
authenticating with the SMB3 cluster.
If you use the Credentials scenario, the -User and
-Password parameters must be omitted.
<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 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
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet adds an SMB3 host to the Veeam Backup & Replication managing console.
If an SMB3 host is part of a cluster, add the SMB3 cluster instead of standalone SMB3 host.
Run Add-VBRSmbV3Cluster to add an SMB3 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.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
User
True
Named
False
False
True
Named
False
False
False
Named
False
False
True
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 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 Host
01".
Add-VBRSmbV3Host -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 Host 01".
Add-VBRSmbV3Host -Name "SMBShare010" -Description "Hyper-V SMB Share Host
010" -Credentials $Administrator
Add-VBRTapeGFSMediaPool
Short Description
Creates a new GFS media pool.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRTapeGFSMediaPool -Name <string> -Library <VBRTapeLibrary[]> [Description <string>] [-Medium <VBRTapeMedium[]>] [-MoveFromFreePool] [EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [-NextLibOffline] [NextLibDrivesBusy] [-NextLibNoMedia] [-WeeklyOverwritePeriod <int>] [MonthlyOverwritePeriod <int>] [-QuarterlyOverwritePeriod <int>] [YearlyOverwritePeriod <int>] [-WeeklyMediaSetPolicy
<VBRTapeGFSMediaSetPolicy>] [-MonthlyMediaSetPolicy
<VBRTapeGFSMediaSetPolicy>] [-QuarterlyMediaSetPolicy
<VBRTapeGFSMediaSetPolicy>] [-YearlyMediaSetPolicy
<VBRTapeGFSMediaSetPolicy>] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Get-VBREncryptionKey
New-VBRTapeGFSMediaSetPolicy
Return Type
VBRTapeGFSMediaPool
Detailed Description
This cmdlet creates a new GFS media pool. The media sets are created with default settings.
Run New-VBRTapeGFSMediaSetPolicy to set other options for media sets.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
True
Named
False
False
Library
True
Named
False
NextLibOffline,
NextLibDrivesBusy and/or
NextLibNoMedia parameters to
manage the libraries.
You can assign multiple tapes to
this object. Veeam will switch to
the nest library in order they are
added to the VBRTapeLibrary
object.
Accepts VBRTapeLibrary object,
GUID or string type.
Medium
False
Named
False
False
False
Named
False
False
MoveFrom
FreePool
False
Named
False
False
Enable
Encryption
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
NextLib
DrivesBusy
NextLib
NoMedia
Weekly
Overwrite
Period
Quarterly
Overwrite
Period
Yearly
Overwrite
Period
Weekly
MediaSet
Policy
Monthly
MediaSet
Policy
Quarterly
MediaSet
Policy
Yearly
MediaSet
Policy
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Accepts
VBRTapeGFSMediaSetPolicy
object.
Accepts
VBRTapeGFSMediaSetPolicy
object.
Accepts
VBRTapeGFSMediaSetPolicy
object.
Accepts
VBRTapeGFSMediaSetPolicy
object.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Add-VBRTapeMediaPool
Short Description
Creates a new media pool.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRTapeMediaPool -Name <string> -Library <VBRTapeLibrary[]> [Description <string>] [-Medium <VBRTapeMedium[]>] [-MoveFromFreePool] [MoveOfflineToVault] [-Vault <VBRTapeVault>] [-EnableEncryption] [EncryptionKey <VBREncryptionKey>] [-MediaSetCreationPolicy
<VBRTapeMediaSetCreationPolicy>] [-MediaSetName <string>] [-RetentionPolicy
<VBRTapeMediaPoolRetentionPolicy>] [-NextLibOffline] [-NextLibDrivesBusy]
[-NextLibNoMedia] [-EnableMultiStreaming] [-SplitJobFilesBetweenDrives] [NumberOfStreams <int>] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Get-VBRTapeMedium
Get-VBRTapeVault
Get-VBREncryptionKey
New-VBRTapeMediaPoolRetentionPolicy
New-VBRTapeMediaSetCreationPolicy
Return Type
VBRTapeMediaPool
Detailed Description
This cmdlet creates a new custom media pool.
Run Add-VBRTapeGFSMediaPool to create a GFS media pool.
Parameters
Parameter
Description
Require
d
Positio
n
Accept
Pipeline
Input
Accept
Wildcard
Character
s
Name
True
Named
False
False
Library
True
Named
False
ByPropertyName)
False
Named
False
False
False
Named
False
False
MoveFrom
FreePool
False
Named
False
False
MoveOffline
ToVault
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Enable
Encryption
Encryption
Key
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Retention
Policy
NextLib
Offline
NextLib
DrivesBusy
NextLib
NoMedia
Enable
MultiStreamin
g
SplitJobFiles
BetweenDrives
False
Named
False
False
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 media pool named "Monthly Full Backups" with default settings.
Get the library in which the media pool is created with Get-VBRTapeLibrary and pipe down.
Omit other parameters. The media set policy and retention policy will be set to default.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | AddVBRTapeMediaPool -Name "Monthly Full Backups" -MoveFromFreePool
Example 2
This command creates a media pool named 'AD Backups Encrypted'. The offline tape will be moved to
vault. The tape archive will be encrypted . The media set creation policy and the retention policy will
be configured beforehand.
The description of the new media pool is set to 'Active Directory Encrypted Backups'.
The library in which the media pool is created is obtained with Get-VBRTapeLibrary and
assigned to the '$HPtapelibrary' variable beforehand.
The tapes that will be included to the media pool are obtained with Get-VBRTapeMedium
and assigned to the '$media' variable beforehand.
The MoveOfflineToVault parameter is used to move the tapes to vault. The target vault is
obtained with Get-VBRTapeVault and assigned to the '$vault' variable beforehand.
The EnableEncryption parameter is set to encrypt the data. The encryption key that must be
used is obtained with Get-VBREncryptionKey and assigned to the '$securepassword' variable
beforehand.
The custom policy for creating media sets is configured with NewVBRTapeMediaSetCreationPolicy and assigned to the '$mediasetpolicy' variable beforehand.
The media set name is set to "AD Daily %date%".
Add-VBRTapeServer
Short Description
Adds tape server to Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRTapeServer [-Description <string>] [-Server <CHost>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRTapeServer
Detailed Description
This cmdlet adds a tape server to the Veeam Backup & Replication managing console.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
False
Named
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 adds a server named 'WindowsServer01' as a tape server. The server is obtained with
Get-VBRServer and piped down. The description is set to "Sydney Office tape server".
PS C:\PS> Get-VBRServer -Name WindowsServer01 | Add-VBRTapeServer Description "Sydney Office tape server"
Example 2
This command adds a server represented by the '$tapeserver' variable as a tape server. The server is
obtained with Get-VBRServer and assigned to the variable beforehand.
PS C:\PS> Add-VBRTapeServer -Server $tapeserver
Add-VBRTapeVault
Short Description
Creates a tape vault.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Add-VBRTapeVault -Name <String> [-Description <String>] [-Protect] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRTapeVault
Detailed Description
This cmdlet creates a new tape vault.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
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
This command creates a vault named "Sydney Remote Storage".
PS C:\PS> Add-VBRTapeVault -Name "Sydney Remote Storage" -Description
"Veeam backups offsite"
Add-VBRvCenter
Short Description
Adds a vCenter Server to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet allows you to add a vCenter Server to Veeam Backup & Replication.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
False
False
User
True
False
False
True
False
False
True
Named
False
False
Port
False
Named
False
False
False
Named
False
False
Default: 443
Description Specifies the description of the vCenter Server.
If not set, Veeam Backup & Replication will enter
date and time of creation by default.
<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 adds the vCenter Server named "vc25.domain.local" using a username and a password.
The user name is "Administrator" and the password is "Password".
Add-VBRvCenter -Name "vc25.domain.local" -User "Domain\Administrator" Password "Password" -Description "vcdev25 vCenter Server"
Example 2
This command adds the vCenter Server named "vc25.domain.local" using credentials. The credentials
record is obtained with Get-VBRCredentials and assigned to the '$vc_administrator' variable
beforehand.
Add-VBRvCenter -Name "vc25.domain.local" -Description "vcdev25 vCenter
Server" -Credentials $vc_administrator
Add-VBRvCloud
Short Description
Adds a vCloud Director server to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Name
True
False
False
User
True
False
False
True
False
False
True
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Password
Url
False
Named
False
False
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 new server named "vCloudDirectorServer" having the
https://vclouddirectorserver:443 URL address. The username is "Administrator" and the password is
"password".
PS C:\PS> Add-VBRvCloud -Name "vCloudDirectorServer" -User Administrator Password password -Url https://vclouddirectorserver:443 -Description
"vCloud Director Server"
Example 2
This command creates a new server named "vCloudDirectorServer" 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.
PS C:\PS> Add-VBRvCloud -Name "vCloudDirectorServer" -Credentials
$Administrator -Url https://vclouddirectorserver:443
Add-VBRvCloudBackupCopyJob
Short Description
Creates a vCloud backup copy job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet creates a new vCloud backup copy job. The vCloud backup copy job uses a cloud
repository as the target.
To add the VMs for the backup copy job, you can add VMs, backups or backup jobs. Veeam will use
this data to copy the backups of the needed VM.
You can transfer data in the following ways:
Directly. 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
Entity
False
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
Backup
BackupJob
Repository
<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 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.
PS C:\PS> Add-VBRvCloudBackupCopyJob -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 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.
PS C:\PS> Get-VBRBackup -Name "DC Backup" | Add-VBRvCloudBackupCopyJob DirectOperation -Name "DC CopyJob"
Add-VBRvCloudJob
Short Description
Creates a vCloud Director backup job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRvCloudJob -Entity <IItem[]> [-Name <string>] [-BackupRepository
<CBackupRepository>] [-Description <string>] [<CommonParameters>]
Related Commands
Find-VBRvCloudEntity
Get-VBRBackupRepository
Detailed Description
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.
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
Parameter
Entity
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
True
False
False
Named
False
False
Backup
Repository
False
Named
False
False
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 new vCloud Director backup job with the following parameters:
PS C:\PS> 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:
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.
PS C:\PS> 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
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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 ([-Vc])
Get-VBRCredentials
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
VCInfo
True
False
False
User
True
False
False
Password
True
False
False
True
Named
False
False
Name
False
Named
False
False
Port
False
Named
False
False
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 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 new vCenter Server is obtained with Find-VBRvCloudEntity ([-Vc]) and assigned to $vc
variable beforehand.
The -Port parameter is not set to enable the default 443 web-service port number.
PS C:\PS> 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 new vCenter Server is obtained with Find-VBRvCloudEntity ([-Vc]) and assigned to $vc
variable beforehand.
The -Port parameter is set to 456 to set the connection through web-service port number 456
instead of default 443 port.
Add-VBRViBackupCopyJob
Short Description
Creates a VMware backup copy job.
Applies to
Platform: VMware
For Hyper-V, run Add-VBRHvBackupCopyJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Related Commands
Get-VBRWANAccelerator
Find-VBRViEntity
Get-VBRBackup
Get-VBRJob
Get-VBRBackupRepository
Detailed Description
This cmdlet creates a new VMware backup copy job.
To add the VMs for the backup copy job, you can add VMs, backups or backup jobs. Veeam will use
this data to copy the backups of the needed VM.
You can transfer data in the following ways:
Directly. 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
True
Named
False
False
True
Named
False
False
Name
False
Named
False
False
Entity
False
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
BackupJob
Repository
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 backup copy job that will use WAN accelerators:
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.
PS C:\PS> Add-VBRViBackupCopyJob -SourceAccelerator $wansource TargetAccelerator $wantarget -Name CopyJob1 -Entity $vms -Repository
$repository
Example 2
This command creates a direct backup copy job that will copy backups to the default backup
repository:
The backup job named "DC Backup" with the VMs to be copied is obtained with GetVBRBackup and piped down.
PS C:\PS> Get-VBRBackup -Name "DC Backup" | Add-VBRViBackupCopyJob DirectOperation -Name "DC CopyJob"
Add-VBRViBackupJob
Short Description
Creates a new VMware backup job.
Applies to
Platform: VMware
For Hyper-V, run Add-VBRHvBackupJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRViBackupJob [-Name <String>] [-BackupRepository <CBackupRepository>]
-Entity <IViItem[]> [-Description <String>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Find-VBRViEntity
Detailed Description
This cmdlet creates a new VMware backup job.
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
Backup
Repository
False
Named
False
False
True
Named
True
(ByValue,
ByProperty
Name)
False
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
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".
PS C:\PS> Find-VBRViEntity -Name Exchange* | Add-VBRViBackupJob -Name
"Exchange Backup" -BackupRepository $Repository -Description "VMware
Exchange Backup"
Add-VBRViCloudHardwarePlan
Short Description
Creates a VMware hardware plan.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Add-VBRViCloudHardwarePlan -Name <String> [-Description <String>] -Server
<Object> [-CPU <Int32>] [-Memory <Int32>] [-NumberOfNetWithInternet
<Int32>] [-NumberOfNetWithoutInternet <Int32>] -Datastore
<VBRViCloudHardwarePlanDatastore[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRViCloudHardwarePlan
Detailed Description
This cmdlet creates a new hardware plan for VMware environments.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
Server
True
Named
False
False
CPU
False
Named
False
False
Memory
False
Named
False
False
Number
OfNetWith
False
Named
False
False
Internet
hardware plan.
Number
OfNet
Without
Internet
False
Named
False
False
Datastore
True
Named
False
False
Accepts VBRViCloudHardwarePlanDatastore
object.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Add-VBRViCloudReplicaJob
Short Description
Creates a new VMware cloud replication job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRViCloudReplicaJob -Entity <IViItem[]> -Server <VBRCloudServer> Datastore <VBRCloudDatastore> [-Name <string>] [-Description <string>] [Suffix <string>] [-BackupRepository <CBackupRepository>] [-SourceRepository
<CBackupRepository[]>] [-EnableNetworkMapping] [-SourceNetwork
<VBRViNetworkInfo[]>] [-TargetNetwork <VBRCloudServerNetworkInfo[]>] [SourceProxy <CViProxy[]>] [-SourceWANAccelerator <CWanAccelerator>] [DiskType <EDiskCreationMode> {Source | Thick | Thin}] [<CommonParameters>]
Related Commands
Find-VBRViEntity
Get-VBRCloudServer
Get-VBRCloudDatastore
Get-VBRBackupRepository
Get-VBRViServerNetworkInfo
Get-VBRViProxy
Get-VBRWANAccelerator
Detailed Description
This cmdlet creates a new VMware cloud replication job. Cloud replication creates a VM replica on a
cloud host and maintains it in synch with the original VM.
Note that cloud replication does not support replica from backup.
When you create a replication job, you can configure the following additional settings:
Network mapping: this option allows you to configure network mapping rules if the
production site and the cloud host uses separate virtual networks. Use the
EnableNetworkMapping parameter to enable the network mapping and the
SourceNetwork and the TargetNetwork parameters to select the networks.
Proxy server: this options allow you to assign particular proxy server for the data transfer.
Use the SourceProxy parameter to set the proxy explicitly or leave the default (Automatic
selection).
WAN accelerators: this options allow you to use the built-in WAN accelerators to optimize
the data transfer. Note that WAN accelerators must work in pair, so you can use the WAN
acceleration only if the cloud provider has a WAN accelerator on the target side. Use the
SourceWANAccelerator parameter to set the source WAN accelerator.
Ri-IP rules: this option allows you to configure different IP addressing scheme for the
production site and the cloud host. You need to create an object containing the re-IP rules
beforehand by running New-VBRViReplicaReIpRule. Then pass the created object to the
ReIpRule parameter of this cmdlet.
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 manually.
Run Set-VBRJobSchedule to set schedule for the job and run it automatically.
Parameters
Parameter
Entity
Description
Required Position
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Server
Accept
Pipeline
Input
Name
Backup
Repository
Source
Repository
Enable
Network
Mapping
Source
Network
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Source
Proxy
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Add-VBRViJobObject
Short Description
Adds a VM to a VMware job.
Applies to
Platform: VMware
For Hyper-V, run Add-VBRHvJobObject.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRViJobObject -Job <CBackupJob> -Entities <IViItem[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Find-VBRViEntity
Detailed Description
This cmdlet adds VM(s) to an existing job.
You can run this cmdlet with any kind of jobs.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
True
Named
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> Find-VBRViEntity -Name VM01 | Add-VBRViJobObject -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.
PS C:\PS> Add-VBRViJobObject -Job $job -Entities $Vm
Add-VBRViProxy
Short Description
Adds a VMware backup proxy to Veeam Backup & Replication.
Applies to
Platform: VMware
For Hyper-V, run Add-VBRHvProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRViProxy -Server <CHost> [-Description <String>] [-MaxTasks <Int32>]
[-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet adds a VMware backup proxy server to the Veeam Backup & Replication managing
console.
When you add a proxy, you set a role to a Microsoft Windows server. To add a new proxy, you need to
have the server added to your Veeam Backup & Replication managing console.
Run Add-VBRWinServer to add a Microsoft Windows server.
Parameters
Parameter
Server
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
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 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
Creates a new VMware replication job.
Applies to
Platform: VMware
For Hyper-V, run Add-VBRHvReplicaJob.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Add-VBRViReplicaJob -Server <CHost> -Entity <IViItem[]> [-Name <string>] [Datastore <CViDatastoreItem>] [-StoragePolicy <VBRViStoragePolicy>] [ResourcePool <CViResourcePoolItem>] [-Folder <CViFolderItem>] [-Suffix
<string>] [-BackupRepository <CBackupRepository>] [-Description <string>]
[-EnableNetworkMapping] [-SourceNetwork <VBRViNetworkInfo[]>] [TargetNetwork <VBRViNetworkInfo[]>] [-SourceProxy <CViProxy[]>] [TargetProxy <CViProxy[]>] [-SourceWANAccelerator <CWanAccelerator>] [TargetWANAccelerator <CWanAccelerator>] [-RestorePointsToKeep <int>] [SourceRepository <CBackupRepository[]>] [-ReIpRule
<VBRViReplicaReIpRule[]>] [-DiskType <EDiskCreationMode> {Source | Thick |
Thin}] [<CommonParameters>]
Related Commands
Get-VBRServer
Find-VBRViEntity
Find-VBRViDatastore
Find-VBRViStoragePolicy
Find-VBRViResourcePool
Find-VBRViFolder
Get-VBRBackupRepository
Get-VBRViServerNetworkInfo
Get-VBRViProxy
Get-VBRWANAccelerator
New-VBRViReplicaReIpRule
Detailed Description
This cmdlet creates a new VMware replication job.
You can select a data source from which VM data must be read:
Actual VM: Veeam Backup & Replication will copy an actual VM from production storage. The
created replica will mirror an actual VM state.
Use the Entity parameter to indicate the VMs you want to replicate.
Replica from backup files: Veeam Backup & Replication will build a replica from backup files
stored on a backup repository. The created replica will be in the latest state the VM is
available in backups.
Use the Entity parameter to indicate the VMs you want to replicate and the
SourceRepository parameter to set the repository from where the backup files must be read.
When you create a replication job, you can configure the following additional settings:
Storage policy profile: you can apply a particular VMware storage policy profile to virtual disks
of the replica VM. Use the StoragePolicy parameter to set the profile.
Network mapping: this option allows you to configure network mapping rules if the
production site and DR site uses separate virtual networks. Use the EnableNetworkMapping
parameter to enable the network mapping and the SourceNetwork and the TargetNetwork
parameters to select the networks.
Proxy servers: this options allow you to configure particular proxy servers for the data
transfer. Use the SourceProxy and the TargetProxy parameters to set the proxies.
WAN accelerators: this options allow you to use the built-in WAN accelerators to optimize the
data transfer. Use the SourceWANAccelerator and the TargetWANAccelerator parameters
to set the WAN accelerators. Note that WAN acceleration is available only in the Enterprise
Plus edition.
Ri-IP rules: this option allows you to configure different IP addressing scheme for the
production and the DR sites. You need to create an object containing the re-IP rules before
hand by running New-VBRViReplicaReIpRule. Pass the created object to the ReIpRule
parameter of this cmdlet.
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 manually.
Run Set-VBRJobSchedule to set schedule for the job and run it automatically.
Parameters
Parameter
Name
Description
Specifies the string with the name of the
created replication job.
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
True
Named
False
False
Entity
True
Named
True
(ByValue,
ByProperty
Name)
False
Datastore
False
Named
False
False
Storage
Policy
False
Named
False
False
Resource
Pool
False
Named
False
False
Folder
False
Named
False
False
Suffix
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Source
Network
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Source
Proxy
Target
Proxy
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Source
Repository
ReIpRule
<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 adds a new job named "DC Replication Job" replicating a VM named "DC".
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.
Example 2
This command creates a new job named "DC Replication Job" replicating a VM represented by the
$vm variable.
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 FindVBRViDatastore and Find-VBRViResourcePool and assigned to the $datastore and $pool
variables accorgingly beforehand.
PS C:\PS> Add-VBRViReplicaJob -Name "DC Replication Job" -Server $server Entity $vm -Datastore $datastore -ResourcePool $pool -Suffix "_replicated"
-Description "DC Replication Job"
Add-VBRWANAccelerator
Short Description
Creates a new WAN accelerator.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise Plus
Syntax
Add-VBRWANAccelerator -Server <CHost> [-Description <String>] [-CachePath
<String>] [-CacheSize <UInt32>] [-CacheSizeUnit <ESizeUnit>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
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.
Parameters
Parameter
Server
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
CachePath
False
Named
False
False
CacheSize
False
Named
False
False
CacheSize
Unit
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 new WAN accelerator on the Veeam backup server:
The Veeam backup server is obtained with Get-VBRLocalhost and piped down.
The folder path where the new WAN accelerator will be created is c:\WAN.
Example 2
This command creates a new WAN accelerator with the following parameters:
The server where the WAN accelerator will be created is obtained with Get-VBRServer and
assigned to the $server variable beforehand.
The folder path where the new WAN accelerator will be created is c:\WAN.
Add-VBRWinServer
Short Description
Adds Windows server to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet adds a Windows server to the 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.
Parameters
Parameter
Description
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
User
True
Named
False
False
True
Named
False
False
False
Named
False
False
If you use the Username/Password scenario, the Credentials parameter must be omitted.
Password
True
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 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-VNXHost
Short Description
Adds EMC VNX storage to Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Add-VNXHost -Type <VBRVNXHostType> {VNXFile | VNXBlock | VNXe} -UserName
<string> -Password <string> [-Name <string>] [-Description <string>] [CredentialsScope <VBRVNXBlockCredentialsScope> {Global | Local | LDAP}] [WhatIf] [-Confirm] [<CommonParameters>]
-ORAdd-VNXHost -Type <VBRVNXHostType> {VNXFile | VNXBlock | VNXe} -Credentials
<CCredentials> [-Name <string>] [-Description <string>] [-CredentialsScope
<VBRVNXBlockCredentialsScope> {Global | Local | LDAP}] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCredentials
Detailed Description
This cmdlet adds the selected EMC VNX 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 storage infrastructure manually, run Sync-VNXHost or
Sync-VNXVolume.
When adding a storage, you will need to provide either username/password or credentials. This
cmdlet provides syntax for both scenarios accordingly.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Type
True
Named
False
False
UserName
True
Named
False
False
Password
True
Named
False
False
Name
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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.
Add-VNXSnapshot
Short Description
Creates a EMC VNX storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Add-VNXSnapshot -Volume <CSanVolume> [-Name <string>]
[<CommonParameters>]
Related Commands
Get-VNXVolume
Detailed Description
This cmdlet creates a snapshot of the selected EMC VNX storage volume.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Volume
True
Named
False
False
Name
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.
Add-VSBHvApplicationGroup
Short Description
Creates a Hyper-V application group for SureBackup job.
Applies to
Platform: Hyper-V
For VMware, run Add-VSBViApplicationGroup.
Product Edition: Enterprise, Enterprise Plus
Syntax
Add-VSBHvApplicationGroup [-Name <String>] [-VmFromBackup <CHvVmItem[]>] [RestorePoint <COib[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]>]
Related Commands
Find-VBRHvEntity
Get-VBRRestorePoint
Detailed Description
This cmdlet creates a new Hyper-V application group.
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.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
VmFrom
Backup
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
True
(ByValue,
ByProperty
Name)
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 new application group named "Microsoft 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.
PS C:\PS> Find-VBRHvEntity -Name "DC", "DNSServer" | AddVSBHvApplicationGroup -Name "Microsoft 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.
PS C:\PS> Add-VSBHvApplicationGroup -Name "MailServer Appgroup" RestorePoint $restorepoint
Add-VSBHvJob
Short Description
Creates a Hyper-V SureBackup job.
Applies to
Platform: Hyper-V
For VMware, run Add-VSBJob.
Product Edition: Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet adds a new Hyper-V SureBackup job.
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.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
VirtualLab
True
Named
True
(ByValue,
ByProperty
Name)
False
AppGroup
False
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
True
(ByValue,
ByProperty
Name)
False
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 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.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> Add-VSBHvJob -Name "Exchange SureJob" -VirtualLab $VLab01 LinkedJob $"Exchange Backup"
Add-VSBHvVirtualLab
Short Description
Creates a Hyper-V virtual lab.
Applies to
Platform: Hyper-V
For VMware, run Add-VSBVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Add-VSBHvVirtualLab -Name <String> -Server <CHost> -Folder <String> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet creates a new Hyper-V virtual lab.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Name
True
Named
False
False
Server
True
Named
False
False
Folder
True
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
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.
PS C:\PS> Add-VSBHvVirtualLab -Name "Exchange VLab 01" -Server $server Folder "c:\VirtualLabs"
Add-VSBJob
Short Description
Creates a VMware SureBackup job.
Applies to
Platform: VMware
For Hyper-V, run Add-VSBHvJob.
Product Edition: Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet creates a new VMware SureBackup job.
To add VMs that you want to verify to the SureBackup job, you can use an application group
containing the list of VMs, or link a backup job which will act as a VM container.
Note that if you link a backup job, the SureBackup job will verify all VMs added to the linked job.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
VirtualLab
True
Named
True
(ByValue,
ByProperty
Name)
False
AppGroup
False
Named
True
(ByValue,
ByProperty
False
Name)
False
Named
True
(ByValue,
ByProperty
Name)
False
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 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.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> Add-VSBJob -Name "Exchange SureJob" -VirtualLab $VLab01 LinkedJob $"Exchange Backup"
Add-VSBViApplicationGroup
Short Description
Creates an application group for SureBackup job.
Applies to
Platform: VMware
For Hyper-V, run Add-VSBHvApplicationGroup.
Product Edition: Enterprise, Enterprise Plus
Syntax
Add-VSBViApplicationGroup [-Name <string>] [-VmFromBackup <CViVmItem[]>] [VmFromReplica <CViVmItem[]>] [-RestorePoint <COib[]>] [<CommonParameters>]
Related Commands
Find-VBRViEntity
Get-VBRRestorePoint
Detailed Description
This cmdlet creates an application group containing virtual machines that the application server is
dependent on.
You can add to the same application groups VMs from backups and VMs from replicas. All VMs from
the application group must have at least one valid restore point created by the time the SureBackup
job starts.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
VmFrom
Backup
False
Named
False
False
Named
VmFrom
Replica
ValueFromPipeline
ByPropertyName)
False
Named
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 new application group named "Microsoft 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.
PS C:\PS> Find-VBRViEntity -Name "DC", "DNSServer" | AddVSBHvApplicationGroup -Name "Microsoft 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.
PS C:\PS> Add-VSBViApplicationGroup -Name "MailServer Appgroup" RestorePoint $restorepoint
Add-VSBVirtualLab
Short Description
Creates a VMware virtual lab.
Applies to
Platform: VMware
For Hyper-V, run Add-VSBHvVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Add-VSBVirtualLab [-Name] <string> [-Server] <CHost> [-Datastore]
<CViDatastoreItem> [-ProductionNetwork <VBRViVirtualSwitch>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Find-VBRViDatastore
Get-VBRViVirtualSwitch
Detailed Description
This cmdlet creates a new VMware virtual lab.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Name
True
False
False
Server
True
False
False
Datastore
True
False
False
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
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.
PS C:\PS> Add-VSBVirtualLab -Name "Exchange VLab 01" -Server $server Datastore $datastore
Clear-VBRWANCache
Short Description
Removes data from WAN accelerator global cache.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise Plus
Syntax
Clear-VBRWANCache -Accelerator <CWanAccelerator> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRWANAccelerator
Detailed Description
This cmdlet clears WAN accelerator global cache.
You may need to clear the global cache, for example, if the data gets corrupted.
Parameters
Parameter
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 clears cache of WAN accelerator named "WAN 01". The accelerator is obtained with
Get-VBRWANAccelerator and piped down.
PS C:\PS> 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.
PS C:\PS> Clear-VBRWANCache -Accelerator $"accelerator01"
Connect-VBRServer
Short Description
Connects to Veeam backup server.
Syntax
This cmdlet provides three parameter sets.
[<CommonParameters>]
Connect-VBRServer -User <string> -Password <string> [-Server <string>] [Port <int>] [<CommonParameters>]
Related Commands
Get-VBRServer
Get-VBRLocalhost
Get-VBRCredentials
Return Type
None
Detailed Description
This cmdlet creates connection with a local or remote Veeam backup server. The connection starts a
Veeam PowerShell session during which you can perform all operations available with Veeam
PowerShell.
If you do not specify the server, you connect to the local Veeam backup server.
Within one session, you can connect to one Veeam server. To connect to another Veeam server, you
need to close the current session. Run Disconnect-VBRServer to stop session with the current Veeam
server.
Run Get-VBRServerSession to get information about the current session.
Parameters
Parameter
Server
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
True
Named
False
False
True
Named
False
False
True
Named
False
False
Default: localhost.
Port
User
Password
<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 connects to the 172.17.53.36 server using User/Password authentication.
PS C:\PS> Connect-VBRServer -Server "172.17.53.36" -User "Administrator" Password "Password"
Connect-VSBHvVirtualLab
Short Description
Connects an existing Hyper-V virtual lab.
Applies to
Platform: Hyper-V
For VMware, run Connect-VSBVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Connect-VSBHvVirtualLab [-VirtualLab] <CHvLabShortInfo> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Find-VSBHvVirtualLab
Detailed Description
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.
Parameters
Parameter
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Connect-VSBHvVirtualLab -VirtualLab $VLab01
Connect-VSBVirtualLab
Short Description
Connects an existing VMware virtual lab.
Applies to
Platform: VMware
For Hyper-V, run Connect-VSBHvVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Connect-VSBVirtualLab [-VirtualLab] <CVirtualLabDescriptor> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Find-VSBVirtualLab
Detailed Description
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.
Parameters
Parameter
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 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.
PS C:\PS> Find-VSBVirtualLab -Server $server -Name "Exchange VLab 01" |
Connect-VSBVirtualLab
Example 2
This command connects a virtual lab represented by the $VLab01 variable. The virtual lab object is
obtained with Find-VSBVirtualLab and assigned to the variable beforehand.
PS C:\PS> Connect-VSBVirtualLab -VirtualLab $VLab01
Copy-VBRJob
Short Description
Clones an existing job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Copy-VBRJob [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet clones an existing job. You can use the cloned job, for example, as a template, as it retains
all settings of the primary job. The cloned job is created with the name of the primary job with
'_clone<clone sequence number>' suffix.
You can run this cmdlet with backup, replication and copy jobs.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
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 clones the jobs named "DHCP Replica Job" and "DHCP Backup Job". The jobs are
obtained with Get-VBRJob and piped down.
PS C:\PS> 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.
PS C:\PS> Copy-VBRJob -Job $job
Disable-VBRCloudGateway
Short Description
Disables a selected cloud gateway.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Disable-VBRCloudGateway -CloudGateway <VBRCloudGateway[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudGateway
Return Type
VBRCloudGateway
Detailed Description
This cmdlet disables a selected cloud gateway. Disabling a gateway temporarily suspends all
operations on it. Run Enable-VBRCloudGateway to enable a disabled cloud gateway.
Parameters
Parameter
Cloud
Gateway
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 disables a cloud gateway represented by the '$cloudgateway' variable.
The cloud gateway is obtained with Get-VBRCloudGateway and assigned to the variable beforehand.
PS C:\PS> Disable-VBRCloudGateway -CloudGateway $cloudgateway
Example 2
This command disables a cloud gateway with the 172.16.12.45 IP address.
The cloud gateway is obtained with Get-VBRCloudGateway and piped down.
PS C:\PS> Get-VBRCloudGateway -Name "172.16.12.45" | DisableVBRCloudGatewaya
Disable-VBRCloudTenant
Short Description
Disables a cloud user account.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Disable-VBRCloudTenant -CloudTenant <VBRCloudTenant[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudTenant
Return Type
None
Detailed Description
This cmdlet disables a cloud user account. Disabling a user account temporarily prevents the user
from using their account recourses. Run Enable-VBRCloudTenant to enable a disabled account.
Parameters
Parameter
Cloud
Tenant
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 disables two cloud user accounts represented by the '$CloudUser1' and '$CloudUser2'
variables.
The cloud user accounts are obtained by Get-VBRCloudTenant and assigned to the variables
beforehand.
PS C:\PS> Disable-VBRCloudTenant -CloudTenant $CloudUser1, $CloudUser2
Example 2
This command disables the ABC company cloud user account.
The cloud user account is obtained by running Get-VBRCloudTenant and piped down.
PS C:\PS> Get-VBRCloudTenant -Name "ABC Company" | Disable-VBRCloudTenant
Disable-VBREPJob
Short Description
Disables Endpoint job.
Syntax
Disable-VBREPJob -Job <VBREPJob[]>
[<CommonParameters>]
Related Commands
None
Return Type
VBREPJob[]
Detailed Description
This cmdlet disables a Veeam Endpoint backup job.
When you disable a job, you temporarily put it 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-VBREPJob.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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 disables an Endpoint job represented by the '$MediaserverEP' variable. The job is
obtained with Get-VBREPJob and assigned to the variable beforehand.
PS C:\PS> $MediaserverEP = Get-VBREPJob -Name 'Backup Job Mediaserver'
PS C:\PS> Disable-VBREPJob -Job $MediaserverEP
Example 2
This command disables an Endpoint job named 'Backup Job Mediaserver'. The job is obtained with
Get-VBREPJob and piped down.
Get-VBREPJob -Name 'Backup Job Mediaserver' | Disable-VBREPJob
Disable-VBRHvProxy
Short Description
Disables a Hyper-V backup proxy.
Applies to
Platform: Hyper-V
For VMware, run Disable-VBRViProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRHvProxy -Proxy <CHvProxy[]> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRHvProxy
Detailed Description
This cmdlet allows you to disable a Hyper-V backup proxy. The disabled proxy is not used by any job.
You can enable the poxy at any time by running Enable-VBRHvProxy.
Parameters
Parameter
Proxy
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRJob -Job <CBackupJob[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Run Stop-VBRJob to stop the job once without disabling it.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 disables jobs named "Backup Job 01" and "Backup Job 02".The jobs object is obtained
with Get-VBRJob and piped down.
PS C:\PS> 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.
PS C:\PS> Disable-VBRJob -Job $job
Disable-VBRJobGuestFSIndexing
Short Description
Disables job guest file system indexing option.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRJobGuestFSIndexing [-Job] <CBackupJob[]>
[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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 guest VM files during backup. The index will be used if you
run file-level restore from your Enterprise Manager console. Indexing is not required for restore from
Veeam backup server.
You can run this cmdlet with backup and replication jobs.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Disable-VBRJobGuestFSIndexing -Job $job
Disable-VBRJobSchedule
Short Description
Disables job schedule.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRJobSchedule -Job <CBackupJob[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 disables the job named "Backup Job 01". The job object is obtained with Get-VBRJob
and piped down.
PS C:\PS> 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.
PS C:\PS> Disable-VBRJobSchedule -Job $job
Disable-VBRJobVSSIntegration
Short Description
Disables job VSS settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRJobVSSIntegration [-Job] <CBackupJob[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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 and replication jobs.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Disable-VBRJobVSSIntegration -Job $job
Disable-VBRRepositoryExtentMaintenanceMode
Short Description
Disables maintenance mode for an extent of a scale-out backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRRepositoryExtentMaintenanceMode -Extent <VBRRepositoryExtent[]>
[-RunAsync] [<CommonParameters>]
Related Commands
Get-VBRRepositoryExtent
Return Type
VBRSession
Detailed Description
This cmdlet disables maintenance mode for a selected extent or extents of scale-out backup
repositories. You can disable the maintenance mode that was enabled with EnableVBRRepositoryExtentMaintenanceMode. When you disable the maintenance mode, the extent(s)
return to normal operation.
With one command, you can disable the maintenance mode for multiple extents.
Parameters
Parameter
Extent
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True (for
string type)
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.
Disable-VBRTapeDrive
Short Description
Disables a selected tape library drive.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRTapeDrive -Drive <VBRTapeDrive[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRTapeDrive
Return Type
None
Detailed Description
This cmdlet disables a selected tape library recording drive. When you disable a drive, Veeam Backup
& Replication stops using it for read or write operations. You can disable a drive, for example, for
maintenance.
Run Enable-VBRTapeDrive to enable the drive.
Parameters
Parameter
Drive
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 disables one drive of the selected library.
Run Get-VBRTapeLibrary to get the library. Pipe it to Get-VBRTapeDrive and select the last drive in the
list. Pipe this all to Disable-VBRTapeDrive.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | GetVBRTapeDrive | Select -Last 1 | Disable-VBRTapeDrive
Example 2
This command disables a drive represented by the $drive variable.
Run Get-VBRTapeDrive with the $library variable to get the drives of this library. Select the
first drive. Save it to the $drive variable.
Disable-VBRTapeProtection
Short Description
Disables protection set for tapes.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRTapeProtection -Medium <VBRTapeMedium[]> [-PassThru]
[<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Return Type
VBRTapeMedium[]
Detailed Description
This cmdlet disables protection that was previously enabled for tapes.
You can disable protection of tapes that are both online or offline. When you disable protection, the
tape retention period returns to media pool settings.
Parameters
Parameter
Medium
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
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
This command turns off protections for the tapes named "00140009" and "00140010".
Run Get-VBRTapeMedium to get the tape and save it to the $tape variable.
Disable-VBRViProxy
Short Description
Disables a VMware backup proxy.
Applies to
Platform: VMware
For Hyper-V, run Disable-VBRHvProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Disable-VBRViProxy -Proxy <CViProxy[]> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRViProxy
Detailed Description
This cmdlet allows you to temporarily disable a VMware backup proxy. The disabled proxy is not used
by any job.
You can enable the proxy at any time by running Enable-VBRViProxy.
Parameters
Parameter
Proxy
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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-VBRViProxy -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
Disable-VSBJob
Short Description
Puts a selected SureBackup job on hold.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Disable-VSBJob -Job <CSbJob[]>
[<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet puts a selected SureBackup 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-VSBJob.
Run Stop-VSBJob to stop the job once without disabling it.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Disable-VSBJobSchedule
Short Description
Disables a selected SureBackup job schedule.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Disable-VSBJobSchedule -Job <CSbJob[]>
[<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet disables a selected SureBackup job schedule. The schedule settings are not deleted. When
you disable a job schedule, you can launch the job manually by running Start-VSBJob.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Disconnect-VBRServer
Short Description
Ends current session with Veeam backup server.
Syntax
Disconnect-VBRServer
[<CommonParameters>]
Related Commands
None
Detailed Description
This cmdlet ends the current local or remote session with Veeam backup server. The session can be
started, for example, with Connect-VBRServer or from the UI.
<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 terminates the current connection to the Veeam backup server.
PS C:\PS> Disconnect-VBRServer
Eject-VBRTapeMedium
Short Description
Ejects tape from drive.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Eject-VBRTapeMedium
[<CommonParameters>]
[<CommonParameters>]
[<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Get-VBRTapeDrive
Return Type
None
Detailed Description
This cmdlet ejects tape that is located in drive. The ejected tape is moved to a standard library slot.
You can eject a tape that is known to be located in drive, or eject a tape located in a selected drive, or
eject tapes in all drives managed by Veeam Backup & Replication. This cmdlet provides three scenarios
for each case.
Parameters
Parameter
Medium
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
True
Named
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
This command ejects tape named "00140009".
1.
Run Get-VBRTapeMedium to get the tape and save it to the $tape variable.
2.
Enable-VBRCloudGateway
Short Description
Enables a disabled cloud gateway.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Enable-VBRCloudGateway -CloudGateway <VBRCloudGateway[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudGateway
Return Type
VBRCloudGateway
Detailed Description
This cmdlet enables a selected cloud gateway that was previously disabled.
Parameters
Parameter
Cloud
Gateway
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 enables a cloud gateway represented by the '$cloudgateway' variable.
The cloud gateway is obtained with Get-VBRCloudGateway and assigned to the variable beforehand.
PS C:\PS> Enable-VBRCloudGateway -CloudGateway $cloudgateway
Example 2
This command enables two cloud gateways with the 172.16.12.45 and 172.16.12.46 IP addresses.
The cloud gateways are obtained with Get-VBRCloudGateway and piped down.
PS C:\PS> Get-VBRCloudGateway -Name "172.16.12.45", "172.16.12.45" |
Enable-VBRCloudGateway
Enable-VBRCloudTenant
Short Description
Enables disabled cloud user accounts.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Enable-VBRCloudTenant -CloudTenant <VBRCloudTenant[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudTenant
Return Type
None
Detailed Description
This cmdlet enables selected cloud user accounts that were previously disabled.
Parameters
Parameter
Cloud
Tenant
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 enables two cloud user accounts represented by the '$CloudUser1' and '$CloudUser2'
variables.
The cloud user accounts are obtained by Get-VBRCloudTenant and assigned to the variables
beforehand.
PS C:\PS> Enable-VBRCloudTenant -CloudTenant $CloudUser1, $CloudUser2
Example 2
This command enables the ABC company cloud user account.
The cloud user account is obtained by running Get-VBRCloudTenant and piped down.
PS C:\PS> Get-VBRCloudTenant -Name "ABC Company" | Enable-VBRCloudTenant
Enable-VBREPJob
Short Description
Enables a disabled Endpoint job.
Syntax
Enable-VBREPJob -Job <VBREPJob[]>
[<CommonParameters>]
Related Commands
None
Return Type
VBREPJob[]
Detailed Description
This cmdlet enables a Veeam Endpoint backup job that was previously disabled.
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.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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 enables an Endpoint job represented by the '$MediaserverEP' variable. The job is
obtained with Get-VBREPJob and assigned to the variable beforehand.
PS C:\PS> $MediaserverEP = Get-VBREPJob -Name 'Backup Job Mediaserver'
PS C:\PS> Enable-VBREPJob -Job $MediaserverEP
Example 2
This command enables an Endpoint job named 'Backup Job Mediaserver'. The job is obtained with
Get-VBREPJob and piped down.
Get-VBREPJob -Name 'Backup Job Mediaserver' | Enable-VBREPJob
Enable-VBRHvProxy
Short Description
Enables a Hyper-V backup proxy that was previously disabled.
Applies to
Platform: Hyper-V
For VMware, run Enable-VBRViProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRHvProxy -Proxy <CHvProxy[]> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRHvProxy
Detailed Description
This cmdlet enables a Hyper-V backup proxy that was previously disabled.
You can disable a proxy by running Disable-VBRHvProxy.
Parameters
Parameter
Proxy
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRJob -Job <CBackupJob[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] a[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 enables the jobs named "Backup Job 01" and "Backup Job 02". The backup jobs are
obtained with Get-VBRJob and piped down.
PS C:\PS> 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.
PS C:\PS> Enable-VBRJob -Job $job
Enable-VBRJobGuestFSIndexing
Short Description
Enables job guest file system indexing option.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRJobGuestFSIndexing [-Job] <CBackupJob[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Enable-VBRJobGuestFSIndexing -Job $job
Enable-VBRJobSchedule
Short Description
Enables job schedule.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRJobSchedule -Job <CBackupJob[]> [-WarningAction
<ActionPreference>][-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 enables the schedule for jobs named "Backup Job 01" and "File Copy Job 02". The jobs
are obtained with Get-VBRJob and piped down.
PS C:\PS> 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.
PS C:\PS> Enable-VBRJobSchedule -Job $"Backup Job 01"
Enable-VBRJobVSSIntegration
Short Description
Enables job VSS settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRJobVSSIntegration [-Job] <CBackupJob[]>
[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Enable-VBRJobVSSIntegration -Job $"Backup Job 01"
Enable-VBRRepositoryExtentMaintenanceMode
Short Description
Enables maintenance mode for an extent of a scale-out backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRRepositoryExtentMaintenanceMode -Extent <VBRRepositoryExtent[]>
[-RunAsync] [<CommonParameters>]
Related Commands
Get-VBRRepositoryExtent
Return Type
VBRSession
Detailed Description
This cmdlet enables maintenance mode for a selected extent or extents of scale-out backup
repositories.
With one command, you can switch to maintenance mode multiple extents: the extents can be of
mixed policies and belong to several scale-out repositories.
Parameters
Parameter
Extent
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True (for
string)
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.
Enable-VBRTapeDrive
Short Description
Enables a selected tape library drive.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRTapeDrive -Drive <VBRTapeDrive[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRTapeDrive
Return Type
None
Detailed Description
This cmdlet enables a selected tape library recording drive that was previously disabled.
You can disable a tape drive by running Disable-VBRTapeDrive.
Parameters
Parameter
Drive
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 enables one drive of the selected library.
Run Get-VBRTapeLibrary to get the library. Pipe it to Get-VBRTapeDrive and select the last drive in the
list. Pipe this all to the Enable-VBRTapeDrive.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | GetVBRTapeDrive | Select -Last 1 | Enable-VBRTapeDrive
Example 2
This command enables a drive represented by the $drive variable.
1.
2.
Run Get-VBRTapeDrive with the $library variable to get the drives of this library. Select the
first drive. Save it to the $drive variable.
3.
Enable-VBRTapeProtection
Short Description
Sets overwrite protection for selected tapes.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRTapeProtection -Medium <VBRTapeMedium[]> [-PassThru]
[<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Return Type
VBRTapeMedium[]
Detailed Description
This cmdlet sets software overwrite protection for selected tapes.
Protection overrides the retention settings of the media pool to set a lifelong retention period for the
selected tapes .
You can set protection for both online or offline tapes that contain data.
The protection can be switched off at any time. The retention settings will be changed to the value set
for the media pool. Run Disable-VBRTapeProtection to switch off the protection.
Parameters
Parameter
Medium
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
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
This command sets protections for the tape named "00140009".
1.
Run Get-VBRTapeMedium to get the tape and save it to the $tape variable.
2.
Enable-VBRViProxy
Short Description
Enables a VMware backup proxy that was previously disabled.
Applies to
Platform: VMware
For Hyper-V, run Enable-VBRHvProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Enable-VBRViProxy -Proxy <CViProxy[]> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRViProxy
Detailed Description
This cmdlet allows you to enable a VMware backup proxy.
You can disable a proxy by running Disable-VBRViProxy.
Parameters
Parameter
Proxy
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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
Enable-VSBJob
Short Description
Enables a disabled SureBackup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Enable-VSBJob -Job <CSbJob[]>
[<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet enables a disabled SureBackup 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-VSBJob.
Run Start-VSBJob to run a disabled job once.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Enable-VSBJobSchedule
Short Description
Enables a SureBackup job schedule.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Enable-VSBJobSchedule -Job <CSbJob[]>
[<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet enables a SureBackup job schedule.
You can enable the job schedule in case the schedule is pre-configured for a selected job. You can
enable the schedule that was was configured in a disabled state or that was disabled with DisableVSBJobSchedule.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Erase-VBRTapeMedium
Short Description
Erases data from tape.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Erase-VBRTapeMedium -Medium <VBRTapeMedium[]> [-Long] [-Wait] [WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Return Type
VBRBackupSession
Detailed Description
This cmdlet erases data from the selected tapes. The tapes are moved to the Free media pool.
The cmdlet provides two scenarios for erasing options:
Short: only the tape data header is cleared. The tape becomes available for overwriting. Short
erase is a quick procedure.
Long: all data is cleared from tape. This procedure requires more time.
Offline tapes
Parameters
Parameter
Medium
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 runs short erase on the tape named "00170010".
1.
Run Get-VBRTapeMedium to get the tape and save it to the $tape variable.
2.
Example 2
This command runs long erase on the tape named "00170010".
1.
Run Get-VBRTapeMedium to get the tape and save it to the $tape variable.
2.
Export-VBRBackup
Short Description
Exports a backup or restore point files to a selected folder.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Backup
True
False
False
Restore
Point
True
False
False
Dir
True
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 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.
PS C:\PS> 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.
PS C:\PS> Export-VBRBackup -RestorePoint $"AD_local" -Dir "C:\Export"
Export-VBRLogs
Short Description
Collects system logs for export.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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
Parameter
Server
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
To
False
Named
False
False
Job
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
False
False
Compress
False
Named
False
False
Backup
<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 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. Run Get-VBRServer to get the source server.
PS C:\PS> 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.
PS C:\PS> 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, 2015. The VM is obtained with
Find-VBRViEntity and piped down. The destination path is C:\Logs. The data compression is enabled.
PS C:\PS> Find-VBRViEntity -Name "DC" | Export-VBRLogs -FolderPath
"C:\Logs" -Compress -From 5/01/2015 -To 6/01/2015
Export-VBRTapeMedium
Short Description
Moves tape to Import/Export slot.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Export-VBRTapeMedium -Medium <VBRTapeMedium[]> [-Wait]
[<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Return Type
VBRBackupSession
Detailed Description
This cmdlet exports selected tapes to the Import/Export slot. You need to to run the exporting
procedure if you want to take the tapes out of the tape library.
Note:
Import/export commands are available only for the devices that support corresponding operations
and include I/E slot.
Parameters
Parameter
Medium
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
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
This command exports tape named "00170008".
1.
Run Get-VBRTapeMedium to get the tape and save it to the $tape variable.
2.
Find-VBRHvEntity
Short Description
Looks for Hyper-V hosts, VMs and volumes.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet returns Hyper-V hosts, VMs and volumes managed by Veeam Backup & Replication.
You can get the list of all Hyper-V objects in your virtual environment or look for instances directly by
name.
Run Get-VBRServer to get the list of the Hyper-V hosts.
Return Type
CHvHostItem
CHvVmItem
Parameters
Parameter
Server
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Hosts
False
Named
False
False
HostsAnd
Volumes
False
Named
False
False
Name
False
Named
False
True
<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 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-VBRvCloudEntity
Short Description
Looks for vCloud Director entities.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet looks for vCloud Director entities.
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.
Return Type
CVcdSystemItem
CVcdOrganizationItem
CVcdOrganizationVdcItem
CVcdVappItem
CVcdVmItem
CVcdOrgVdcStorageProfile
CVcdDatastoreRestoreInfo
CVcdVcInfo
Parameters
Parameter
Server
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
VApp
False
Named
False
False
Template
False
Named
False
False
VmTemplate
False
Named
False
False
Organization
Vdc
False
Named
False
False
False
Named
False
False
Datastore
False
Named
False
False
Vc
False
Named
False
False
Name
False
Named
False
True
<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 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.
PS C:\PS> 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".
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> Find-VBRvCloudEntity -Server $server -Datastore -Name "Datastore
04"
Find-VBRViDatastore
Short Description
Looks for VMware datastores.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Related Commands
Get-VBRServer
Find-VBRViStoragePolicy
Detailed Description
This cmdlet returns datastores connected to the specified ESX(i) host or that are compatible with a
particular VMware storage policy profile.
With both parameter sets, you can narrow down your search by indicating a datastore name.
Return Type
CViDatastoreItem
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
Named
True
(ByValue,
ByProperty
Name)
False
Storage
Policy
True
Named
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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-VBRViDatastoreCluster
Short Description
Looks for datastore clusters.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides 2 parameter sets.
Related Commands
Get-VBRServer
Return Type
VBRViDatastoreCluster
Detailed Description
This cmdlet returns a list of datastore clusters.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
Server
True
Named
False
Storage
Policy
True
Named
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Find-VBRViEntity
Short Description
Looks for VMware entities.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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>]
-ORFind-VBRViEntity [-Name <String[]>] [-Server <CHost[]>] [-Tags] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns 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.
Run Get-VBRServer to get the list of the VMware hosts.
Return Type
CVcItem
CViFolderItem
CViDatacenterItem
CEsxItem
CViClusterItem
CViResourcePoolItem
CViVmItem
CViVirtualAppItem
CViFolderItem
CViDatacenterItem
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
True
True
False
Named
True
(ByValue,
ByProperty
Name)
False
HostsAnd
Clusters
False
Named
False
False
VMsAnd
Templates
False
Named
False
False
Datastores
AndVMs
False
Named
False
False
HostsAnd
Datastores
False
Named
False
False
False
Named
False
False
Servers
False
Named
False
False
Tags
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 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" | Find-VBRViEntity 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*
Example 3
This command looks for the list of VMs having a VMware tag named "Mac OS" within a particular host.
The host is obtained with Get-VBRServer and assigned to the '$server' variable beforehand.
Find-VBRViEntity -Server $server -Tags -Name "Mac OS"
Find-VBRViFolder
Short Description
Looks for folders on a specified ESX(i) host.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Find-VBRViFolder -Server <CHost> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns folders on a 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.
Return Type
CViFolderItem
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
Named
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 looks for all folders located on the ESXi host named 'Server01'. The server is obtained
with Get-VBRServer, sorted by name and piped down.
Get-VBRServer -Name "Server01" | Find-VBRViFolder
Example 2
This command looks for a folder named 'Weekly_Reports' located on the ESXi host named 'Server01'.
The server is obtained with Get-VBRServer, sorted by name and piped down.
Get-VBRServer -Name "Server01" | Find-VBRViFolder -Name "Weekly_Reports"
Example 3
This command looks for folders named 'Weekly_Reports' and 'Monthly_Reports' located on the ESXi
host named "Server01". The server is obtained with Get-VBRServer and assigned to '$server01'
variable.
PS C:\PS> $server01 = Get-VBRServer -Name "Server01"
PS C:\PS> Find-VBRViFolder -Server $server01 -Name "Weekly_Reports",
"Monthly_Reports"
Find-VBRViResourcePool
Short Description
Looks for resource pools on the specified ESX(i) host.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Find-VBRViResourcePool -Server <CHost> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns 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.
Return Type
CViResourcePoolItem
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
Named
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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-VBRViStoragePolicy
Short Description
Looks for storage policy profiles.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Find-VBRViStoragePolicy -Server <CHost> [-Datastore <CViDatastoreItem>]
[<CommonParameters>]
-ORFind-VBRViStoragePolicy -Server <CHost> [-Datastore <CViDatastoreItem>] [Name <string[]>] [<CommonParameters>]
-ORFind-VBRViStoragePolicy -Server <CHost> [-Datastore <CViDatastoreItem>] [Id <string[]>] [<CommonParameters>]
Related Commands
Get-VBRServer
Find-VBRViDatastore
Return Type
VBRViStoragePolicy[]
Detailed Description
This cmdlet returns VMware storage policy profiles created on a vCenter Server.
You can get the list of all storage policy profiles on the specified server or look for profiles directly by
name or ID.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
Named
False
Datastore
False
Named
False
False
Name
False
Named
False
True
Id
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 returns all storage policy profiles registered for the Veeam.Local host.
The host is obtained with Get-VBRServer and assigned to the '$server' variable.
PS C:\PS> $server = Get-VBRServer -Name "Veeam.Local"
PS C:\PS> Find-VBRViStoragePolicy -Server $server
Example 2
This command returns storage policy profile named "Virtual SAN Default Storage Policy" registered on
the Veeam.Local host.
The host is obtained with Get-VBRServer and piped down.
Get-VBRServer -Name "Veeam.Local" | Find-VBRViStoragePolicy -Name "Virtual
SAN Default Storage Policy"
Example 3
This command returns all storage policy profiles registered for the Veeam.Local host.
The host is obtained with Get-VBRServer and assigned to the '$server' variable.
PS C:\PS> $server = Get-VBRServer -Name "Veeam.Local"
PS C:\PS> $datastore = Find-VBRViDatastore -Name "VeeamDatastore"
PS C:\PS> Find-VBRViStoragePolicy -Server $server -Datastore $datastore Name "Virtual SAN Default Storage Policy"
Find-VSBHvVirtualLab
Short Description
Looks for virtual labs created on the specified Hyper-V host.
Applies to
Platform: Hyper-V
For VMware, run Find-VSBVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Find-VSBVirtualLab [-Server] <CHost> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns virtual labs created on the specified Hyper-V host, both registered in Veeam
Backup & Replication and not.
You can get the list of all virtual labs on the specified Hyper-V host or look for instances directly by
name.
Run Connect-VSBHvVirtualLab to add the unregistered virtual labs to Veeam Backup & Replication.
Return Type
CHvSbVirtualLab
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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.
PS C:\PS> 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.
PS C:\PS> Find-VSBHvVirtualLab -Server $server -Name Hv*
Find-VSBVirtualLab
Short Description
Looks for virtual labs created on the specified ESX(i) host.
Applies to
Platform: VMware
For Hyper-V, run Find-VSBHvVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Find-VSBVirtualLab [-Server] <CHost> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns virtual labs created on the specified ESX(i) host, both registered in Veeam Backup
& Replication and not.
You can get the list of all VMware virtual labs on the specified ESX(i) host or look for instances directly
by name.
Run Connect-VSBVirtualLab to add the unregistered virtual labs to Veeam Backup & Replication.
Return Type
CVirtualLabDescriptor
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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.
PS C:\PS> 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.
PS C:\PS> Get-VBRServer -Name "ESXiHost" | Find-VSBVirtualLab -Name
"MailServer_VLab"
Get-HP3Snapshot
Short Description
Returns HPE 3PAR StoreServ storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
Syntax
Get-HP3Snapshot [-Name <string[]>][<CommonParameters>]
-ORGet-HP3Snapshot [-Name <string[]>] [-Volume
<CSanVolume[]>][<CommonParameters>]
Related Commands
Get-HP3Volume
Detailed Description
This cmdlet returns HPE 3PAR StoreServ storage snapshots.
You can get the list of all storage snapshots, or look for a specific snapshot name or volume.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
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 looks for the list of all snapshots.
PS C:\PS> 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.
PS C:\PS> Get-HP3Volume | Select -First 3 | Get-HP3Snapshot
Get-HP3Storage
Short Description
Returns HPE 3PAR StoreServ storages.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
Syntax
Get-HP3Storage [-Name <string[]>][<CommonParameters>]
Detailed Description
This cmdlet returns HPE 3PAR StoreServ storages.
You can get the list of all HPE 3PAR StoreServ storages or narrow down the output by the storage
name.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for the list of all HPE 3PAR StoreServ storages.
PS C:\PS> Get-HP3Storage
Example 2
This command looks for the list of storages with names starting with "HPE Store".
PS C:\PS> Get-HP3Storage -Name "HPE Store*"
True
Get-HP3Volume
Short Description
Returns HPE 3PAR StoreServ storage volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
Syntax
Get-HP3Volume -Storage <CHp3PARHost[]> [-Name
<string[]>][<CommonParameters>]
Related Commands
Get-HP3Storage
Detailed Description
This cmdlet returns HPE 3PAR StoreServ storage volumes.
You can get the list of all HPE 3PAR StoreServ storage 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.
Parameters
Parameter
Storage
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
True
<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 looks for the volume named "HPE Store" in the storage named "HPE Store 01". The
storage object is obtained with Get-HP3Storage and piped down.
PS C:\PS> Get-HP3Storage -Name "HPE Store 01" | Get-HP3Volume -Name "HPE
Store"
Example 2
This command looks for the volume named "HPE Store" in the storage represented by the $"HPE
storage" variable. The storage object is obtained with Get-HP3Storage and assigned to the variable
beforehand.
PS C:\PS> Get-HP3Volume -Storage $"HPE storage" -Name "HPE Store"
Get-HP4Cluster
Short Description
Returns HPE StoreVirtual storage clusters.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
Syntax
Get-HP4Cluster -Storage <CHpP4Group[]> [-Name
<string[]>][<CommonParameters>]
Related Commands
Get-HP4Storage
Detailed Description
This cmdlet returns HPE StoreVirtual storage clusters.
You can get the list of all storage clusters in your storage system, or narrow down the output by the
cluster name or a specific storage.
Alias
Get-VBRHPCluster
Parameters
Parameter
Storage
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
True
<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 looks for the list of clusters in the storage named "HPE Store 01". The storage object is
obtained with Get-HP4Storage and piped down.
PS C:\PS> Get-HP4Storage -Name "HPE Store 01" | Get-HP4Cluster
Example 2
This command looks for the list of clusters in the storage named "HPE Store 01". The storage object is
obtained with Get-HP4Storage and assigned to the variable beforehand.
PS C:\PS> Get-HP4Cluster -Storage $"HPE Store 01"
Get-HP4Snapshot
Short Description
Returns HPE StoreVirtual storage snapshots.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
Syntax
Get-HP4Snapshot [-Name <string[]>][<CommonParameters>]
-ORGet-HP4Snapshot [-Name <string[]>] [-Volume
<CSanVolume[]>][<CommonParameters>]
Related Commands
Get-HP4Volume
Detailed Description
This cmdlet returns HPE StoreVirtual storage snapshots.
You can get the list of all storage snapshots, or look for a specific snapshot name or volume.
Alias
Get-VBRHPSnapshot
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
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 looks for snapshots of the volume named "HPE Vol01". The volume is obtained with
Get-HP4Volume and piped down.
PS C:\PS> Get-HP4Volume -Name "HPE 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.
PS C:\PS> Get-HP4Snapshot -Volume $vol
Get-HP4Storage
Short Description
Returns HPE StoreVirtual storages.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
Syntax
Get-HP4Storage [-Name <string[]>] [<CommonParameters>]
Detailed Description
This cmdlet returns HPE StoreVirtual storages.
You can get the list of all storages, or narrow down the output by the storage name.
Alias
Get-VBRHPStorage
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for the list of all storages.
PS C:\PS> Get-HP4Storage
Example 2
This command looks for the list of storages with names starting with "HPE Store".
PS C:\PS> Get-HP4Storage -Name "HPE Store*"
True
Get-HP4Volume
Short Description
Returns HPE StoreVirtual storage volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
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
Detailed Description
This cmdlet returns HPE StoreVirtual storage volumes.
You can get the list of all storage 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.
Alias
Get-VBRHPVolume
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
False
Named
False
False
False
Named
False
False
Storage
<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 looks for the list of volumes with names starting with "HPE Store" within the cluster
named "Cluster 1". The cluster object is obtained with Get-HP4Cluster and piped down.
PS C:\PS> Get-HP4Cluster -Name "Cluster 1" |
Store*"
Example 2
This command looks for all volumes in the storage named "HPE Store 01". The storage object is
obtained with Get-HP4Storage and piped down.
PS C:\PS> Get-HP4Storage -Name "HPE Store 01" | Get-HP4Volume
Example 3
This command looks for volume named "HPE Vol01" in the storage represented by the $storage
variable. The storage object is obtained with Get-HP4Storage and assigned to the variable
beforehand.
PS C:\PS> Get-HP4Volume -Storage $storage -Name "HPE Vol01"
Get-NetAppHost
Short Description
Returns storages.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-NetAppHost [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
None
Detailed Description
This cmdlet returns storages.
You can get the list of all storages added to your virtual infrastructure or narrow down the output by
storage name.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for all available storages.
PS C:\PS> Get-NetAppHost
Example 2
This command looks for the "NetApp Store" storage.
PS C:\PS> Get-NetAppHost -Name "NetApp Store"
False
Get-NetAppSnapshot
Short Description
Returns storage snapshots.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-NetAppSnapshot [-Name <String[]>] [-Volume <CSanVolume[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-NetAppVolume
Detailed Description
This cmdlet returns storage snapshots.
You can get the list of all storage snapshots, or look for a specific snapshot name or volume.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
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 looks for the list of all snapshots.
PS C:\PS> Get-NetAppSnapshot
Example 2
This command looks for snapshots of a specific volume.
1.
Run Get-NetAppVolume to get all NetApp volumes. Select the last volume in the list. Save the
result to the $vol variable.
2.
Get-NetAppVolume
Short Description
Returns storage volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-NetAppVolume [-Name <String[]>] [-Host <CNaHost[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-NetAppHost
Detailed Description
This cmdlet returns storage volumes.
You can get the list of all storage volumes of your virtual infrastructure or narrow down the output by
volume name, or specify a cluster or a storage within which you want to look for the volumes.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
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
This command looks for the volume named "NetApp Volume 01" in storage "NetApp Store".
1.
Run Get-NetAppHost to get the storage where to volume is located. Save the result to the
$netappstore variable.
2.
Get-VBRApplicationRestorePoint
Short Description
Returns restore points created with the VSS-aware image processing enabled.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides four parameter sets.
For looking for all restore points with VSS-aware image processing enabled:
Get-VBRApplicationRestorePoint [<CommonParameters>]
Related Commands
None
Return Type
VBRApplicationRestorePoint
Detailed Description
This cmdlet returns restore points of backups that were created with the VSS-aware image processing
enabled.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Name
False
Named
False
False
Exchange
False
Named
False
False
False
Named
False
False
SharePoint
False
Named
False
False
SQL
False
Named
False
False
Oracle
False
Named
False
False
Id
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 returns all restore points of backups containing Microsoft SQL VMs.
PS C:\PS> Get-VBRApplicationRestorePoint -SQL
Example 2
This command returns a specific restore points of a Microsoft SQL VM named "crm_db".
Get the restore points of the VM and save it to the $crmdb variable.
Select the third restore and save it to the $restorepoint variable.
PS C:\PS> $crmdb = Get-VBRApplicationRestorePoint -SQL -Name "crm_db"
PS C:\PS> $restorepoint = $crmdb[2]
Example 3
This command returns the most recent restore point of a Microsoft SQL VM named "crm_db" and
saves it to the $crmdb variable.
PS C:\PS> $crmdb = Get-VBRApplicationRestorePoint -SQL -Name "CRM-db" |
Sort -Descending | Select -First 1
Example 4
This command looks for a specific restore point by the ID.
PS C:\PS> Get-VBRApplicationRestorePoint -Id 4d39c279-f15c-4fd3-9b325f4e65f221b2
Get-VBRBackup
Short Description
Returns backups.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRBackup [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns backups stored in the Veeam Backup & Replication database.
The cmdlet returns backups that were created by backup jobs, backup copy jobs, vCD jobs and
Endpoint backup jobs.
You can get the list of all backups registered in the database or look for backups created by certain
jobs by job names.
Note:
The Veeam backup contains all restore points for all VMs that are processed by the job.
Return Type
CBackup
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
False
Example 1
This command looks for all backups stored in the database.
PS C:\PS> Get-VBRBackup
Example 2
This command looks for the backups named "vCloud Webservices Backup" and "Exchange
Backup_imported".
PS C:\PS> Get-VBRBackup -Name "vCloud Webservices Backup", "Exchange
Backup_imported"
Get-VBRBackupRepository
Short Description
Returns backup repositories.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRBackupRepository [-Name <string[]>] [-ScaleOut]
[<CommonParameters>]
Detailed Description
This cmdlet returns backup repositories managed by Veeam Backup & Replication.
You can get the list of all backup repositories, get scale-out backup repositories or look for instances
directly by name.
Return Type
CBackupRepository
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
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 looks for all standalone backup repositories managed by Veeam Backup & Replication.
Get-VBRBackupRepository
Example 2
This command looks for all scale-out backup repositories managed by Veeam Backup & Replication.
Get-VBRBackupRepository -ScaleOut
Example 3
This command looks for the standalone backup repository named "Backups Vol2" and for standalone
backup repositories with names starting with "Local".
Get-VBRBackupRepository -Name "Backups Vol2", "Local*"
Example 4
This command looks for scale-out backup repository named 'Veeam Performance Scale-Out
Repository'.
Get-VBRBackupRepository -ScaleOut -Name "Veeam Performance Scale-Out
Repository"
Get-VBRBackupSession
Short Description
Returns backup sessions that have been run.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRBackupSession [-Name <String[]>] [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns 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.
Return Type
CBackupSession
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
True
Example 1
This command looks for the list of all backup sessions.
PS C:\PS> Get-VBRBackupSession
Example 2
This command looks for all backup copy sessions.
PS C:\PS> Get-VBRBackupSession -Name *Backup Copy*
Get-VBRCloudDatastore
Short Description
Returns datastores or disk volumes available by your cloud resources.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides three parameter sets.
[<CommonParameters>]
Related Commands
Get-VBRCloudServer
Return Type
VBRCloudDatastore
Detailed Description
This cmdlet returns datastores (for VMware) or volumes (for Hyper-V) in your cloud resources.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
False
Named
False
Id
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.
Get-VBRCloudGateway
Short Description
Returns cloud gateways.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Get-VBRCloudGateway [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [<CommonParameters>]
-ORGet-VBRCloudGateway [-Id <Guid[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRCloudGateway [-Name <String[]>] [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
None
Return Type
VBRCloudGateway[]
Detailed Description
This cmdlet returns existing cloud gateways.
You can get the list of all existing cloud gateways or search for instances directly by name or ID. This
cmdlet provides syntax for three scenarios accordingly.
Parameters
Parameter
Id
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
Named
True
<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 returns all cloud gateways configured in Veeam Backup & Replication.
PS C:\PS> Get-VBRCloudGateway
Example 2
This command gets the cloud gateway with the 172.16.12.45 IP address.
PS C:\PS> Get-VBRCloudGateway -Name "172.16.12.45"
Get-VBRCloudGatewayCertificate
Short Description
Returns SSL certificate.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRCloudGatewayCertificate [-FromStore]
[<CommonParameters>]
Related Commands
None
Return Type
VBRCloudCertificate
Detailed Description
This cmdlet returns the service provider SSL certificate.
You can get the SSL certificate that is currently used, or get the SSL certificate saved to your Certificate
Store.
Parameters
Parameter
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
False
Get-VBRCloudHardwarePlan
Short Description
Returns existing hardware plans.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
This cmdlet provides three parameter sets.
Get-VBRCloudHardwarePlan [-Name <String[]>] [-Platform <VBRPlatform>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [PipelineVariable <String>] [<CommonParameters>]
Related Commands
None
Return Type
VBRHvCloudHardwarePlan
VBRViCloudHardwarePlan
Detailed Description
This cmdlet returns existing hardware plans.
You can get the list of all hardware plans or search for instances directly by name, virtuallization
platform or ID.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
True
False
Named
True (by
ValueFromPipeline
ByPropertyName)
False
ID
True
Named
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Get-VBRCloudProvider
Short Description
Returns service providers.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Get-VBRCloudProvider
[<CommonParameters>]
[<CommonParameters>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRCloudProvider[]
Detailed Description
This cmdlet returns service providers added to Veeam Backup & Replication.
You can get the list of all existing service providers or search for instances directly by name or ID.
Parameters
Parameter
Id
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
Named
True
<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 looks for all cloud service providers added to Veeam Backup & Replication.
PS C:\PS> Get-VBRCloudProvider
Example 2
This command looks for the cloud service provider with the 104.45.95.227 IP address.
PS C:\PS> Get-VBRCloudProvider -Name "104.45.95.227"
Get-VBRCloudProviderNetworkAppliance
Short Description
Returns network extension appliance configured on the user side.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRCloudProviderNetworkAppliance [-Name <string[]>] [-CloudProvider
<VBRCloudProvider[]>] [<CommonParameters>]
Related Commands
Get-VBRCloudProvider
Return Type
VBRViCloudProviderNetworkAppliance
VBRHvCloudProviderNetworkAppliance
Detailed Description
This cmdlet returns network extension appliance created on the user side. This appliance is used in
replica failover scenarios.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
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.
Get-VBRCloudPublicIP
Short Description
Returns existing public IP addresses.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Get-VBRCloudPublicIP [-Tenant <VBRCloudTenant>] [<CommonParameters>]
Related Commands
Get-VBRCloudTenant
Return Type
VBRCloudIP
Detailed Description
This cmdlet returns public IP addresses that are configured by the service provider. You can get all
configured IP addresses or the IP addresses allocated to a selected user.
Parameters
Parameter
Tenant
Description
Required Position
False
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Get-VBRCloudServer
Short Description
Returns cloud hosts available by your cloud resources.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides three parameter sets.
[<CommonParameters>]
[<CommonParameters>]
Related Commands
Get-VBRCloudProvider
Return Type
VBRCloudServer
Detailed Description
This cmdlet returns cloud hosts that are allocated to you by your cloud resources.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
False
Named
False
Id
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.
Get-VBRCloudServerNetworkInfo
Short Description
Returns networks available in your cloud resources.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides three parameter sets.
Related Commands
Get-VBRCloudServer
Return Type
VBRCloudServerNetworkInfo
Detailed Description
This cmdlet returns networks that are allocated to you by your cloud resources.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
False
Named
False
Id
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.
Get-VBRCloudTenant
Short Description
Returns cloud user accounts.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Get-VBRCloudTenant [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [<CommonParameters>]
-ORGet-VBRCloudTenant [-Id <Guid[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRCloudTenant [-Name <String[]>] [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRCloudTenant [-Repository <CBackupRepository[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Return Type
VBRCloudTenant[]
Detailed Description
This cmdlet returns cloud user accounts.
You can get the list of all existing user accounts, search for instances directly by name or ID or get loud
users accounts using a particular backup repository. Use an appropriate scenario for each case.
Parameters
Parameter
Id
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
Named
False
False
Named
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 looks for all cloud user accounts.
PS C:\PS> Get-VBRCloudTenant
Example 2
This command looks for the ABC company cloud user account by name.
PS C:\PS> Get-VBRCloudTenant -Name "ABC Company"
Example 3
This command looks for the cloud user accounts using the 'Backups Vol2' backup repository.
The backup repository is obtained with Get-VBRBackupRepository and piped down.
PS C:\PS> Get-VBRBackupRepository -Name "Backups Vol2" | Get-VBRCloudTenant
Get-VBRCloudTenantNetworkAppliance
Short Description
Returns network extension appliances.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
This cmdlet provides three parameter sets.
For looking for all existing hardware plans or for hardware plans with specified name(s):
Related Commands
Get-VBRServer
Return Type
VBRCloudTenantNetworkAppliance[]
Detailed Description
This cmdlet returns network extension appliances.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
True
False
Named
False
False
Named
False
False
Server
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Get-VBRCloudVLANConfiguration
Short Description
Returns VLANs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Get-VBRCloudVLANConfiguration
[<CommonParameters>]
Related Commands
None
Return Type
VBRCloudVLANConfiguration
Detailed Description
This cmdlet returns configured VLANs.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Get-VBRCommand
Short Description
Returns Veeam PowerShell SnapIn cmdlets.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides 3 parameter sets.
Get-VBRCommand [<CommonParameters>]
For looking for Veeam cmdlets by verb or noun the cmdlet uses:
Related Commands
None
Detailed Description
This cmdlet returns the list of available Veeam PowerShell cmdlets.
If you run this cmdlet without parameters, it will return the list of all Veeam cmdlets in the current
session.
Note:
This cmdlet is available only in sessions started from Veeam Backup & Replication main menu.
Parameters
Parameter
Description
Required Position
Accepts
Pipeline
Input
Accepts
Wildcard
Characters
Name
False
True
Noun
False
Named
True
(ByPropertyName)
True
name.
Verb
False
Named
True
(ByPropertyName)
<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 returns the list of Veeam cmdlets that perform remove operations.
PS C:\PS> Get-VBRCommand Remove*
Example 2
This command returns Veeam cmdlets with names containing "Zip".
PS C:\PS> Get-VBRCommand -Name *Zip*
Example 3
This command returns Veeam cmdlets with verbs "Get" and "Set".
PS C:\PS> Get-VBRCommand -Verb Get, Set
Example 4
This command returns Veeam cmdlets with nouns containing "Job" and "Zip".
PS C:\PS> Get-VBRCommand -Noun *Job*, *Zip*
True
Get-VBRConfigurationBackupJob
Short Description
Returns the configuration backup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRConfigurationBackupJob [<CommonParameters>]
Related Commands
None
Return Type
VBRConfigurationBackupJob
Detailed Description
This cmdlet returns the configuration backup job.
<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 returns the configuration backup job.
PS C:\PS> Get-VBRConfigurationBackupJob
Get-VBRCredentials
Short Description
Returns credentials records.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRCredentials [-Name <String[]>] [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns credentials managed by Veeam Backup & Replication.
You can get the list of all credentials or look for instances directly by name.
Return Type
CCredentials
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
True
<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 gets the list of credentials records containing "Administrator" in the account name.
PS C:\PS>
Get-VBRDefaultGatewayConfiguration
Short Description
Returns configuration of default gateways.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Get-VBRDefaultGatewayConfiguration
[<CommonParameters>]
Related Commands
Get-VBRCloudProvider
Return Type
VBRDefaultGatewayConfiguration[]
Detailed Description
This cmdlet returns configuration information on service provider default gateways. You can get
information about all gateways of all service providers, or look for a selected service provider. Use an
appropriate parameter set for each case.
Parameters
Parameter
Description
Required Position
False
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Get-VBREncryptionKey
Short Description
Returns encryption keys.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBREncryptionKey [[-Description] <string>]
[<CommonParameters>]
Related Commands
None
Return Type
PSCryptoKey
Detailed Description
This cmdlet returns encryption keys managed by Veeam Backup & Replication.
You can get the list of media pools within specified library, or search for instances directly by
description.
Parameters
Parameter
Description
Required Position
False
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
<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 looks for all encryption keys.
PS C:\PS> Get-VBREncryptionKey
Example 2
This command looks for an encryption key with description 'Veeam Administrator'.
PS C:\PS> Get-VBREncryptionKey -Description "Veeam Administrator"
Get-VBREPJob
Short Description
Returns Endpoint backup jobs.
Syntax
Get-VBREPJob
[<CommonParameters>]
[<CommonParameters>]
[<CommonParameters>]
Related Commands
None
Return Type
VBREPJob[]
Detailed Description
This cmdlet returns Veeam Endpoint backup jobs stored in Veeam Backup & Replication database.
You can get the list of all Endpoint backup jobs or search for instances directly by name or ID. Use an
appropriate parameter set for each case.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
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 gets the list of all Endpoint backup jobs.
PS C:\PS> Get-VBREPJob
Example 2
This command gets an Endpoint backup job named 'Backup Job Mediaserver'.
PS C:\PS> Get-VBREPJob -Name 'Backup Job Mediaserver'
Get-VBREPPermission
Short Description
Returns user access permissions for backup repositories used by Endpoint backup jobs.
Syntax
Get-VBREPPermission -Repository <CBackupRepository>
[<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Return Type
VBREPPermission
Detailed Description
This cmdlet returns user access permissions for a backup repository that is used as a target by
Endpoint backup jobs.
Parameters
Parameter
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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 looks for permissions set to a backup repository named 'WinLocal'. The repository is
obtained with Get-VBRBackupRepository and assigned to the '$repository' variable beforehand.
PS C:\PS> $repository = Get-VBRBackupRepository -Name 'WinLocal'
PS C:\PS> Get-VBREPPermission -Repository $repository
RepositoryId
PermissionType
Users
IsEncryptionEnabled
EncryptionKey
:
:
:
:
:
88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
Everyone
{}
False
Example 2
This command looks for the 'WinLocal' repository permissions. The repository is obtained with GetVBRBackupRepository and piped down.
Get-VBRBackupRepository -Name 'WinLocal' | Get-VBREPPermission
RepositoryId
PermissionType
Users
IsEncryptionEnabled
EncryptionKey
:
:
:
:
:
88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
Everyone
{}
False
Get-VBREPSession
Short Description
Returns Endpoint backup jobs session.
Syntax
Get-VBREPSession
[<CommonParameters>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRSession[]
Detailed Description
This cmdlet returns Veeam Endpoint backup job sessions that have been run.
You can get the list of all Endpoint backup job sessions or search for instances directly by name. Use
an appropriate parameter set for each case.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
True
Example 1
This command gets the list of all Endpoint backup jobs sessions.
PS C:\PS> Get-VBREPSession
Example 2
This command gets the list of sessions of an Endpoint backup job named 'Backup Job Mediaserver'.
PS C:\PS> Get-VBREPSession -Name 'Backup Job Mediaserver'
Get-VBRFailoverPlan
Short Description
Returns existing failover plans or cloud failover plans.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VBRFailoverPlan [-Name <string[]>]
[<CommonParameters>]
[<CommonParameters>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRFailoverPlan[]
Detailed Description
This cmdlet returns existing failover plans or cloud failover plans.
You can get the list of all failover plans or search for instances directly by name or ID.
Parameters
Parameter
Name
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
True
True
Named
False
Type
True
Named
False
False
False
Named
True (by
ValueFromPipeline
ByPropertyName)
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 looks for the list of all existing failover plans.
PS C:\PS> Get-VBRFailoverPlan
Example 2
This command looks for failover plan named 'MailServers Failover'.
PS C:\PS> Get-VBRFailoverPlan -Name "MS Exchange Group Failover"
Example 3
This command looks for a failover plan with a particular ID by piping down the variable containing the
ID.
1.
The ID is obtained by getting the ID property of the failover plan object and assigned to the
'$MSExchangeGroupID' variable.
You can view the GUID number of the failover plan object:
PS C:\PS>
$MSExchangeGroupID
Guid
------3247cbb5-b65f-4f93-93aa-e13bdb3001c9
Get-VBRFilesInRestorePoint
Short Description
Returns files in a selected restore point.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRFilesInRestorePoint [-RestorePoint] <COib> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
This cmdlet returns files in a selected restore point.
With this cmdlet, you can get files in restore points created by all types of jobs: backup jobs, backup
copy jobs, replication jobs, vCD jobs and Endpoint backup jobs (for Endpoint backups, only volume
level backups).
You can get the list of all files in a selected restore point or look for instances directly by name.
Return Type
COIBFileInfo
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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.
PS C:\PS> 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.
PS C:\PS> Get-VBRFilesInRestorePoint -RestorePoint $restorepoint
Get-VBRHvProxy
Short Description
Returns Hyper-V backup proxies.
Applies to
Platform: Hyper-V
For VMware, run Get-VBRViProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRHvProxy [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns 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.
Run Get-VBRJobProxy to get the list of proxies assigned to a specific job.
Return Type
CHvProxy
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
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-VBRHvReplicaReIpRule
Short Description
Returns Hyper-V job re-IP rules.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRHvReplicaReIpRule -Job <CBackupJob>
[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet returns the list of re-IP rules configured for a selected Hyper-V replication job.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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 looks for the re-IP rules set for the 'Backup Copy Job 1' job. The job is obtained with
Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "Backup Copy Job 1" | Get-VBRHvReplicaReIpRule
Example 2
This command looks for the re-IP rules set for the job represented by the '$job' variable. The job is
obtained with Get-VBRJob and assigned to the variable beforehand.
PS C:\PS> Get-VBRHvReplicaReIpRule -Job $job
Get-VBRHvServerNetworkInfo
Short Description
Returns virtual networks for a Hyper-V host.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRHvServerNetworkInfo -Server <CHost> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns the list of all virtual networks to which a selected Hyper-V host is connected.
Parameters
Parameter
Server
Description
Specifies the Hyper-V host for
which you want to get the list of
networks.
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
<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 looks for the list of networks of the host represented by the '$server' variable. The host
is obtained with Get-VBRServer and assigned to the variable beforehand.
PS C:\PS> $server = Get-VBRServer -Type HvServer -Name "srv01.veeam.local"
PS C:\PS> Get-VBRHvServerNetworkInfo -Server $server
Example 2
This command looks for the list of networks to which the "srv01.Veeam.Local" host is connected. The
host is obtained with Get-VBRServer and piped down.
PS C:\PS> Get-VBRServer
VBRHvServerNetworkInfo
Get-VBRInstantRecovery
Short Description
Returns running Instant VM Recovery session.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRInstantRecovery [-Full] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns Instant VM Recovery session running at the moment.
You can get the information about the instant recovery sessions in short or detailed view.
Return Type
InstantRecoveryDetails
Parameters
Parameter
Full
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 gets the list of the instant recovery sessions in short view.
PS C:\PS> Get-VBRInstantRecovery
Example 2
This command gets the list of the instant recovery sessions in detailed view.
PS C:\PS> Get-VBRInstantRecovery -Full
False
Get-VBRJob
Short Description
Returns existing jobs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRJob [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns jobs stored in Veeam Backup & Replication database.
With this cmdlet, you can get the following jobs:
Backup Jobs
Replication Jobs
VM 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 tape jobs.
Run Get-VSBJob to get SureBackup jobs.
Run Get-VBREPJob to get Endpoint backup jobs.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
True
Example
This command gets the list of backup copy jobs.
PS C:\PS> Get-VBRJob -Name *Backup Copy Job*
Get-VBRJobObject
Short Description
Returns objects in a specified job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRJobObject [-Job] <CBackupJob> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet returns objects in a 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Job
True
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 looks for the SharePoint VMs in the job named "VM Copy Job 01". The job is obtained
with Get-VBRJob and piped down.
PS C:\PS> 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 beforehand.
PS C:\PS> Get-VBRJobObject -Job $job -Name "SharePoint"
Get-VBRJobObjectVssOptions
Short Description
Returns VSS settings of a specific VM in job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRJobObjectVssOptions [-ObjectInJob] <CObjectInJob> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJobObject
Detailed Description
This cmdlet returns VSS settings set for a specific VM 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.
Run Get-VBRJobVSSOptions to get the list of VSS options of a specific job.
Parameters
Parameter
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Get-VBRJobObjectVssOptions -ObjectInJob $vm
Get-VBRJobOptions
Short Description
Returns job settings for a selected job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRJobOptions [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet returns job settings for a selected job.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 looks for the list of options of the job named "Fileserver Replica". The job is obtained
with Get-VBRJob and piped down.
PS C:\PS> 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_job'
variable. The job is obtained with Get-VBRJobObject and assigned to the variable beforehand.
PS C:\PS> Get-VBRJobOptions -Job $fileserver_replica_job
Get-VBRJobProxy
Short Description
Returns proxy servers assigned to a selected job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRJobProxy -Job <CBackupJob[]> [-Target] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet returns source or target proxy servers assigned to a selected job. You will see the
notification if the automatic proxy selection is enabled.
Run Get-VBRViProxy or Get-VBRHvProxy to get a list of all VMware or Hyper-V proxies managed by
Veeam Backup & Replication.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Accept
Pipeline
Input
<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 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 scheduling settings for a selected job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRJobScheduleOptions [-Job] <CBackupJob[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet returns job scheduling options for a selected job.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 looks for the list of schedulling options of the job named "ActiveDirectory Copy Job".
The job is obtained with Get-VBRJob and piped down.
PS C:\PS> 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.
PS C:\PS> Get-VBRJobScheduleOptions -Job $activedirectory_copy_job
Get-VBRJobVSSOptions
Short Description
Returns VSS settings for a selected job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRJobVSSOptions [-Job] <CBackupJob[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet returns VSS settings for a selected job.
Run Get-VBRJobObjectVssOptions to get the list of VSS options set for specific objects in a job.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 looks for the list of VSS options of the job named "ActiveDirectory Backup". The job is
obtained with Get-VBRJob and piped down.
PS C:\PS> 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.
PS C:\PS> Get-VBRJobVSSOptions -Job $ad_backup
Get-VBRLocalhost
Short Description
Returns the local server on which Veeam Backup & Replication is installed.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRLocalhost [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [<CommonParameters>]
Detailed Description
This cmdlet returns the local server on which Veeam Backup & Replication is installed.
<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 VM replicas or cloud VM replicas.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRReplica [-Name <string[]>] [-Type <VBRReplicaType> {Local | Cloud |
Tenant}] [<CommonParameters>]
Detailed Description
This cmdlet returns VM replicas or cloud VM replicas managed by Veeam Backup & Replication.
You can look for all VM replicas or for replicas created by a particular replication job.
With this cmdlet, you call get the replicas that are managed by your backup console. In case you have
removed some replicas from the Veeam Backup console, but they remain on disk, you will not be able
to get them.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
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 looks for all replicas managed by Veeam Backup & Replication.
PS C:\PS> Get-VBRReplica
Example 2
This command looks for the replicas created with the "DC Replica" replication job.
PS C:\PS> Get-VBRReplica -Name "DC Replica"
Get-VBRRepositoryExtent
Short Description
Returns scale-out backup repository extents.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRRepositoryExtent -Repository <VBRScaleOutBackupRepository>
[<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Return Type
VBRRepositoryExtent[]
Detailed Description
This cmdlet returns extents of scale-out backup repositories.
Parameters
Parameter
Description
Required Position
True
Accepts
VBRScaleOutBackupRepository
object, GUID or string (repository
name).
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
<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 returns extents of the "Veeam Performance Scale-Out Repository". The scale-out
repository is specified by name.
PS C:\PS> Get-VBRRepositoryExtent -Repository "Veeam Performance Scale-Out
Repository"
Example 2
This command returns extents of the "Veeam Performance Scale-Out Repository".
The scale-out repository is obtained with Get-VBRBackupRepository and piped down.
PS C:\PS> Get-VBRBackupRepository -Name "Veeam Performance Scale-Out
Repository" | Get-VBRRepositoryExtent
Example 3
This command returns extents of the "Veeam Performance Scale-Out Repository".
The scale-out repository is obtained with Get-VBRBackupRepository and assigned to the
'$scaleoutrepository' variable.
PS C:\PS> $scaleoutrepository = Get-VBRBackupRepository -Name "Veeam
Performance Scale-Out Repository"
PS C:\PS> Get-VBRRepositoryExtent -Repository $scaleoutrepository
Get-VBRRestorePoint
Short Description
Returns restore points.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRRestorePoint [[-Backup] <CBackup[]>] [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRBackup
Detailed Description
This cmdlet returns restore points stored in Veeam Backup & Replication database.
With this cmdlet, you can get restore points created by all types of jobs: backup jobs, backup copy
jobs, replication jobs, vCD jobs and Endpoint backup jobs.
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.
Parameters
Parameter
Backup
Description
Required Position
Accept
Wildcard
Characters
False
True
(ByValue,
ByProperty
Name)
False
False
Named
False
True
Accept
Pipeline
Input
<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 looks for all restore points of all VMs registered in the database.
PS C:\PS> Get-VBRRestorePoint
Example 2
This command looks for all restore points of a VM named "MSExchange02" in the backup named
"MSExchange Backup". The backup is obtained with Get-VBRBackup and piped down.
PS C:\PS> Get-VBRBackup -Name "MSExchange Backup" | Get-VBRRestorePoint Name *MSExchange02*
Example 3
This command looks for the latest restore point of a 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.
PS C:\PS> Get-VBRBackup -Name "MSExchange Backup" | Get-VBRRestorePoint Name *MSExchange02* | Sort-Object $_.creationtime -Descending | Select First 1
Example 4
This command looks for all 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.
PS C:\PS> Get-VBRRestorePoint -Backup $backup
Get-VBRRestoreSession
Short Description
Returns restore sessions.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRRestoreSession [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns 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).
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for all restore sessions stored in the database.
PS C:\PS> Get-VBRRestoreSession
Example 2
This command looks for the restore sessions of the VMs named "Hv_DNS" and "Hv_DC".
PS C:\PS> Get-VBRRestoreSession -Name "Hv_DNS", "Hv_DC"
True
Get-VBRServer
Short Description
Returns hosts connected to Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRServer [-Type <CDBHost+EType>] [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns 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.
Parameters
Parameter
Type
Description
Name
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
True
<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 looks for the server 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-VBRServerSession
Short Description
Returns current session with Veeam backup server.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRServerSession
[<CommonParameters>]
Related Commands
None
Detailed Description
This cmdlet returns local or remote session with Veeam backup server.
<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 returns the current session.
PS C:\PS> Get-VBRServerSession
User
---Administrator
Server
-----192.17.53.36
Port
---9392
Get-VBRSession
Short Description
Returns tape jobs sessions.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRSession -Job <VBRJob> [-Last] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRSession -Session <VBRSession> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRSession -Job <VBRJob> [-State <VBRSessionState>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRSession -Job <VBRJob> [-Result <VBRSessionResult>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Return Type
VBRBackupSession
Detailed Description
This cmdlet returns sessions for a selected tape job.
You can get all tape job sessions that have been run, update the job session state or filter the sessions
by session state or result. Use an appropriate scenario for each case.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Job
True
Named
True (by
ValueFromPipeline
ByPropertyName)
False
Last
False
Named
False
False
Session
True
Named
False
FromPipeline,
ValueFromPipeline
ByPropertyName)
State
False
Named
False
False
Result
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.
Get-VBRSQLDatabase
Short Description
Returns Microsoft SQL Server databases in restore point.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRSQLDatabase -ApplicationRestorePoint <VBRApplicationRestorePoint> [Name <string[]>] [<CommonParameters>]
Related Commands
Get-VBRApplicationRestorePoint
Return Type
VBRSQLDatabase
Detailed Description
This cmdlet returns Microsoft SQL Server databases in a selected restore point.
Parameters
Parameter
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
False
Named
False
True
Accepts
VBRApplicationRestorePoint.
Name
Accept
Pipeline
Input
<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 example shows how to get the last restore point of the "Locations" database on the "crm_db" VM.
PS C:\PS> $crmdb = Get-VBRApplicationRestorePoint -SQL -Name "crm_db"
PS C:\PS> $locations = Get-VBRSQLDatabase -ApplicationRestorePoint
$crmdb[0] -Name "Locations"
Get-VBRSQLDatabaseRestoreInterval
Short Description
Shows interval of backups available for a selected database.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRSQLDatabaseRestoreInterval -Database <VBRSQLDatabase>
[<CommonParameters>]
Related Commands
Get-VBRSQLDatabase
Return Type
VBRDatabaseRestoreInterval
Detailed Description
This cmdlet shows date and time of the first and the last available restore point for a selected
database. This is reference information that helps you to select an available restore point.
Parameters
Parameter
Database
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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 gets the restore interval for the "crm_db" VM.
PS C:\PS> $restorepoint = Get-VBRApplicationRestorePoint -SQL -Name
"crm_db"
PS C:\PS> Get-VBRSQLDatabase -ApplicationRestorePoint $restorepoint[2] |
Get-VBRSQLDatabaseRestoreInterval
Example 2
This command gets the restore interval for the "Locations" database on the "crm_db" VM.
PS C:\PS> $restorepoint = Get-VBRApplicationRestorePoint -SQL -Name
"crm_db"
PS C:\PS> $locations = Get-VBRSQLDatabase -ApplicationRestorePoint
$restorepoint[2] -Name "Locations"
PS C:\PS> Get-VBRSQLDatabaseRestoreInterval -Database $locations
From
---02/11/2014 12:33:39 PM
To
-10/28/2015 12:33:39 PM
Get-VBRTapeDrive
Short Description
Returns tape drives.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRTapeDrive
[<CommonParameters>]
[<CommonParameters>]
[<CommonParameters>]
[<CommonParameters>]
[<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Return Type
VBRTapeDrive[]
Detailed Description
This cmdlet returns tape recording drives. You can also view the model name, the state of the drive
and whether it is enabled or disabled.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Library
False
Named
False
Name
False
Named
True
False
Named
False
FromPipeline,
ValueFromPipeline
ByPropertyName)
False
Named
<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 looks for a tape drives in the library named 'HP MSL G3 Series 3.00'. Run GetVBRTapeLibrary to get the library and pipe it down.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | GetVBRTapeDrive
Example 2
This command looks for a tape drive named "Drive1".
PS C:\PS> Get-VBRTapeDrive -Name "Drive1"
False
Get-VBRTapeJob
Short Description
Returns tape jobs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRTapeJob [-Name <string[]>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRBackupToTapeJob
VBRFileToTapeJob
Detailed Description
This cmdlet returns tape jobs created on this Veeam backup server.
You can get backup to tape jobs and file to tape jobs.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
<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 returns the tape job named "Daily WebApp Backup".
PS C:\PS> Get-VBRTapeJob -Name "Daily WebApp Backup"
Get-VBRTapeLibrary
Short Description
Returns tape libraries.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRTapeLibrary [-TapeServer <VBRTapeServer[]>] [<CommonParameters>]
-ORGet-VBRTapeLibrary [-TapeServer <VBRTapeServer[]>] [-Id <guid[]>]
[<CommonParameters>]
-ORGet-VBRTapeLibrary [-TapeServer <VBRTapeServer[]>] [-Name <string[]>]
[<CommonParameters>]
Related Commands
Get-VBRTapeServer
Return Type
VBRTapeLibrary[]
Detailed Description
This cmdlet returns tape libraries connected to Veeam Backup & Replication.
You can get the list of all tape libraries, narrow down your search to particular tape servers or search
for instances directly by name or ID.
Note that tape libraries are added to Veeam Backup & Replication automatically when you add tape
server with connected library. Run Add-VBRTapeServer to add tape server.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
Named
False
True
separated by commas.
Id
False
Named
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 gets a list of all tape libraries connected to Veeam Backup & Replication.
PS C:\PS> Get-VBRTapeLibrary
Example 2
This command looks for all tape libraries connected to the tape server named 'Sydney_Tape_Server'.
The tape server is obtained with Get-VBRTapeServer and piped down.
PS C:\PS> Get-VBRTapeServer -Name "Sydney_Tape_Server" | Get-VBRTapeLibrary
Get-VBRTapeMediaPool
Short Description
Returns media pools.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRTapeMediaPool [-Library <VBRTapeLibrary[]>] [<CommonParameters>]
-ORGet-VBRTapeLibrary [-Library <VBRTapeLibrary[]>] [-Id <guid[]>]
[<CommonParameters>]
-ORGet-VBRTapeLibrary [-Library <VBRTapeLibrary[]>] [-Name <string[]>]
[<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Return Type
VBRTapeMediaPool[]
Detailed Description
This cmdlet returns media pools managed by Veeam Backup & Replication.
The cmdlet returns simple, GFS and service media pools. You can get the list of media pools that use a
specific library, or search for instances directly by name or ID.
Parameters
Parameter
Library
Description
Required Position
Accept
Wildcard
Characters
False
Named
False
False
Named
False
False
Accept
Pipeline
Input
Name
False
Named
False
True
<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 looks for the list of all media pools in Veeam Backup & Replication.
PS C:\PS> Get-VBRTapeMediaPool
Example 2
This command looks for the media pools named "File Backup Media Pool" and "AppData GFS Media
Pool".
PS C:\PS> Get-VBRTapeMediaPool -Name "File Backup Media Pool","AppData GFS
Media Pool"
Example 3
This command looks for all media pools in the 'HP MSL G3 Series 3.00' library.
The library is obtained with Get-VBRTapeLibrary and piped down.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | GetVBRTapeMediaPool
Example 4
This command looks for the media pools named 'AD Full Backup' and 'SharePoint Full Backups' in the
'HP MSL G3 Series 3.00' library.
The library is obtained with Get-VBRTapeLibrary and piped down.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | GetVBRTapeMediaPool -Name "AD Full Backup", "SharePoint Full Backups"
Get-VBRTapeMedium
Short Description
Returns tapes.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRTapeMedium [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRTapeMedium -Drive <VBRTapeDrive[]> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
-ORGet-VBRTapeMedium -Id <Guid[]> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
-ORGet-VBRTapeMedium [-Name <String[]>] -Library <VBRTapeLibrary[]> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
-ORGet-VBRTapeMedium [-Name <String[]>] -MediaPool <VBRTapeMediaPool[]> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
-ORGet-VBRTapeMedium [-Name <String[]>] -Vault <VBRTapeVault[]> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRBackup
Get-VBRTapeMediaPool
Get-VBRTapeLibrary
Detailed Description
This cmdlet returns tapes managed by Veeam Backup & Replication.
You can get the list of all tapes, or search for instances directly by name or ID, or get the list of tapes in
a particular library, media pool, vault or drive. Use an appropriate scenario for each case.
Parameters
Parameter
Name
Description
Required Position
Accept
Wildcard
Characters
False
Named
True
True
Named
False
False
True
Named
False
False
True
Named
False
False
True
Named
False
False
True
Named
False
False
Accept
Pipeline
Input
Library
<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
The following command gets a tape named "00110001".
PS C:\PS> Get-VBRTapeMedium -Name "00110001"
Example 2
The following command gets a tape with the barcode "00233400".
PS C:\PS> 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 assigned to the '$IncrementalBackups'
variable beforehand.
PS C:\PS> Get-VBRTapeMedium -MediaPool $IncrementalBackups
Example 4
This command looks for the expired tapes within the Sydney vault. The vault is obtained with GetVBRTapeVault and assigned to the '$Sydney' variable beforehand.
PS C:\PS> Get-VBRTapeMedium -Vault $Sydney | ?{$_.IsExpired}
Get-VBRTapeServer
Short Description
Returns tape servers.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRTapeServer [-Server <CHost[]>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRTapeServer[]
Detailed Description
This cmdlet returns tape servers connected to Veeam Backup & Replication.
You can get the list of all tape servers or narrow down the output to the servers of specific type, or
search for instances directly by name.
Parameters
Parameter
Server
Description
Required Position
Accept
Wildcard
Characters
False
Named
False
False
Named
False
True
Accept
Pipeline
Input
<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 looks for all tape servers connected to Veeam Backup & Replication.
PS C:\PS> Get-VBRTapeServer
Example 2
This command looks for all tape servers connected to the host named 'Host01'. The 'Host01' server is
obtained with Get-VBRServer and piped down.
PS C:\PS> Get-VBRServer -Name "Host01" | Get-VBRTapeServer
Example 3
This command looks for the tape server named 'Sydney_Tape_Server' on the server represented by
the '$Host01' variable. The 'Host01' server is obtained with Get-VBRServer and assigned to the variable
beforehand.
PS C:\PS> Get-VBRTapeServer -Name "Sydney_Tape_Server" -Server $Host01
Get-VBRTapeVault
Short Description
Returns tape vaults.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VBRTapeVault
[<CommonParameters>]
Related Commands
None
Return Type
VBRTapeVault[]
Detailed Description
This cmdlet returns existing tape vaults.
You can get the list of all tape vaults or search for instances directly by name or ID.
Parameters
Parameter
Name
Description
Required Position
Accept
Wildcard
Characters
False
Named
True
False
Named
False
Accept
Pipeline
Input
<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 looks for a list of all existing vaults.
PS C:\PS> Get-VBRTapeVault
Example 2
This command looks for a vault named 'Sydney Remote Storage'.
PS C:\PS> Get-VBRTapeVault -Name "Sydney Remote Storage"
Get-VBRTaskSession
Short Description
Returns tasks performed during a specified session.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRTaskSession [-Session] <CBackupSession> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRBackupSession
Detailed Description
This cmdlet returns 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Session
True
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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.
PS C:\PS> 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.
PS C:\PS> Get-VBRTaskSession -Session $"Exchange Session" -Name "DC", "DNS"
Get-VBRToolkitDocumentation
Short Description
Opens Veeam PowerShell online help.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRToolkitDocumentation
Detailed Description
This cmdlet opens online Veeam PowerShell Reference on Veeam Help Center in your default browser.
Get-VBRViProxy
Short Description
Returns VMware backup proxies.
Applies to
Platform: VMware
For Hyper-V, run Get-VBRHvProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRViProxy [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns VMware backup proxies managed by Veeam Backup & Replication.
Run Get-VBRJobProxy to get the list of proxies assigned to a specific job.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for the list of all VMware proxies.
Get-VBRViProxy
Example 2
This command looks for the proxy named "LocalProxy".
Get-VBRViProxy -Name "LocalProxy"
True
Get-VBRViReplicaReIpRule
Short Description
Returns VMware job re-IP rules.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRViReplicaReIpRule -Job <CBackupJob> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet returns the list of re-IP rules configured for a selected VMware replication job.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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 looks for the re-IP rules set for the 'Backup Copy Job 1' job. The job is obtained with
Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "Backup Copy Job 1" | Get-VBRViReplicaReIpRule
Example 2
This command looks for the re-IP rules set for the job represented by the '$job' variable. The job is
obtained with Get-VBRJob and assigned to the variable beforehand.
PS C:\PS> Get-VBRViReplicaReIpRule -Job $job
Get-VBRViServerNetworkInfo
Short Description
Returns virtual networks for a VMware host.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRViServerNetworkInfo -Server <CHost> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRViNetworkInfo[]
VBRViDVSNetworkInfo[]
Detailed Description
This cmdlet returns the list of all virtual networks to which a selected VMware host is connected.
Parameters
Parameter
Server
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
<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 looks for the list of networks of the 'srv01.veeam.local' host. The host is obtained with
Get-VBRServer and assigned to the '$server' variable.
PS C:\PS> $server = Get-VBRServer -Type ESX -Name "srv01.veeam.local"
PS C:\PS> Get-VBRViServerNetworkInfo -Server $server
Example 2
This command looks for the list of networks to which the 'srv01.veeam.local' host is connected. The
host is obtained with Get-VBRServer and piped down.
PS C:\PS> Get-VBRServer -Type ESX -Name "srv01.veeam.local" | GetVBRViServerNetworkInfo
Example 3
This command looks for a particular network that is connected to the 'srv01.veeam.local' host.
The host is obtained with Get-VBRServer and piped down. The obtained array of networks is
assigned to the '$networks'.
The needed network is obtained by addressing the index of the corresponding element of
the array and assigned to the '$targetnet' variable.
Get-VBRViVirtualSwitch
Short Description
Returns VMware virtual switches.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Get-VBRViVirtualSwitch -Server <Object[]>
[<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRViVirtualSwitch
Detailed Description
This cmdlet returns VMware virtual switches.
Parameters
Parameter
Server
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Get-VBRWANAccelerator
Short Description
Returns WAN accelerators.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise Plus
Syntax
Get-VBRWANAccelerator [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet gets 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.
Parameters
Parameter
Name
Description
Specifies the name(s) of the WAN accelerator, or
search conditions.
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
False
Named
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 looks for the list of all WAN accelerators.
PS C:\PS> Get-VBRWANAccelerator
Example 2
This command looks for WAN accelerators with the names starting with "WAN".
PS C:\PS> Get-VBRWANAccelerator -Name WAN*
True
Get-VNXHost
Short Description
Returns EMC VNX storages.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Get-VNXHost [-Name <string[]>]
[<CommonParameters>]
Detailed Description
This cmdlet returns EMC VNX storages.
You can get the list of all storages, or narrow down the output by the storage name.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for the list of all storages.
PS C:\PS> Get-VNXHost
Example 2
This command looks for storage named "Veeam VNX Storage".
PS C:\PS> Get-VNXHost -Name "Veeam VNX Storage"
True
Get-VNXSnapshot
Short Description
Returns EMC VNX storage snapshots.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Get-VNXSnapshot [-Name <string[]>] [-Volume <CSanVolume[]>]
[<CommonParameters>]
Related Commands
Get-VNXVolume
Detailed Description
This cmdlet returns EMC VNX storage snapshots.
You can get the list of all storage snapshots, or look for a specific snapshot name or volume.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
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.
Get-VNXVolume
Short Description
Returns EMC VNX storage volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Get-VNXVolume [-Name <string[]>] [-Host <CVnxHost[]>]
[<CommonParameters>]
Related Commands
Get-VNXHost
Detailed Description
This cmdlet returns EMC VNX storage volumes.
You can get the list of all volumes, look for a specific volume name or volumes created on a selected
host.
Parameters
Parameter
Name
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
True
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.
Get-VSBApplicationGroup
Short Description
Returns application groups.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBApplicationGroup [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns existing application groups.
You can get the list of all application groups, or search for instances directly by name.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for the list of all application groups.
PS C:\PS> Get-VSBApplicationGroup
Example 2
This command looks for the application group named "MailServer Appgroup".
PS C:\PS> Get-VSBApplicationGroup -Name "MailServer Appgroup"
True
Get-VSBHvVirtualLab
Short Description
Returns Hyper-V virtual labs.
Applies to
Platform: Hyper-V
For VMware, run Get-VSBVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBVirtualLab [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns Hyper-V virtual labs that are connected to the Veeam backup console.
Run Find-VSBHvVirtualLab to look for virtual labs that are not managed by Veeam Backup &
Replication.
You can get the list of all virtual labs or search for instances directly by name.
Parameters
Parameter
Name
Description
Required Position
False
Accept
Accept
Pipeline Wildcard
Input
Characters
False
True
<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 looks for the list of all virtual labs created or connected to Veeam Backup & Replication.
PS C:\PS> Get-VSBHvVirtualLab
Example 2
This command looks for the list of virtual labs with names starting with "Exchange".
PS C:\PS> Get-VSBHvVirtualLab -Name Exchange*
Get-VSBJob
Short Description
Returns SureBackup jobs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBJob [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns existing SureBackup jobs.
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.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for the list of all created SureBackup jobs.
PS C:\PS> Get-VSBJob
Example 2
This command looks for the SureBackup jobs named "SureJob 01" and "SureJob 02".
PS C:\PS> Get-VSBJob -Name "SureJob 01", "SureJob 02"
True
Get-VSBJobOptions
Short Description
Returns settings of a selected SureBackup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBJobOptions [-Job] <CSbJob> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet returns job settings for the specified SureBackup job.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Get-VSBJobOptions -Job $SureJob
Get-VSBJobScheduleOptions
Short Description
Returns scheduling settings of a selected SureBackup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBJobScheduleOptions [-Job] <CSbJob> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet returns scheduling options for a specified SureBackup job.
Parameters
Parameter
Job
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Get-VSBJobScheduleOptions -Job $SureJob
Get-VSBSession
Short Description
Returns SureBackup sessions that have been run.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBSession [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns the 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.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 looks for the list of all backup sessions.
PS C:\PS> Get-VSBSession
Example 2
This command looks for the SureBackup session named "Winserver SureJob".
PS C:\PS> Get-VSBSession -Name *Winserver SureJob*
True
Get-VSBTaskSession
Short Description
Returns tasks performed during the specified SureBackup session.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBTaskSession [-Session] <CSbSession> [-Name <String[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VSBSession
Detailed Description
This cmdlet returns the list of tasks performed during the specified SureBackup session.
Run Get-VBRTaskSession to get the tasks for backup, replication and backup copy sessions.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Session
True
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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.
PS C:\PS> 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.
PS C:\PS> Get-VSBTaskSession -Session $"Exchange SureJob" -Name "DC", "DNS"
Get-VSBVirtualLab
Short Description
Returns VMware virtual labs.
Applies to
Platform: VMware
For Hyper-V, run Get-VSBHvVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Get-VSBVirtualLab [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet returns existing VMware virtual labs.
Run Find-VSBVirtualLab to look for virtual labs that are not managed by Veeam Backup & Replication.
You can get the list of all virtual labs or search for instances directly by name.
Parameters
Parameter
Name
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
True
<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 looks for the list of all virtual labs.
PS C:\PS> Get-VSBVirtualLab
Example 2
This command looks for the virtual labs named "MailServer VLab 01" and "MailServer VLab 05".
PS C:\PS> Get-VSBVirtualLab -Name "MailServer VLab 01", "MailServer VLab
05"
Import-VBRBackup
Short Description
Imports Veeam backups to Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Import-VBRBackup [-Server] <CHost> [-FileName] <String> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet imports Veeam backups to Veeam Backup & Replication database. You can import Veeam
backups that were, for example, created on other Veeam backup servers or stored on a repository that
is newly added to Veeam backup console.
To import backups, you must add the server where they are located to Veeam backup console.
The imported backups are registered in Veeam Backup database. You can use them for any restore
operation.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
True
(ByValue,
ByProperty
Name)
False
FileName
True
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 imports the backup named 'SureBackups' from the server named 'Fileserver'. The
target server is obtained with Get-VBRServer and piped down. The file path is
C:\Backups\SureBackups, and the file name is 'SureBackups.vbm'.
PS C:\PS> Get-VBRServer Name Fileserver | Import-VBRBackup FileName
C:\Backups\SureBackups\SureBackups.vbm
Example 2
This command imports the backup named 'SureBackups' from 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 C:\Backups\SureBackups, and the file name is 'SureBackups.vbm'.
PS C:\PS> Import-VBRBackup Server $server FileName
C:\Backups\SureBackups\SureBackups.vbm
Import-VBRTapeMedium
Short Description
Imports tapes into library.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Import-VBRTapeMedium -Library <VBRTapeLibrary[]> [-Wait]
[<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Return Type
VBRBackupSession[]
Detailed Description
This cmdlet imports tapes newly loaded to a tape library.
You need to run importing procedure against all new tapes. Importing moves tapes from I/E slot to
library standard slots.
Note:
Import/export commands are available only for the devices that support corresponding operations
and include I/E slot.
Parameters
Parameter
Library
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Accept
Pipeline
Input
<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 imports tapes to the 'HP MSL G3 Series 3.00' tape library.
Run Get-VBRTapeLibrary to get the library and pipe it down.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | ImportVBRTapeMedium
Example 2
This command imports tapes to a selected tape library.
Run Get-VBRTapeLibrary to get the library and save it to the $library variable.
PS C:\PS> Import-VBRTapeMedium -Library $library
Move-VBRTapeMedium
Short Description
Moves tape to media pool or vault.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Move-VBRTapeMedium -Medium <VBRTapeMedium[]> -MediaPool <VBRTapeMediaPool>
[-WhatIf] [-Confirm] [<CommonParameters>]
-ORMove-VBRTapeMedium -Medium <VBRTapeMedium[]> -Vault <VBRTapeVault> [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Get-VBRTapeMediaPool
Get-VBRTapeVault
Return Type
None
Detailed Description
This cmdlet moves selected tapes to another media pool or media vault.
The cmdlet provides two scenarios for each case:
1.
You cannot move tapes that are used by any tape job.
When you move a tape to any media pool, Veeam Backup & Replication marks this tape as free.
Important!
2.
Parameters
Parameter
Medium
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
True
Named
False
False
True
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 moves a tape named '0014001H' to a media pool represented by the '$mediapool'
variable.
The media pool to which you want to move the tape is is obtained with GetVBRTapeMediaPool and assigned to the '$mediapool' variable beforehand.
Example 2
This command moves a tape to the Omega media vault.
The needed tape is obtained with Get-VBRTapeMedium and assigned to the '$medium'
variable beforehand.
The vault to which you want to move the tape is is obtained with Get-VBRTapeVault and
assigned to the '$OmegaVault' variable beforehand.
New-VBRBackupToTapeScheduleOptions
Short Description
Creates a new VBRBackupToTapeScheduleOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
New-VBRBackupToTapeScheduleOptions [-Type <VBRBackupToTapePolicyType>] [DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>] [BackupWindowOptions <VBRBackupWindowOptions>] [-Job <VBRJob>] [-Enabled][WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
New-VBRDailyOptions
New-VBRMonthlyOptions
New-VBRBackupWindowOptions
Get-VBRJob
Return Type
VBRBackupToTapeScheduleOptions
Detailed Description
This cmdlet creates the VBRBackupToTapeScheduleOptions object. This object contains schedule
settings for backup to tape job and is used further to apply these settings to an existing backup to
tape job.
Parameters
Parameter
Type
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
False
False
months.
Default: Daily.
Daily
Options
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Backup
Window
Options
Period: 22:00.
DayNumberInMonth: Fourth.
DayOfWeek: Saturday.
Months: January, February, March,
April, May, June, July, August,
September, October, November,
December.
Job
Enabled
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
New-VBRBackupWindowOptions
Short Description
Creates a new VBRBackupWindowOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRBackupWindowOptions [-FromDay <DayOfWeek>] [-FromHour <Int32>] [ToDay <DayOfWeek>] [-ToHour <Int32>] [-Enabled] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
None
Return Type
VBRBackupWindowOptions
Detailed Description
This cmdlet creates the VBRBackupWindowOptions object. This object contains the backup window
settings. The backup window sets a time period within which the job is allowed to run. The
VBRBackupWindowOptions object is used further to apply these settings to existing jobs.
Parameters
Parameter
Description
FromDay
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
ToDay
ToHour
False
Named
False
Default: 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
This command creates a backup window object that will allow a job to run from 22 PM on Friday to 22
PM on Sunday. The result is saved to the $windowoptions variable.
PS C:\PS> PS C:\PS> $windowoptions = New-VBRBackupWindowOptions -FromDay
Friday -FromHour 22 -ToDay Sunday -ToHour 22 -Enabled
New-VBRCloudFailoverPlanObject
Short Description
Creates the VBRCloudFailoverPlanObject object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
New-VBRCloudFailoverPlanObject -RestorePoint <COib> [-BootOrder <Int32>] [BootDelay <Int32>] [-PublicIpRule <VBRFailoverPlanPublicIPRule[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>] [PipelineVariable <String>] [<CommonParameters>]
Related Commands
Find-VBRViEntity
Return Type
VBRCloudFailoverPlanObject
Detailed Description
This cmdlet creates a new VBRCloudFailoverPlanObject object. This object contains the replica that
you want to add to a cloud failover plan. It is used then in the Add-VBRFailoverPlan cmdlet.
You must create the VBRCloudFailoverPlanObject object for each replica that you want to add to
the failover plan. For each replica, you can set the boot order and the delay time.
The boot order indicates the order in which the replicas will start by the failover plan. Make
sure you set the dependent VMs to start after the VMs they depend on.
The delay time is an interval between each VM start. Use delay intervals to make sure that
some VMs are already running at the moment the dependent VMs start.
Parameters
Parameter
Restore
Point
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
False
Named
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
False
New-VBRCloudProviderNetworkAppliance
Short Description
Creates a network extension appliance on the user side.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides three parameter sets.
Related Commands
Get-VBRServer
Get-VBRHvServerNetworkInfo
Get-VBRViServerNetworkInfo
Find-VBRViResourcePool
Find-VBRViDatastore
Return Type
VBRViCloudProviderNetworkAppliance
VBRHvCloudProviderNetworkAppliance
Detailed Description
This cmdlet creates a VMware or a Hyper-V network extension appliance on the user's cloud host. This
appliance is used in replica failover scenarios.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Server
True
Named
False
False
Network
False
Named
False
False
IpAddress
False
Named
False
False
Subnet
Mask
False
Named
False
False
Default
Gateway
False
Named
False
False
Resource
Pool
False
Named
False
False
Datastore
False
Named
False
False
Folder
False
Named
False
False
VLanId
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.
New-VBRCloudTenantHwPlanOptions
Short Description
Creates a VBRCloudTenantHwPlanOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRCloudTenantHwPlanOptions -HardwarePlan <VBRCloudHardwarePlan> [EnableWanAcceleration] [-WanAccelerator <CWanAccelerator>]
[<CommonParameters>]
Related Commands
Get-VBRCloudHardwarePlan
Get-VBRWANAccelerator
Return Type
VBRCloudTenantHwPlanOptions
Detailed Description
This cmdlet creates a new VBRCloudTenantHwPlanOptions object. The object contains the cloud user
options.
Parameters
Parameter
Description
Hardware
Plan
EnableWan
Acceleration
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
Accepts
VBRHvCloudHardwarePlan or
VBRViCloudHardwarePlan
objects.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
New-VBRCloudTenantReplicationResources
Short Description
Creates a VBRCloudTenantReplicationResources object containing replication resources.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRCloudTenantReplicationResources -HardwarePlanOptions
<VBRCloudTenantHwPlanOptions[]> [-EnableNetworkFailoverResources] [EnablePublicIp] [-NumberOfPublicIp <int>] [<CommonParameters>]
Related Commands
New-VBRCloudTenantHwPlanOptions
Return Type
VBRCloudTenantReplicationResources
Detailed Description
This cmdlet creates a new VBRCloudTenantReplicationResources object. This object contains the
cloud user replication resources.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
Enable
Network
Failover
Resources
False
Named
False
False
Enable
PublicIp
False
Named
False
False
NumberOf
PublicIp
False
Named
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
False
New-VBRCloudTenantResource
Short Description
Creates a new VBRCloudTenantResource object containing backup resources.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
New-VBRCloudTenantResource -Repository <CBackupRepository> RepositoryFriendlyName <String> -Quota <Int32> [-EnableWanAccelerator] [WanAccelerator <CWanAccelerator>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Get-VBRWANAccelerator
Return Type
VBRCloudTenantResource
Detailed Description
This cmdlet creates a new VBRCloudTenantResource object. This object contains the backup resources
settings and is used further to apply these settings to a cloud user account.
Parameters
Parameter
Repository
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
True
Named
False
False
True
Named
False
False
Quota
False
Named
False
False
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 an object containing a 10 GB repository quota. The created object is assigned
to the '$standard1' variable.
The backup repository from which the cloud resources will be allocated is obtained with GetVBRBackupRepository and assigned to the '$repo1' variable.
PS C:\PS> $standard1 = New-VBRCloudTenantResource -Repository $repo1 RepositoryFriendlyName "Standard Tier Repository" -Quota 10
Example 2
This command creates an object containing a 100 GB repository quota. The WAN acceleration is
allowed. The created object is assigned to the '$golden2' variable.
The backup repository from which the cloud resources will be allocated is obtained with GetVBRBackupRepository and assigned to the '$repo2' variable.
The EnableWanAcceleration parameter is used to enable using WAN acceleration for data
transfer. The WAN accelerator that will be used is obtained with Get-VBRWANAccelerator and
assigned to the '$wan' variable beforehand.
PS C:\PS> $golden2 = New-VBRCloudTenantResource -Repository $repo2 RepositoryFriendlyName "Golden Tier Repository" -Quota 100 EnableWanAccelerator -WanAccelerator $wan
New-VBRCloudVLANConfiguration
Short Description
Creates a VBRCloudVLANConfiguration object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
This cmdlet provides 2 parameter sets.
For VMware:
For Hyper-V:
Related Commands
Get-VBRServer
Get-VBRViVirtualSwitch
Get-VBRHvServerNetworkInfo
Return Type
VBRCloudVLANConfiguration
Detailed Description
This cmdlet creates a VBRCloudVLANConfiguration object. This object contains VLAN settings that can
be used to provide network to user VM replicas on the cloud host.
Parameters
Parameter
Server
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
ViVirtual
Switch
True
Named
False
False
HvNetwork
Info
True
Named
False
False
True
Named
False
False
True
Named
False
False
FirstVLAN
Without
Internet
True
Named
False
False
LastVLAN
Without
Internet
True
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.
New-VBRConfigurationBackupScheduleOptions
Short Description
Creates a new VBRConfigurationBackupScheduleOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRConfigurationBackupScheduleOptions [-Enable] [-Type
<VBRConfigurationBackupScheduleType> {Daily | Monthly}] [-DailyOptions
<VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>]
[<CommonParameters>]
Related Commands
New-VBRDailyOptions
New-VBRMonthlyOptions
Return Type
VBRConfigurationBackupScheduleOptions
Detailed Description
This cmdlet creates a new VBRConfigurationBackupScheduleOptions object. This object contains
schedule settings for configuration backup job. It is used then in Set-VBRConfigurationBackupJob.
If you run this cmdlet without parameters, it will create an object with default settings.
Parameters
Parameter
Enable
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
True or
False
False
Named
False
False
False
Named
False
False
DailyOptions
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 an object with default configuration job schedule settings. The object is saved
to the '$defaultschedule' variable.
PS C:\PS> $defaultschedule = New-VBRConfigurationBackupScheduleOptions
Example 2
This examples shows how to set daily schedule for the configuration backup job. The job will run on 5
AM on Saturdays.
Run New-VBRDailyOptions to create an object with settings for the Daily type. Save the result
to the "$daily" variable.
Example 3
This examples shows how to set monthly schedule for the configuration backup job. The job will run
on 00:00 the first Friday of each month.
Run New-VBRDailyOptions to create an object with settings for the Monthly type. Save the
result to the "$monthly" variable.
Example 4
This command disables the configuration job schedule. The object is saved to the '$disableschedule'
variable.
PS C:\PS> $disableschedule = New-VBRConfigurationBackupScheduleOptions Enable:$false
New-VBRDailyOptions
Short Description
Creates a new VBRDailyOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRDailyOptions [-DayOfWeek <DayOfWeek[]>] [-Period <TimeSpan>] [-Type
<VBRDailyOptionsType>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
None
Return Type
VBRDailyOptions
Detailed Description
This cmdlet creates the VBRDailyOptions object. This object contains the daily schedule settings. You
can use this object to set job schedule or policies.
Parameters
Parameter
Day
OfWeek
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
Default: Saturday.
Period
Type
<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 schedule with the following settings: every Friday at 23:00. Save the result to
the $fridayoptions variable for later use.
PS C:\PS> PS C:\PS> $fridayoptions = New-VBRDailyOptions -DayOfWeek Friday
-Period 23:00
Example 2
This command creates schedule with the following settings: every day at 20:00. Save the result to the
$everydayoptions variable for later use.
PS C:\PS> PS C:\PS> $everydayoptions = New-VBRDailyOptions -Type Everyday Period 20:00
Example 3
This command creates schedule with the following settings: on weekends at 18:00. The Period is not
set the command will use the default value. Save the result to the $weekendoptions variable for
later use.
PS C:\PS> PS C:\PS> $weekendoptions = New-VBRDailyOptions -DayOfWeek
Saturday, Sunday
New-VBRFailoverPlanObject
Short Description
Creates the VBRFailoverPlanObject object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
New-VBRFailoverPlanObject -RestorePoint <COib> [-BootOrder <int>] [BootDelay <int>] [<CommonParameters>]
-ORNew-VBRFailoverPlanObject -Vm <IItem> [-BootOrder <int>] [-BootDelay <int>]
[<CommonParameters>]
Related Commands
Find-VBRViEntity
Return Type
VBRFailoverPlanObject
Detailed Description
This cmdlet creates the VBRFailoverPlanObject object. This object contains the VM that you want to
add to a failover plan. It is used then in the Add-VBRFailoverPlan cmdlet.
You must create the VBRFailoverPlanObject object for each VM that you want to add to the failover
plan. For each VM, you can set the boot order and the delay time.
The boot order indicates the order in which the VMs will start by the failover plan. Make sure
you set the dependent VMs to start after the VMs they depend on.
The delay time is an interval between each VM start. Use delay intervals to make sure that
some VMs are already running at the moment the dependent VMs start.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Restore
Point
True
Named
False
Vm
True
Named
True
False
Named
False
False
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
These commands create three VBRFailoverPlanObject objects for the group of mail servers: a DNS
server and two Microsoft Exchange servers. The DNS server starts first followed by the two Microsoft
Exchange servers started with a delay.
The servers objects are obtained with Find-VBRViEntity and piped down.
The VBRFailoverPlanObject for the DNS server is assigned to the '$DNS' variable. The boot
order is omitted and will be automatically set to 0. The boot delay is set to 0 sec to start the
DNS server immediately.
The VBRFailoverPlanObject for the first Microsoft Exchange server is assigned to the
'$MSExchange01' variable. The boot order is set to 1, and the boot delay is set to 180 sec.
The VBRFailoverPlanObject for the second Microsoft Exchange server is assigned to the
'$MSExchange02' variable. The boot order is set to 2, and the boot delay is set to 120 sec.
Example 2
This command creates the VBRFailoverPlanObject for the server named 'MS_Exchange_Server_01'.
The server object is obtained with Find-VBRViEntity and assigned to the '$vm1' variable.
New-VBRFailoverPlanPublicIPRule
Short Description
Creates a VBRFailoverPlanPublicIPRule object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRFailoverPlanPublicIPRule -SourceIp <string> -SourcePort <int> TargetIp <string> -TargetPort <int> [-Description <string>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRFailoverPlanPublicIPRule
Detailed Description
This cmdlet creates a VBRFailoverPlanPublicIPRule object. This object contains a rule for mapping public
IP and ports to the IP and ports of the cloud replica VM. It is used then in the New-VBRCloudFailoverPlanObject
cmdlet.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
SourceIp
True
Named
False
False
SourcePort
True
Named
False
False
TargetIp
True
Named
False
False
TargetPort
True
Named
False
False
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.
New-VBRFileToTapeBackupPolicy
Short Description
Creates a new VBRFileToTapeBackupPolicy object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRFileToTapeBackupPolicy [-Type <VBRFileToTapeBackupPolicyType>] [DailyOptions <VBRDailyOptions>] [-MonthlyOptions <VBRMonthlyOptions>] [Enabled] [-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
New-VBRDailyOptions
New-VBRMonthlyOptions
Return Type
VBRFileToTapeBackupPolicy
Detailed Description
This cmdlet creates the VBRFileToTapeBackupPolicy object. This object contains backup creation
schedule settings for file to tape job and is used further to apply these settings to an existing file to
tape job.
Parameters
Parameter
Type
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
Default: Daily.
Daily
Options
Type: SelectedDays
Period: 18:00
Monthly
Options
DayOfWeek: Saturday
False
Named
False
False
False
Named
False
False
Default:
Enabled
Period: 22:00
DayNumberInMonth: Fourth,
DayOfWeek: Saturday,
Months: January, February, March,
April, May, June, July, August,
September, October, November,
December.
<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 file to tape job schedule to run on last Sunday on 22:00 every month. The
schedule is enabled.
PS C:\PS> $monthlyoptions = New-VBRMonthlyOptions -DayNumberInMonth Last DayOfWeek Sunday Period 22:00
PS C:\PS> New-VBRFileToTapeBackupPolicy -Type Monthly -MonthlyOptions
$monthlyoptions -Enabled
New-VBRFileToTapeObject
Short Description
Creates a new VBRFileToTapeObject object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRFileToTapeObject [-Server <CHost>] -Path <String> [-IncludeMask
<String>] [-Credentials <CCredentials>] [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Get-VBRCredentials
Return Type
VBRFileToTapeObject
Detailed Description
This cmdlet creates a VBRFileToTapeObject object. This object contains files or directories that you
want to add to a file to tape job.
Parameters
Parameter
Server
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
Default: Local.
Path
False
Named
False
False
Include
Mask
False
Named
False
False
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
This command creates an object for a file to tape job. The object contains a folder on the server
named "fileserver08".
1.
Run Get-VBRServer to get the server where the files are located. Save it to the $server
variable.
2.
Run Get-VBRCredentials to get the credentials to access the Fileserver08. Save the credentials
to the $creds variable.
3.
New-VBRFullBackupToTapePolicy
Short Description
Creates a new VBRFullBackupToTapePolicy object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
New-VBRFullBackupToTapePolicy [-Type <VBRFullBackupToTapePolicyType>] [MonthlyOptions <VBRMonthlyOptions>] [-WeeklyOnDays <DayOfWeek[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
New-VBRMonthlyOptions
Return Type
VBRFullBackupToTapePolicy
Detailed Description
This cmdlet creates the VBRFullBackupToTapePolicy object. This object contains schedule settings for
creating virtual synthesized full backup for tape and is used further to apply these settings to an
existing backup to tape job.
Parameters
Parameter
Type
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
Default: WeeklyOnDays.
Monthly
Options
Period: 22:00
Weekly
OnDays
DayNumberInMonth: Fourth
DayOfWeek: Saturday
Months: January, February, March,
April, May, June, July, August,
September, October, November,
December.
False
Named
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
False
New-VBRHvCloudHWPlanDatastore
Short Description
Creates a VBRHvCloudHardwarePlanDatastore object.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
New-VBRHvCloudHWPlanDatastore -DatastorePath <String> -FriendlyName
<String> -Quota <Int32> [-WarningAction <ActionPreference>] [WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]
Related Commands
None
Return Type
VBRHvCloudHardwarePlanDatastore
Detailed Description
This cmdlet creates a VBRHvCloudHardwarePlanDatastore object that contains a datastore for a
hardware plan. This object is used then in the Add-VBRHvCloudHardwarePlan cmdlet.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Datastore
Path
True
Named
False
False
Friendly
Name
True
Named
False
False
Quota
True
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.
New-VBRHvReplicaReIpRule
Short Description
Creates a new Hyper-V replica re-IP rule.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRHvReplicaReIpRule [-SourceIp <String>] [-SourceMask <String>] [TargetIp <String>] [-TargetMask <String>] -TargetGateway <String> [-DNS
<String[]>] [-WINS <String[]>] [-Description <String>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-PipelineVariable
<String>] [<CommonParameters>]
Related Commands
None
Return Type
VBRHvReplicaReIpRule
Detailed Description
This cmdlet creates a VBRHvReplicaReIpRule object containing a list of rules for different IP addressing
scheme. This object is then further used for creating or modifying replication jobs.
Parameters
Parameter
Source
Ip
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
Target
Ip
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
WINS
Description
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
New-VBRJobOptions
Short Description
Sets job options.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRJobOptions [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [<CommonParameters>]
-ORNew-VBRJobOptions [-ForBackupJob] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
-ORNew-VBRJobOptions [-ForReplicaJob] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
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
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.
New-VBRJobScheduleOptions
Short Description
Sets job schedule options.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRJobScheduleOptions [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
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.
New-VBRJobScriptOptions
Short Description
Creates a new VBRJobScriptOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRJobScriptOptions [-PreScriptEnabled] [-PreCommand <string>] [PostScriptEnabled] [-PostCommand <string>] [-Day <DayOfWeek[]> {Sunday |
Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [-Periodicity
<VBRPeriodicityType> {Cycles | Days}] [-Frequency <uint32>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRJobScriptOptions
Detailed Description
This cmdlet creates a new VBRJobScriptOptions object. This object contains settings for running prejob and post-job scripts and is used further to apply these settings to an existing job.
Parameters
Parameter
PreScript
Enabled
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
PostScript
Enabled
False
Named
False
False
False
Named
False
False
Day
False
Named
False
False
False
Named
False
False
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.
New-VBRJobVssOptions
Short Description
Returns default set of VSS options for job or VM in job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides the following parameter sets.
Default VSS settings for backup jobs (including vCloud backup jobs):
Detailed Description
This cmdlet returns the CVssOptions object containing default VSS settings for backup jobs,
replication jobs or selected VMs. Use an appropriate parameter set for each case.
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 modify the settings and use this object to change the VSS settings of a job or VM. Run SetVBRJobVssOptions to apply the VSS settings to a job.
Tip:
Save the object to a variable when you customize settings: this variable can be used in several jobs.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
ForJob
False
Named
False
False
ForObject
False
Named
False
False
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
This example enables the VSS settings and the Copy only option.
1.
2.
PS C:\PS> $o = New-VBRJobVssOptions
PS C:\PS> $o.Enabled = $true
PS C:\Users\Administrator> $o.VssSnapshotOptions.IsCopyOnly = $true
PS C:\Users\Administrator> $o
VssSnapshotOptions
: Enabled: [False], IgnoreErrors: [True],
IsCopyOnly: [True]
WinGuestFSIndexingOptions : Type: [None]
LinGuestFSIndexingOptions : Type: [None]
SqlBackupOptions
: TransactionLogsProcessing:
[TruncateOnlyOnSuccessJob], BackupLogsFrequencyMin: [15],
UseDbBackupRetention: [True], RetainDays:
[15], ProxyAutoSelect: [True]
GuestScriptsOptions
: Veeam.Backup.Model.CGuestScriptsOptions
ExchangeBackupOptions
: TransactionLogsProcessing:
[TruncateOnlyOnSuccessJob]
WinCredsId
: 00000000-0000-0000-0000-000000000000
LinCredsId
: 00000000-0000-0000-0000-000000000000
Enabled
: True
IgnoreErrors
: True
AreWinCredsSet
: False
AreLinCredsSet
: False
GuestFSIndexingType
: None
IncludedIndexingFolders
: {}
ExcludedIndexingFolders
: {}
LinGuestFSIndexingType
: None
LinIncludedIndexingFolders : {}
LinExcludedIndexingFolders : {}
IsFirstUsage
: True
m_isFirstUsage
: True
New-VBRMonthlyOptions
Short Description
Creates a new VBRMonthlyOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRMonthlyOptions [-Period <TimeSpan>] [-DayNumberInMonth
<VBRDayNumberInMonth>] [-DayOfWeek <DayOfWeek>] [-Months <VBRMonth[]>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRMonthlyOptions
Detailed Description
This cmdlet creates the VBRMonthlyOptions object. This object contains the job monthly schedule
settings. You can use this object to set job schedule or policies.
Parameters
Parameter
Period
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Day
OfWeek
Months
December.
Default: January, February, March, April, May,
June, July, August, September, October,
November, December.
<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 the schedule for a job to run on 23:00 on the second Wednesday every month.
PS C:\PS> PS C:\PS> New-VBRMonthlyOptions -DayNumberInMonth Second DayOfWeek Wednesday Period 23:00
Example 2
This command creates the schedule for a job to run on 10:00 on the last Sunday of January and July.
PS C:\PS> PS C:\PS> New-VBRMonthlyOptions -DayNumberInMonth Last -DayOfWeek
Sunday Period 10:00 -Months January, July
New-VBRNotificationOptions
Short Description
Creates a new VBRNotificationOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRNotificationOptions [-EnableAdditionalNotification] [AdditionalAddress <string[]>] [-UseNotificationOptions] [NotificationSubject <string>] [-NotifyOnSuccess] [-NotifyOnWarning] [NotifyOnError] [-NotifyOnLastRetryOnly] [<CommonParameters>]
Related Commands
None
Return Type
VBRNotificationOptions
Detailed Description
This cmdlet creates a new VBRNotificationOptions object. This object contains custom email
notification settings and is used further to apply these settings to an existing job.
Email notification can be configured for jobs only in case that the global email notifications are
Important! enabled. Note that you cannot enable the global email notifications with Veeam PowerShell. Read
more about job notification settings in Veeam Backup & Replication user guide at
http://www.veeam.com/vmware-backup/help-center.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Enable
Additional
Notification
False
Named
False
False
Additional
Address
False
Named
False
False
False
Named
False
False
False
Named
False
False
NotifyOn
Success
False
Named
False
False
NotifyOn
Warning
False
Named
False
False
NotifyOnError
False
Named
False
False
NotifyOn
LastRetryOnly
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.
New-VBRTapeGFSMediaSetPolicy
Short Description
Creates a new VBRTapeGFSMediaSetPolicy object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRTapeGFSMediaSetPolicy [-Medium <VBRTapeMedium[]>] [MoveFromMediaPoolAutomatically] [-Name <string>] [-AppendToCurrentTape] [MoveOfflineToVault] [-Vault <VBRTapeVault>] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Get-VBRTapeVault
Return Type
VBRTapeGFSMediaSetPolicy
Detailed Description
This cmdlet creates a new VBRTapeGFSMediaSetPolicy object. This object contains advanced GFS
media set options and is used to apply these options to a GFS media pool.
Parameters
Parameter
Medium
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
Name
False
Named
False
False
AppendTo
CurrentTape
False
Named
False
False
False
Named
False
False
ToVault
Vault
False
Named
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
False
New-VBRTapeGFSScheduleOptions
Short Description
Creates a new VBRTapeGFSScheduleOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRTapeGFSScheduleOptions [-WeeklyDay <DayOfWeek> {Sunday | Monday |
Tuesday | Wednesday | Thursday | Friday | Saturday}] [-WeeklyStartAt
<timespan>] [-MonthlyKind <VBRGFSMonthlyKind> {DayOfWeek | DayOfMonth}] [MonthlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday |
Thursday | Friday | Saturday}] [-MonthlyDayOfWeekNumber
<VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [MonthlyDayOfMonth <string>] [-QuarterlyKind <VBRGFSQuarterlyKind>
{DayOfWeek | DayOfQuarter}] [-QuarterlyDayOfWeekNumber
<VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [QuarterlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday |
Thursday | Friday | Saturday}] [-QuarterlyDayOfMonth <string>] [QuarterlyMonthOfQuarter <VBRGFSMonthOfQuarter> {First | Last}] [-YearlyKind
<VBRGFSYearlyKind> {DayOfWeek | DayOfYear}] [-YearlyDayOfWeekNumber
<VBRDayNumberInMonth> {First | Second | Third | Fourth | Last | OnDay}] [YearlyDayOfWeek <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday |
Thursday | Friday | Saturday}] [-YearlyDayOfMonth <string>] [-MonthOfYear
<VBRMonth> {January | February | March | April | May | June | July | August
| September | October | November | December}] [<CommonParameters>]
Related Commands
None
Return Type
VBRTapeGFSScheduleOptions
Detailed Description
This cmdlet creates a new VBRTapeGFSScheduleOptions object. This object contains GFS schedule
and is used to apply the schedule to a tape job.
Parameters
Parameter
WeeklyDay
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
MonthlyKind
Monthly
DayOfWeek
Monthly
DayOfWeek
Number
Monthly
DayOfMonth
QuarterlyKind
Quarterly
DayOfWeek
Number
Quarterly
DayOfWeek
Quarterly
DayOfMonth
Quarterly
MonthOfQuarter
YearlyKind
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Yearly
DayOfWeek
False
Named
False
False
False
Named
False
False
False
Named
False
False
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.
New-VBRTapeMediaPoolRetentionPolicy
Short Description
Creates a new VBRTapeMediaPoolRetentionPolicy object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRTapeMediaPoolRetentionPolicy [-Period <VBRTapeMediaPoolPeriod> {None
| Days | Weeks | Months}] [-Type <VBRTapeMediaPoolRetentionType> {Never |
Period | Cyclic}] [-Value <int>] [<CommonParameters>]
Related Commands
None
Return Type
VBRTapeMediaPoolRetentionPolicy
Detailed Description
This cmdlet creates the VBRTapeMediaPoolRetentionPolicy object. This object contains the retention
settings of media pool.
Retention policy sets overwrite protection rules. The rules are set to media pool and are applied to all
tapes belonging to this media pool. After the retention period ends, the tape is queued for
overwriting.
Parameters
Parameter
Type
Description
Period
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
Required Position
Value
rotation settings.
Days: indicates that the data retention
period is measured in days. Use the
Value parameter to indicate the
number of days to protect the data.
Weeks: indicates that the data
retention period is measured in weeks.
Use the Value parameter to indicate
the number of weeks to protect the
data.
Months: indicates that the data
retention period is measured in
months. Use the Value parameter to
indicate the number of months to
protect the data.
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 set of retention rules setting retention period to 14 days. The new settings are
assigned to a variable that can be further used in Set-VBRTapeMediaPool to apply them.
The Type is set to 'Period', the Period is set to 'Days', and the Value is set to '14'.
Example 2
This command switches off the retention. The new settings are assigned to a variable that can be
further used in Set-VBRTapeMediaPool to apply them.
New-VBRTapeMediaSetCreationPolicy
Short Description
Creates a new VBRTapeMediaSetCreationPolicy object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRTapeMediaSetCreationPolicy [-DailyOptions <VBRDailyOptions>] [-Type
<VBRTapeMediaSetCreationPolicyType> {Never | Always | Daily | Monthly}]
[<CommonParameters>]
Related Commands
New-VBRDailyOptions
Return Type
VBRTapeMediaSetCreationPolicy
Detailed Description
This cmdlet creates a new VBRTapeMediaSetCreationPolicy object. This object contains the set of rules
for creating media sets. The media set creation policy in applied to media pools configuration.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
Default: Never.
<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 set of media set creation rules allowing to create a new media set for every
backup session.
PS C:\PS> New-VBRTapeMediaSetCreationPolicy -Type Always
Example 2
This command creates a set of media set creation rules. A new media set will be created every Sunday
at 22:00.
1.
Run New-VBRDailyOptions to configure schedule for creating media sets. Save the result to
the $dailyoptions variable.
2.
New-VBRvCloudVAppRestoreSettings
Short Description
Creates a set of vApp restore parameters.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRvCloudVAppRestoreSettings [-RestorePoint] <COib> [-vAppName
<String>] [-OrgVdc <IVcdItem>] [-PowerUp] [-Reason <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Find-VBRvCloudEntity ([-OrganizationVdc])
Detailed Description
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.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
vAppName
False
Named
False
False
OrgVdc
False
Named
False
False
PowerUp
False
Named
False
False
Reason
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
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.
Here you get the $restorepoint variable containing the vApp settings:
vAppOib
------Veeam.Bacvup..
OrgVdc
Vms
-------Veeam.Backup... {Veeam.Backup...
vAppName
-------vApp01
You can view the properties of the VMs within the vApp by typing "$restoreparams.vms":
VmOib
----Veeam...
StorageProfile
-------------Name: 'Storag...
vCloudDatastore
--------------Veeam.Backup.CV...
VmTemplate
----------
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.
PS C:\PS> $restoreparams = New-VBRvCloudVAppRestoreSettings -RestorePoint
$restorepoint -OrgVdc $Org
PS C:\PS> $restoreparams.vms[0].vCloudDatastore=$null
PS C:\PS> $restoreparams.vms[0].StorageProfile=$null
PS C:\PS> $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-VBRViCloudHWPlanDatastore
Short Description
Creates a VBRViCloudHardwarePlanDatastore object.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
New-VBRViCloudHWPlanDatastore -Datastore <VBRViDatastore> [-StoragePolicy
<VBRViStoragePolicy>] -FriendlyName <String> -Quota <Int32> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-PipelineVariable
<String>] [<CommonParameters>]
Related Commands
Find-VBRViDatastore
Find-VBRViStoragePolicy
Return Type
VBRHvCloudHardwarePlanDatastore
Detailed Description
This cmdlet creates a VBRViCloudHardwarePlanDatastore object that contains a datastore for a
hardware plan. This object is used then in the Add-VBRViCloudHardwarePlan cmdlet.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Datastore
True
Named
False
False
Storage
Policy
False
Named
False
False
Friendly
Name
True
Named
False
False
Quota
True
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.
New-VBRViReplicaReIpRule
Short Description
Creates a new VMware replica re-IP rule.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
New-VBRViReplicaReIpRule [-SourceIp <String>] [-SourceMask <String>] [TargetIp <String>] [-TargetMask <String>] -TargetGateway <String> [-DNS
<String[]>] [-WINS <String[]>] [-Description <String>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
None
Return Type
VBRViReplicaReIpRule
Detailed Description
This cmdlet creates a VBRViReplicaReIpRule object containing a list of rules for different IP addressing
scheme. This object is then further used for creating or modifying replication jobs.
Parameters
Parameter
Source
Ip
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
Target
Ip
addresses.
Accepts string type.
Default: 172.17.*.*.
Target
Mask
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
WINS
Description
<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 new re-IP rule. The created object is saved into the '$reiprule' variable.
PS C:\PS> $reiprule = New-VBRViReplicaReIpRule -SourceIp 172.16.*.* SourceMask 255.255.0.0 -TargetIp 172.17.*.* -TargetMask 255.255.0.0 TargetGateway 172.17.0.1
Example 2
This example shows how to set a re-IP rule to an existing replica job.
The re-IP rule is assigned to the '$reiprule' variable that was created in the 'Example 1'.
To set the re-IP rule, the replication job is edited with Set-VBRViReplicaJob. The job is
obtained with Get-VBRJob and assigned to the '$replicajob' variable beforehand.
New-VSBJobOptions
Short Description
Sets SureBackup job options.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
New-VSBJobOptions [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [<CommonParameters>]
Detailed Description
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.
<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:
:
:
:
:
:
:
:
:
:
True
True
True
mailto@veeam.com
False
False
6
False
True
Remove-HP3Snapshot
Short Description
Removes a HPE 3PAR StoreServ storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
Syntax
Remove-HP3Snapshot -Snapshot <CSanSnapshot[]> [<CommonParameters>]
Related Commands
Get-HP3Snapshot
Detailed Description
This cmdlet permanently removes the selected HPE 3PAR StoreServ storage snapshot from your
storage system.
Parameters
Parameter
Snapshot
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 removes the snapshot named "vol1_SS_1". The snapshot object is obtained with GetHP3Snapshot and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-HP3Snapshot -Snapshot $"snapshot1"
Remove-HP3Storage
Short Description
Removes a HPE 3PAR StoreServ storage storage.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
Syntax
Remove-HP3Storage -Storage <CHp3PARHost> [<CommonParameters>]
Related Commands
Get-HP3Storage
Detailed Description
This cmdlet removes the selected HPE 3PAR StoreServ storage from Veeam Backup & Replication.
The HPE 3PAR StoreServ storage is not deleted from server. When you remove a HPE 3PAR StoreServ
storage, you stop managing it via your Veeam Backup & Replication console.
Parameters
Parameter
Storage
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 removes the storage named "HPE Store 01". The storage object is obtained with GetHP3Storage and piped down.
PS C:\PS> Get-HP3Storage -Name "HPE 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.
PS C:\PS> Remove-HP3Storage -Storage $"store01"
Remove-HP4Snapshot
Short Description
Removes a HPE StoreVirtual storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
Syntax
Remove-HP4Snapshot -Snapshot <CSanSnapshot[]> [<CommonParameters>]
Related Commands
Get-HP4Snapshot
Detailed Description
This cmdlet permanently removes the selected HPE StoreVirtual storage snapshot from your storage
system.
Alias
Remove-VBRHPSnapshot
Parameters
Parameter
Snapshot
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 removes the snapshot named "vol1_SS_1". The snapshot object is obtained with GetHP4Snapshot and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-HP4Snapshot -Snapshot $"snapshot1"
Remove-HP4Storage
Short Description
Removes a storage from Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE LeftHand P4000, HPE StoreVirtual VSA
Syntax
Remove-HP4Storage -Storage <CHpP4Group> [<CommonParameters>]
Related Commands
Get-HP4Storage
Detailed Description
This cmdlet removes the selected storage from Veeam Backup & Replication.
The storage is not deleted from server. When you remove a storage, you stop managing it via your
Veeam Backup & Replication console.
Alias
Remove-VBRHPStorage
Parameters
Parameter
Storage
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 removes the storage named "HPE Store 01". The storage object is obtained with GetHP4Storage and piped down.
PS C:\PS> Get-HP4Storage -Name "HPE 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.
PS C:\PS> Remove-HP4Storage -Storage $"store01"
Remove-NetAppHost
Short Description
Removes storage.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-NetAppHost -Host <CNaHost> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-NetAppHost
Detailed Description
This cmdlet removes the selected storage from Veeam Backup & Replication.
The storage is not deleted from server where it was created. When you remove a storage, you stop
managing it via your Veeam Backup & Replication console.
Parameters
Parameter
Host
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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
This command removes the storage named "NetApp Store 01".
The storage object is obtained with Get-NetAppHost and piped down.
PS C:\PS> Get-NetAppHost -Name "NetApp Store 01" | Remove-NetAppHost
Remove-NetAppSnapshot
Short Description
Removes storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-NetAppSnapshot -Snapshot <CSanSnapshot[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-NetAppSnapshot
Detailed Description
This cmdlet permanently removes the selected storage snapshot from your virtual infrastructure.
Parameters
Parameter
Description
Snapshot
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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
This command removes the snapshot with name "vol1_SS_1".
The snapshot object is obtained with Get-NetAppSnapshot and piped down.
PS C:\PS> Get-NetAppSnapshot -Name "vol1_SS_1" | Remove-NetAppSnapshot
Remove-VBRBackup
Short Description
Removes selected backups.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRBackup [-Backup] <CBackup[]> [-FromDisk] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRBackup
Detailed Description
This cmdlet removes selected backups.
You can use the following options:
Remove from database. When you remove backup from database, you remove records
about the backup from Veeam database. The backup files remain in repository. You can
import such backups later with Import-VBRBackup.
Remove from disk. With this option, the backup is removed from database and from disk.
This removal is complete and non-reversible.
Parameters
Parameter
Backup
Description
Required Position
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
FromDisk
Accept
Pipeline
Input
database.
WhatIf
False
Named
False
False
Confirm
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 removes the backups named "Backup Job 01" and "Backup Job 02" from database only.
The backups are obtained with Get-VBRBackup and piped down.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> Remove-VBRBackup $backup -FromDisk
Remove-VBRBackupRepository
Short Description
Removes a specified backup repository from Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRBackupRepository -Repository <CBackupRepository[]> [WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRBackup
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
WhatIf
False
Named
False
False
Confirm
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 removes the backup repository named "Local Repository 01". The repository is
obtained with Get-VBRBackupRepository and piped down.
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 $repository
Remove-VBRCloudGateway
Short Description
Removes a selected cloud gateway.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Remove-VBRCloudGateway -CloudGateway <VBRCloudGateway[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudGateway
Return Type
None
Detailed Description
This cmdlet removes a selected cloud gateway from Veeam Backup & Replication console.
When you remove a cloud gateway, Veeam Backup & Replication unassigns the gateway role from the
server, so it is no longer used as a cloud gateway. The actual server remains connected to Veeam
Backup & Replication.
Parameters
Parameter
Cloud
Gateway
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 removes a cloud gateway represented by the '$cloudgateway' variable.
The cloud gateway is obtained with Get-VBRCloudGateway and assigned to the variable beforehand.
PS C:\PS> Remove-VBRCloudGateway -CloudGateway $cloudgateway
Example 2
This command removes a cloud gateway with the 172.16.12.45 IP address.
The cloud gateway is obtained with Get-VBRCloudGateway and piped down.
PS C:\PS> Get-VBRCloudGateway -Name "172.16.12.45" | Remove-VBRCloudGateway
Remove-VBRCloudHardwarePlan
Short Description
Removes a selected hardware plan.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Remove-VBRCloudHardwarePlan -HardwarePlan <VBRCloudHardwarePlan[]> [WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRCloudHardwarePlan
Return Type
None
Detailed Description
This cmdlet removes a selected hardware plan.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
Accepts VBRViCloudHardwarePlan
or VBRHvCloudHardwarePlan
objects.
You can assign multiple hardware
plans to this object.
WhatIf
False
Named
False
False
Confirm
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.
Remove-VBRCloudProvider
Short Description
Removes service provider.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Remove-VBRCloudProvider -CloudProvider <VBRCloudProvider[]> [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRCloudProvider
Return Type
None
Detailed Description
This cmdlet removes service provider from Veeam Backup & Replication.
When you remove a service provider, you become unable to reach your cloud repository. The data
stored on the cloud repository remains. You can access it if you add the service provider to the Veeam
backup console again.
You cannot remove a service provider if its cloud repositories are used by any backup jobs.
Important!
Parameters
Parameter
Cloud
Provider
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 removes all cloud service providers added to Veeam Backup & Replication.
The service providers are obtained by Get-VBRCloudProvider and piped down.
PS C:\PS> Get-VBRCloudProvider | Remove-VBRCloudProvider
Example 2
This command removes a service provider represented by the '$CloudProvider1' variable.
The service provider is obtained by Get-VBRCloudProvider and assigned to the variable beforehand.
PS C:\PS> Remove-VBRCloudProvider -CloudProvider $CloudProvider1
Example 3
This command removes the service provider with the 104.45.95.227 IP address.
The service provider is obtained by Get-VBRCloudProvider and piped down.
PS C:\PS> Get-VBRCloudProvider -Name "104.45.95.227" | RemoveVBRCloudProvider
Remove-VBRCloudPublicIP
Short Description
Removes a selected IP address from the public IP addresses pool.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Remove-VBRCloudPublicIP -CloudIp <VBRCloudIP[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudPublicIP
Return Type
None
Detailed Description
This cmdlet removes a selected IP address from the public IP addresses pool.
Parameters
Parameter
CloudIp
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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.
Remove-VBRCloudTenant
Short Description
Removes cloud user account.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Remove-VBRCloudTenant -CloudTenant <VBRCloudTenant[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudTenant
Return Type
None
Detailed Description
This cmdlet removes a selected cloud user account from Veeam Backup & Replication.
The user account is removed permanently. The service provider cannot undo this operation.
When you remove a cloud user account that was using WAN accelerators, the WAN accelerators' cache
is cleared automatically.
Parameters
Parameter
Cloud
Tenant
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 removes all cloud user profiles registered in Veeam Backup & Replication.
PS C:\PS> Get-VBRCloudTenant
Example 2
This command removes two cloud user accounts represented by the '$CloudUser1' and '$CloudUser2'
variables.
The cloud user accounts are obtained by Get-VBRCloudTenant and assigned to the variables
beforehand.
PS C:\PS> Remove-VBRCloudTenant -CloudTenant $CloudUser1, $CloudUser2
Example 3
This command removes the ABC company cloud user account.
The cloud user account is obtained by running Get-VBRCloudTenant and piped down.
PS C:\PS> Get-VBRCloudTenant -Name "ABC Company" | Remove-VBRCloudTenant
Example 4
This command removes all cloud user accounts using the 'Backup Vol2' backup repository.
The backup repository is obtained by Get-VBRBackupRepository and piped down to GetVBRCloudTenant. The obtained cloud user account are piped down to Remove-VBRCloudTenant.
PS C:\PS> Get-VBRBackupRepository -Name "Backups Vol2" | Get-VBRCloudTenant
| Remove-VBRCloudTenant
Remove-VBRCloudVLANConfiguration
Short Description
Removes VLAN.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Remove-VBRCloudVLANConfiguration -Configuration <VBRCloudVLANConfiguration>
[-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRCloudVLANConfiguration
Detailed Description
This cmdlet removes a selected VLAN.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
Accepts Get-
VBRCloudVLANConfiguration
object.
WhatIf
False
Named
False
False
Confirm
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.
Remove-VBRCredentials
Short Description
Removes a credentials record from Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRCredentials -Credential <CCredentials> [<CommonParameters>]
Related Commands
Get-VBRCredentials
Detailed Description
This cmdlet permanently removes the selected credentials from the database.
Parameters
Parameter
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 permanently removes the credentials record with name "Administrator". The
credentials object is obtained with Get-VBRCredentials and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VBRCredentials -Credential $c
Remove-VBRDefaultGateway
Short Description
Removes the default gateway.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRDefaultGateway [-Gateway <VBRDefaultGateway>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
None
Return Type
VBRDefaultGateway
Detailed Description
This cmdlet removes the default gateway.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Gateway
True
Named
False
WhatIf
False
Named
False
False
Confirm
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.
Remove-VBREncryptionKey
Short Description
Removes encryption key.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBREncryptionKey [-EncryptionKey] <PSCryptoKey> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBREncryptionKey
Return Type
None
Detailed Description
This cmdlet removes a selected encryption key.
You cannot remove an encryption key if it is used by any job or set in permissions for repository for
Important! Endpoint jobs.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
False
False
False
Named
False
False
Confirm
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 removes the 'Veeam Administrator' encryption key.
The encryption key is obtained by running Get-VBREncryptionKey and piped down.
PS C:\PS> Get-VBREncryptionKey -Description "Veeam Administrator" | RemoveVBREncryptionKey
Example 2
This command removes the 'Veeam Administrator' encryption key.
The encryption key is obtained by running Get-VBREncryptionKey and assigned to the
'$administratorkey' variable.
PS C:\PS> Remove-VBREncryptionKey -EncryptionKey $administratorkey
Remove-VBRFailoverPlan
Short Description
Removes a selected failover plan or a cloud failover plan.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Remove-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRFailoverPlan
Return Type
None
Detailed Description
This cmdlet removes a selected failover plan from Veeam Backup & Replication console and database.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
Accepts VBRFailoverPlan or
VBRCloudFailoverPlan object.
You can remove multiple objects.
WhatIf
False
Named
False
False
Confirm
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 removes failover plan named "MS Exchange Group Failover". The failover plan object is
obtained with Get-VBRFailoverPlan and piped down.
PS C:\PS> Get-VBRFailoverPlan -Name "MS Exchange Group Failover" | RemoveVBRFailoverPlan
Example 2
This command removes failover plan represented by the '$MSExchangeGroup' variable. The failover
plan object is obtained with Get-VBRFailoverPlan and assigned to the variable beforehand.
PS C:\PS> Remove-VBRFailoverPlan -FailoverPlan $MSExchangeGroup
Remove-VBRHvProxy
Short Description
Removes a specified Hyper-V backup proxy from Veeam Backup & Replication.
Applies to
Platform: Hyper-V
For VMware, run Remove-VBRViProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRHvProxy -Proxy <CHvProxy[]> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRHvProxy
Detailed Description
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.
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Proxy
True
Named
True
(ByValue,
ByProperty
Name)
False
WhatIf
False
Named
False
False
Confirm
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 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
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRJob [-Job] <CBackupJob[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
WhatIf
False
Named
False
False
Confirm
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 removes the file copy jobs. The jobs to remove are obtained with Get-VBRJob and
piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VBRJob -Job $job
Remove-VBRJobObject
Short Description
Removes VMs or VM containers from the specified job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRJobObject [-Objects] <CObjectInJob[]> [-Completely] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRJobObject
Detailed Description
This cmdlet allows you to remove VMs or VM containers from existing backup, replication or copy job.
You can remove the objects from job completely or only exclude them from processing.
If you remove the objects completely, they are deleted from job settings and from Veeam
database. Run the cmdlet with the Completely parameter for this.
If you run the cmdlet without the Completely parameter, the job objects are only excluded
from processing but remain in job settings.
Note that Veeam PowerShell does not allow you to include the excluded objects back to the job, you
can do it only with UI.
Parameters
Parameter
Objects
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True (ByValue,
ByProperty
Name)
False
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 removes a 'Fileserver03' VM from the Fileservers Backup Job. The job is obtained with
Get-VBRJob; the VM is obtained with Get-VBRJobObject, the result is piped down.
PS C:\PS> Get-VBRJob -Name "Fileservers Backup Job" | Get-VBRJobObject Name "Fileserver03" | Remove-VBRJobObject
Type
---Exclude
ApproxSize
---------117.1 GB
Location
-------tech.veeam.local...
Example 2
This command completely removes a 'Fileserver03' VM from the Fileservers Backup Job. The job is
obtained with Get-VBRJob; the VM is obtained with Get-VBRJobObject, the result is piped down.
The Completely parameter is used.
PS C:\PS> Get-VBRJob -Name "Fileservers Backup Job" | Get-VBRJobObject Name "Fileserver03" | Remove-VBRJobObject -Completely
Example 3
This command removes Fileserver03 and Fileserver04 VMs from the Fileservers Backup Job.
The job is obtained with Get-VBRJob and assigned to the '$backupjob' variable.
The VMs in job are obtained with Get-VBRJobObject and assigned to the '$jobobject' variable.
Remove-VBRReplica
Short Description
Removes replicated VMs.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRReplica [-Backup] <CBackup[]> [-FromDisk] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRReplica
Detailed Description
This cmdlet removes replicated VMs.
You can use the following options:
Remove from console. When you remove replica from the Veeam console, you will not
delete the VM but only stop managing it with Veeam Backup & Replication. 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. The replica VM stays on target host.
Remove from disk. With this option, the replica is removed from database and from target
host. This removal is complete and non-reversible.
To stop synchronizing a replica without deleting it from the console, you need to disable or delete the
corresponding replication job. Run Disable-VBRJob or Remove-VBRJob.
This cmdlet removes all VMs in the replication job. To remove individual VMs, run RemoveVBRRestorePoint.
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 UI to restore a removed replica.
Parameters
Parameter
Backup
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
FromDisk
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 removes the replicas named "DC_replica01" and "DC_replica02" from Veeam Backup &
Replication. The replicated VMs are obtained with Get-VBRReplica and piped down.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> $replica | Remove-VBRReplica -FromDisk
Remove-VBRRestorePoint
Short Description
Removes individual VMs from backup or replicas.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRRestorePoint [-Oib] <COib[]> [-Name <string[]>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
This cmdlet removes backup of a selected VM(s) or replica.
The backup is removed from disk. If you remove a replica, the replicated VM is removed from
infrastructure.
If you need to remove replicated VM, run Remove-VBRReplica.
This cmdlet removes all restore points of the selected VMs or replicas. You should run removal
Important! procedures carefully considering the subsequent backup jobs that may fail to produce valid backup.
Parameters
Parameter
Oib
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
True
WhatIf
False
Named
False
False
Confirm
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
This command removes backup of VM named "Webserver03".
1.
Run Get-VBRBackup to get the backup containing this VM. Save it to the $backup variable.
2.
3.
Remove-VBRRestoreSession
Short Description
Removes a restore session.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRRestoreSession [-Session] <CRestoreSession[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRRestoreSession
Detailed Description
This cmdlet removes the specified restore session from Veeam Backup & Replication.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Session
True
True
(ByValue,
ByProperty
Name)
False
WhatIf
False
Named
False
False
Confirm
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 removes the last restore session of the VM named "Fileserver". The restore session is
obtained with Get-VBRRestoreSession and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VBRRestoreSession -Session $session
Remove-VBRServer
Short Description
Removes a selected server from Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRServer [-Server] <CHost[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet removes a selected server or host (VMware or Hyper-V) from Veeam Backup & Replication.
You can remove the following servers:
Backup Server: the server where Veeam Backup & Replication is installed.
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.
Note that when you remove servers from your Veeam Backup & Replication managing console, the
backups of the removed hosts stay in the Veeam Backup & Replication database and repository.
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 roles first.
Parameters
Parameter
Server
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
WhatIf
False
Named
False
False
Confirm
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 removes a Virtual Center named "vCenter01". The server is obtained with GetVBRServer, selected by the 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 $server variable. The server object is obtained
with Get-VBRServer and assigned to the variable beforehand.
Remove-VBRServer -Server $server
Remove-VBRTapeLibrary
Short Description
Removes a specified tape library from Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRTapeLibrary -Library <VBRTapeLibrary[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Return Type
None
Detailed Description
This cmdlet removes a specified tape library from Veeam Backup & Replication.
When you remove a tape library, you stop managing it with your Veeam Backup & Replication console.
To remove a tape library, mind the following limitations:
Only the libraries in the offline status can be removed. To remove a tape library, you need to
physically disconnect it from the tape server first. Alternatively, you can remove the tape
server to which the tape library is connected.
You can remove the tape devices that are not used by any tape jobs. If any jobs are using the
media pools assigned to the tape device, first redirect these jobs to other media pools.
Parameters
Parameter
Library
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 removes a tape library named 'HP MSL G3 Series 3.00'. The library object is obtained
with Get-VBRTapeLibrary and piped down.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | RemoveVBRTapeLibrary
Example 2
This command removes a tape library represented by '$SydneyTapeLibrary' variable. The library object
is obtained with Get-VBRTapeLibrary and assigned to the variable beforehand.
PS C:\PS> Remove-VBRTapeLibrary -Library $SydneyTapeLibrary
Remove-VBRTapeMediaPool
Short Description
Removes media pool.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRTapeMediaPool -MediaPool <VBRTapeMediaPool[]> [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRTapeMediaPool
Return Type
None
Detailed Description
This cmdlet removes a selected media pool from Veeam Backup & Replication.
Removing media pools has the following restrictions:
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 removes the media pool named "Winserver MediaPool". The media pool is obtained
with Get-VBRTapeMediaPool and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VBRTapeMediaPool -MediaPool $pool
Remove-VBRTapeMedium
Short Description
Removes the selected tapes from tape catalog.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRTapeMedium -Medium <VBRTapeMedium[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Detailed Description
This cmdlet removes the selected tapes and the data written to the tapes from the tape catalog and
Veeam backup database.
You can remove only offline tapes.
Note:
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Medium
True
Named
False
WhatIf
False
Named
False
False
Confirm
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.
Remove-VBRTapeServer
Short Description
Removes a specified tape server from Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRTapeServer -TapeServer <VBRTapeServer[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRTapeServer
Return Type
None
Detailed Description
This cmdlet removes a specified tape server from Veeam Backup & Replication.
When you remove a tape server, Veeam Backup & Replication unassigns the tape server role from the
server, so it is no longer used as a tape server. The actual server remains connected to Veeam Backup
& Replication.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 removes a tape server named "Sydney_Tape_Server". The tape server is obtained with
Get-VBRTapeServer and piped down.
PS C:\PS> Get-VBRTapeServer -Name "Sydney_Tape_Server" | RemoveVBRTapeServer
Example 2
This command removes tape servers represented by '$SydneyTapeServer' and '$NewYorkTapeServer'
variables. The tape servers are obtained with Get-VBRTapeServer and assigned to the variables
beforehand.
PS C:\PS> Remove-VBRTapeServer -TapeServer $SydneyTapeServer,
$NewYorkTapeServer
Remove-VBRTapeVault
Short Description
Removes a specified tape vault from Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Remove-VBRTapeVault -Vault <VBRTapeVault[]> [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRTapeVault
Return Type
None
Detailed Description
This cmdlet removes a specified tape vault from Veeam Backup & Replication.
When you remove a vault, you do not remove the tapes stored in it.
Parameters
Parameter
Vault
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 removes a tape vault named 'Sydney Remote Storage'. The vault object is obtained
with Get-VBRTapeVault and piped down.
PS C:\PS> Get-VBRTapeVault -Name "Sydney Remote Storage" | RemoveVBRTapeVault
Example 2
This command removes tape vaults represented by '$SydneyRemoteStorage' and
'$NewYorkRemoteStorage' variables. The vaults objects are obtained with Get-VBRTapeVault and
assigned to the variables beforehand.
PS C:\PS> Remove-VBRTapeVault -Vault $SydneyRemoteStorage,
$NewYorkRemoteStorage
Remove-VBRViProxy
Short Description
Removes VMware backup proxy from Veeam Backup & Replication.
Applies to
Platform: VMware
For Hyper-V, run Remove-VBRHvProxy.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Remove-VBRViProxy -Proxy <CViProxy[]> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRViProxy
Detailed Description
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.
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Proxy
True
Named
True
(ByValue,
ByProperty
Name)
False
WhatIf
False
Named
False
False
Confirm
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 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
Platform: VMware, Hyper-V
Product Edition: Enterprise Plus
Syntax
Remove-VBRWANAccelerator -Accelerator <CWanAccelerator>
[<CommonParameters>]
Related Commands
Get-VBRWANAccelerator
Detailed Description
This cmdlet removes the selected WAN accelerator.
When you remove a WAN accelerator, Veeam Backup & Replication unassigns the accelerator role
from the server, so it is no longer used as a WAN accelerator. The actual server remains connected to
Veeam Backup & Replication.
Parameters
Parameter
Description
Required Position
True
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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 removes the WAN Accelerator named "WANAccelerator 1". The accelerator is obtained
with Get-VBRWANAccelerator and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VBRWANAccelerator -Accelerator $a
Remove-VNXHost
Short Description
Removes a EMC VNX storage from Veeam Backup & Replication.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Remove-VNXHost -Host <CVnxHost>
[<CommonParameters>]
Related Commands
Get-VNXHost
Detailed Description
This cmdlet removes a selected EMC VNX storage from Veeam Backup & Replication.
The storage is not deleted from server. When you remove a storage, you stop managing it via your
Veeam Backup & Replication console.
Parameters
Parameter
Storage
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Remove-VNXSnapshot
Short Description
Removes a EMC VNX storage snapshot.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Remove-VNXSnapshot -Snapshot <CSanSnapshot[]>
[<CommonParameters>]
Related Commands
Get-VNXSnapshot
Detailed Description
This cmdlet permanently removes a selected EMC VNX storage snapshot from your storage system.
Parameters
Parameter
Snapshot
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Remove-VSBApplicationGroup
Short Description
Removes a specified application group from Veeam Backup & Replication.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Remove-VSBApplicationGroup [-AppGroup] <CSbAppGroup[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VSBApplicationGroup
Detailed Description
This cmdlet removes a specified application group from Veeam Backup & Replication.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Confirm
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 removes the application groups named "AppGroup 01" and "AppGroup 02". The
application groups are obtained with Get-VSBApplicationGroup and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VSBApplicationGroup -AppGroup $appgroup
Remove-VSBHvVirtualLab
Short Description
Removes a Hyper-V virtual lab.
Applies to
Platform: Hyper-V
For VMware, run Remove-VSBVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Remove-VSBHvVirtualLab [-VirtualLab] <CHvSbVirtualLab[]> [-WarningAction
<ActionPreference>][-WarningVariable <String>] [-WhatIf][Confirm][<CommonParameters>]
Related Commands
Get-VSBHvVirtualLab
Detailed Description
This cmdlet removes a specified Hyper-V virtual lab from Veeam Backup & Replication console.
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. Note that you cannot remove a virtual
lab from server with Veeam PowerShell.
You can add a removed virtual lab to your console by running Connect-VSBHvVirtualLab.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True(ByValue,
ByProperty
Name)
False
WhatIf
False
Named
False
False
Confirm
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 removes a virtual lab named "Virtual Lab 01". The virtual lab object is obtained with
Get-VSBHvVirtualLab and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VSBHvVirtualLab -VirtualLab $vlab
Remove-VSBJob
Short Description
Removes a specified SureBackup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Remove-VSBJob [-Job] <CSbJob[]> [-WarningAction <ActionPreference>] [WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet removes a specified SureBackup job from Veeam Backup & Replication.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
True
Confirm
False
Named
False
True
<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 removes the SureBackup job named "SureJob 01" and "SureJob 12". The SureBackup
jobs are obtained with Get-VSBJob and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VSBJob -Job $surejob
Remove-VSBVirtualLab
Short Description
Removes a specified VMware virtual lab.
Applies to
Platform: VMware
For Hyper-V, run Remove-VSBHvVirtualLab.
Product Edition: Enterprise, Enterprise Plus
Syntax
Remove-VSBVirtualLab [-VirtualLab] <CViSbVirtualLab[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VSBVirtualLab
Detailed Description
This cmdlet removes a specified VMware virtual lab from Veeam Backup & Replication.
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. Note that you cannot remove a virtual
lab from server with Veeam PowerShell.
You can add a removed virtual lab to your console by running Connect-VSBVirtualLab.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Confirm
False
False
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 removes a virtual lab named "Virtual Lab 01". The virtual lab object is obtained with
Get-VSBVirtualLab and piped down.
PS C:\PS> 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.
PS C:\PS> Remove-VSBVirtualLab -VirtualLab $vlab
Rescan-VBREntity
Short Description
Rescans backup infrastructure components.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
[<CommonParameters>]
Related Commands
Get-VBRServer
Get-VBRTapeServer
Get-VBRTapeLibrary
Get-VBRBackupRepository
Get-VBRCloudProvider
Get-VBRReplica
Detailed Description
This cmdlet rescans backup infrastructure components added to Veeam Backup & Replication:
Tape servers
Tape libraries
Backup repositories
Cloud providers
Parameters
Parameter
Entity
Description
Required Position
Accept
Wildcard
Characters
True
Named
True (by
Value
FromPipeline)
False
Accept
Pipeline
Input
CHost (host)
VBRTapeServer (tape server)
VBRTapeLibrary (tape library)
CBackupRepository (backup
repository)
VBRCloudProvider (cloud
provider)
CBackup (only replicas restore
points)
AllReplicas
False
Named
False
False
AllHosts
False
Named
False
False
AllTape
Servers
False
Named
False
False
False
Named
False
False
AllCloud
Providers
False
Named
False
False
Wait
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 rescans servers managed by your Veeam console.
PS C:\PS> Rescan-VBREntity -AllHosts
Example 2
This command rescans a backup repository named "Win2012Repo". The repository is obtained with
Get-VBRBackupRepository and piped down.
PS C:\PS> Get-VBRBackupRepository - Name "Win2012Repo" | Rescan-VBREntity
Example 3
This command rescans the tape server named "srv01.veeam.local". The tape server is obtained with
Get-VBRTapeServer and assigned to the 'tapesrv' variable. The Wait parameter is used to prevent the
console from taking input until the rescanning ends.
PS C:\PS> $tapesrv = Get-VBRTapeServer -Name "srv01.veeam.local"
PS C:\PS> Rescan-VBREntity -Entity $tapesrv -Wait
Example 4
This command updates information about the 'Webservices' replica restore points. The replica is
obtained with Get-VBRReplica and assigned to the '$webservices' variable.
PS C:\PS> $webservices = Get-VBRReplica -Name "Webservices Replica"
PS C:\PS> Rescan-VBREntity -Entity $webservices
Reset-HvVmChangeTracking
Short Description
Clears change tracking data for a specific VM or specific virtual disk (VHD).
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Server
True
False
False
VMName
False
Named
False
False
VhdPath
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 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.
PS C:\PS> 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.
PS C:\PS> Reset-HvVmChangeTracking -Server $server -VhdPath
"C:\Users\Public\Hyper-V\Virtual Hard Disks\hv_dns.vhdx"
Reset-VBRCloudTenant
Short Description
Resets cloud account user license.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Reset-VBRCloudTenant -CloudTenant <VBRCloudTenant[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRCloudTenant
Return Type
None
Detailed Description
This cmdlet resets cloud account user license.
Parameters
Parameter
Cloud
Tenant
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Confirm
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 resets licenses for two cloud user accounts represented by the '$CloudUser1' and
'$CloudUser2' variables.
The cloud user accounts are obtained by Get-VBRCloudTenant and assigned to the variables
beforehand.
PS C:\PS> Reset-VBRCloudTenant -CloudTenant $CloudUser1, $CloudUser2
Example 2
This command resets the ABC company license.
The cloud user account is obtained by running Get-VBRCloudTenant and piped down.
PS C:\PS> Get-VBRCloudTenant -Name "ABC Company" | Reset-VBRCloudTenant
Reset-VBRJobOptions
Short Description
Sets job settings to default.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Reset-VBRJobOptions -Job <CBackupJob> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Reset-VBRJobOptions -Job $job
Reset-VBRJobScheduleOptions
Short Description
Sets job schedule settings to default.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Reset-VBRJobScheduleOptions -Job <CBackupJob> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
True
<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 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.
PS C:\PS> 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.
PS C:\PS> Reset-VBRJobScheduleOptions -Job $job
Reset-VBRJobVssOptions
Short Description
Sets job VSS settings to default.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Reset-VBRJobVssOptions -Job <CBackupJob> [-WarningAction
<ActionPreference>] [-WarningVariable <String>][<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Reset-VBRJobVssOptions -Job $job
Reset-VSBJobOptions
Short Description
Sets SureBackup job settings to default.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Reset-VSBJobOptions -Job <CSbJob> [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet clears the custom settings of the specified SureBackup job and restores their default
values.
Parameters
Parameter
Job
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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.
PS C:\PS> 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.
PS C:\PS> Reset-VSBJobOptions -Job $SureJob
Restart-VBRInstantRecovery
Short Description
Restarts a failed Hyper-V Instant Recovery session.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Restart-VBRInstantRecovery [-InstantRecovery] <InstantRecovery[]> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRInstantRecovery
Detailed Description
This cmdlet restarts a failed Hyper-V Instant Recovery session started with StartVBRHvInstantRecovery.
Run Get-VBRInstantRecovery to get the status of the Instant Recovery session.
Parameters
Parameter
Instant
Recovery
Description
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 restarts the last instant recovery session. The needed session object is obtained with
Get-VBRInstantRecovery, selected by order and piped down.
PS C:\PS> 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.
PS C:\PS> Restart-VBRInstantRecovery -InstantRecovery $"Recovery Session"
Set-NetAppHost
Short Description
Modifies storage.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-NetAppHost -Host <CNaHost> [-Name <String>] [-Description <String>] [UserName <String>] [-Password <String>] [-Credentials <CCredentials>] [IsHTTP [<Boolean>]] [-Port <Int32>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-NetAppHost
Get-VBRCredentials
Detailed Description
This cmdlet modifies a selected storage. To modify settings, you need to enter the corresponding
parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Host
True
Named
False
Name
True
Named
False
False
False
Named
False
False
True
Named
False
False
True
Named
False
False
Password
False
Named
False
False
Port
False
Named
False
False
True
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 changes the storage connection from default to HTTP. The storage is obtained with
Get-NetAppHost and assigned to the '$netapp' variable beforehand.
PS C:\PS> Set-NetAppHost -Host $netapp -IsHTTP "True"
Example 2
This command changes the port to 80. The storage is obtained with Get-NetAppHost and assigned to
the '$netapp' variable beforehand.
PS C:\PS> Set-NetAppHost -Host $netapp -IsHttp $true -Port 80
Set-VBRBackupRepository
Short Description
Modifies a backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRBackupRepository -Repository <CBackupRepository> [-Name <string>] [Description <string>] [-MountServer <CHost>] [-Server <CHost>] [RotatedDrive] [-EnableVPowerNFS] [-VPowerNFSFolder <string>] [-DDServerName
<string>] [-RequireAccessCreds] [-Credentials <CCredentials>] [LimitConcurrentJobs] [-MaxConcurrentJobs <int>] [-LimitDatarate] [DataRateLimit <int>] [-AlignDataBlocks] [-DecompressDataBlocks] [UsePerVMFile] [-DDBoostEncryptionType <VBRDDBoostEncryptionType> {None |
Medium | High}] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Get-VBRServer
Get-VBRCredentials
Detailed Description
This cmdlet modifies a selected backup repository. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
To modify scale-out backup repository, run Set-VBRScaleOutBackupRepository.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Repository
True
Named
False
Name
False
Named
False
False
Description
False
Named
False
False
False
Named
False
False
located.
Use this parameter to explicitly set
the host for the following repository
types:
For the WinLocal type:
indicate the Windows
based server where you
want to create the backup
repository or to which
you want to connect the
rotated drives.
For the LinuxLocal type:
indicate the Linux based
server where you want to
create the backup
repository or to which
you want to connect the
rotated drives.
For the CifsShare,
DataDomain or
HPStoreOnce types:
indicate a Windows based
server that to which the
storage appliance is
connected and which will
be used as a gateway
server.
Default: This server.
Mount
Server
False
Named
False
False
Rotated
Drive
False
Named
False
False
Enable
VPowerNFS
False
Named
False
False
False
Named
False
False
False
Named
False
False
DDServer
Name
Require
Access
Creds
False
Named
False
False
Credentials
False
Named
False
False
Limit
Concurrent
Jobs
False
Named
False
False
Max
Concurrent
Jobs
False
Named
False
False
False
Named
False
False
Data
Rate
Limit
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
DDBoost
Encryption
Type
False
Named
False
False
High
Medium
None.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VBRBackupToTapeJob
Short Description
Modifies backup to tape job or a GFS job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
This cmdlet provides three parameter sets.
For modifying all kinds of tape jobs without editing media poos:
Set-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Name <string>] [Description <string>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [ExportDays <DayOfWeek[]> {Sunday | Monday | Tuesday | Wednesday | Thursday
| Friday | Saturday}] [-FullBackupPolicy <VBRFullBackupToTapePolicy>] [ScheduleOptions <VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod
<timespan>] [-WaitForBackupJob] [-NotificationOptions
<VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [AlwaysCopyFromLatestFull] [-PassThru] [<CommonParameters>]
Set-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Name <string>] [Description <string>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [FullBackupMediaPool <VBRTapeMediaPool>] [-IncrementalBackupMediaPool
<VBRTapeMediaPoolBase>] [-ExportDays <DayOfWeek[]> {Sunday | Monday |
Tuesday | Wednesday | Thursday | Friday | Saturday}] [-FullBackupPolicy
<VBRFullBackupToTapePolicy>] [-ScheduleOptions
<VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod
<timespan>] [-WaitForBackupJob] [-NotificationOptions
<VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [AlwaysCopyFromLatestFull] [-PassThru] [<CommonParameters>]
Set-VBRBackupToTapeJob -Job <VBRBackupToTapeJob> [-Name <string>] [Description <string>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [GFSMediaPool <VBRTapeGFSMediaPool>] [-ExportDays <DayOfWeek[]> {Sunday |
Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [FullBackupPolicy <VBRFullBackupToTapePolicy>] [-ScheduleOptions
<VBRBackupToTapeScheduleOptions>] [-Object <Object[]>] [ProcessIncrementalBackup] [-UseHardwareCompression] [-WaitPeriod
<timespan>] [-WaitForBackupJob] [-NotificationOptions
<VBRNotificationOptions>] [-JobScriptOptions <VBRJobScriptOptions>] [AlwaysCopyFromLatestFull] [-GFSScheduleOptions <VBRTapeGFSScheduleOptions>]
[-PassThru] [<CommonParameters>]
Related Commands
Get-VBRJob
Get-VBREPJob
Get-VBRBackupRepository
Get-VBRTapeMediaPool
New-VBRFullBackupToTapePolicy
New-VBRBackupToTapeScheduleOptions
Get-VBRBackupRepository
New-VBRNotificationOptions
New-VBRJobScriptOptions
Return Type
VBRBackupToTapeJob
Detailed Description
This cmdlet modifies a selected backup to tape job or a GFS job. To modify settings, you need to enter
the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Job
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Description
Eject
Current
Medium
Export
Current
MediaSet
Full
Backup
Media
Pool
Incremental
Backup
Media
Pool
True
Named
False
False
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
GFSMedia
Pool
ExportDays
Schedule
Options
Object
Enabled: False.
Type: Daily.
DailyOptions: Type: SelectedDays,
Period: 18:00, DayOfWeek: Saturday.
MonthlyOptions: Period: 22:00,
DayNumberInMonth: Fourth,
DayOfWeek: Saturday, Months:
January, February, March, April,
May, June, July, August, September,
October, November, December.
ScheduleOptions: From Sunday to
Saturday, from 00:00 to 23:00,
Enabled: True.
JobId: Null.
Process
Incremental
Backup
the IncrementalBackupMediaPool
parameter, incremental backups will be stored
to the media pool the you set for full backups.
UseHardware Indicates that tape library must perform
Compression hardware compression for archives. Do not use
this option for archiving Veeam backups or
other already compressed files.
False
Named
False
False
WaitPeriod
False
Named
False
False
WaitFor
BackupJob
False
Named
False
False
Notification
Options
False
Named
False
False
JobScript
Options
False
Named
False
False
AlwaysCopy
FromLatest
Full
False
Named
False
False
GFS
Schedule
Options
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
This command sets a new media pool for the incremental backups.
1.
2.
Run Set-VBRBackupToTapeJob. Get the job with Get-VBRTapeJob and pipe it down. Use the
$newpool variable.
Set-VBRBackupWindowOptions
Short Description
Modifies the VBRBackupWindowOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRBackupWindowOptions -Options <VBRBackupWindowOptions> -FromDay
<DayOfWeek> -FromHour <Int32> -ToDay <DayOfWeek> -ToHour <Int32> -Enabled
[-PassThru] [-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
None
Return Type
VBRBackupWindowOptions
Detailed Description
This cmdlet modifies the VBRBackupWindowOptions object that was created earlier. To modify
settings, you need to enter the corresponding parameters with new values. The parameters that you
omit will remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Options
Specifies the
VBRBackupWindowOptions you want
to modify.
True
Named
False
FromDay
False
Named
False
False
False
Named
False
False
False
Named
False
False
ToDay
False
Named
False
False
False
Named
False
False
False
Named
False
False
Default: False.
PassThru
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VBRCloudFailoverPlanObject
Short Description
Modifies a selected failover plan object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VBRCloudFailoverPlanObject -Object <VBRCloudFailoverPlanObject> [BootOrder <int>] [-BootDelay <int>] [-PublicIpRule
<VBRFailoverPlanPublicIPRule[]>] [<CommonParameters>]
Related Commands
Get-VBRFailoverPlan
Return Type
VBRCloudFailoverPlanObject
Detailed Description
This cmdlet modifies a selected failover plan object. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Object
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
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.
Set-VBRCloudGateway
Short Description
Modifies a selected cloud gateway.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Set-VBRCloudGateway -CloudGateway <VBRCloudGateway> [-Description <String>]
[-IpAddress <String>] [-IncomingPort <Int32>] [-NATPort <Int32>] [PassThru] [-NetworkMode <VBRGatewayNetworkMode>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRCloudGateway
Return Type
Get-VBRCloudGateway
Detailed Description
This cmdlet modifies existing cloud gateway. To modify settings, you need to enter the corresponding
parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Cloud
Gateway
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Accept
Pipeline
Input
Incoming
Port
to the gateway.
Accepts int type.
Permitted values: 1 to 65535.
Default: 6180.
NAT
Port
False
Named
False
False
False
Named
False
False
PassThru
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 sets a new port for the cloud gateway to connect to Veeam Backup & Replication.
Example 2
This command sets a new cloud gateway IP address and port to connect to Veeam Backup &
Replication.
Set-VBRCloudProvider
Short Description
Modifies service provider.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Set-VBRCloudProvider -CloudProvider <VBRCloudProvider> [-Address <string>]
[-Description <string>] [-Port <int>] [-Credentials <CCredentials>] [PassThru] [-Appliance <VBRCloudProviderNetworkAppliance[]>] [VerifyCertificate] [-CertificateThumbprint <string>] [InstallManagementAgent] [-Force] [<CommonParameters>]
Related Commands
Get-VBRCredentials
Get-VBRCloudProvider
Return Type
VBRCloudProvider
Detailed Description
This cmdlet modifies service provider added to Veeam Backup & Replication. To modify settings, you
need to enter the corresponding parameters with new values. The parameters that you omit will
remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Cloud
Provider
True
Named
True (by
Value
FromPipeline,
ValueFrom
Pipeline
ByProperty
Name)
False
Address
True
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Appliance
Verify
Certificate
Certificate
Thumbprint
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 enables the SSL certificate verification for a service provider represented by the
'$CloudProvider1' variable.
The VerifyCertificate parameter is used to enable the SSL certificate verification with
thumbprints. The thumbprint is 'e6 c0 e5 1a db 73 0c 13 b3 c3 74 d4 ee 93 ab d0 08 3f 7a a8'.
Example 2
This command sets the cloud gateway port to the default value.
| Set-
Set-VBRCloudProviderNetworkAppliance
Short Description
Modifies a selected network extension appliance on the user side.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides three parameter sets.
Set-VBRCloudProviderNetworkAppliance -NetworkAppliance
<VBRCloudProviderNetworkAppliance> [-Server <CHost>] [-Network
<IVBRServerNetworkInfo>] [-IpAddress <string>] [-SubnetMask <string>] [DefaultGateway <string>] [<CommonParameters>]
Set-VBRCloudProviderNetworkAppliance -NetworkAppliance
<VBRCloudProviderNetworkAppliance> [-Server <CHost>] [-ResourcePool
<CViResourcePoolItem>] [-Network <IVBRServerNetworkInfo>] [-IpAddress
<string>] [-SubnetMask <string>] [-DefaultGateway <string>] [-Datastore
<VBRViDatastore>] [<CommonParameters>]
Set-VBRCloudProviderNetworkAppliance -NetworkAppliance
<VBRCloudProviderNetworkAppliance> [-Server <CHost>] [-Network
<IVBRServerNetworkInfo>] [-IpAddress <string>] [-SubnetMask <string>] [DefaultGateway <string>] [-Folder <string>] [-VLanId <int>]
[<CommonParameters>]
Related Commands
Get-VBRServer
Get-VBRHvServerNetworkInfo
Get-VBRViServerNetworkInfo
Find-VBRViResourcePool
Find-VBRViDatastore
Return Type
VBRViCloudProviderNetworkAppliance
VBRHvCloudProviderNetworkAppliance
Detailed Description
This cmdlet modifies a selected VMware or a Hyper-V network extension appliance on the user's cloud
host. To modify settings, you need to enter the corresponding parameters with new values. The
parameters that you omit will remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
Network
Appliance
True
Named
False
False
Server
True
Named
False
False
Network
False
Named
False
False
IpAddress
False
Named
False
False
Subnet
Mask
False
Named
False
False
Default
Gateway
False
Named
False
False
Resource
Pool
False
Named
False
False
Datastore
False
Named
False
False
Folder
False
Named
False
False
VLanId
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.
Set-VBRCloudTenant
Short Description
Modifies cloud user account settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a cloud provider license.
Syntax
Set-VBRCloudTenant -CloudTenant <VBRCloudTenant> [-Name <string>] [Description <string>] [-EnableLeaseExpiration] [-LeaseExpirationDate
<datetime>] [-Password <string>] [-Resources <VBRCloudTenantResource[]>] [HashedPassword] [-EnableResources] [-EnableReplicationResorces] [ReplicationResources <VBRCloudTenantReplicationResources>] [EnableThrottling] [-ThrottlingValue <decimal>] [-ThrottlingUnit
<VBRSpeedUnit> {MbitPerSec | MbytePerSec | KbytePerSec}] [-PassThru]
[<CommonParameters>]
Related Commands
Get-VBRCloudTenant
New-VBRCloudTenantResource
New-VBRCloudTenantReplicationResources
Return Type
VBRCloudTenant
Detailed Description
This cmdlet modifies user account settings.
To modify settings, you need to enter the corresponding parameters with new values. The parameters
that you omit will remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Cloud
Tenant
True
Named
False
Name
False
Named
False
False
following requirements:
False
Named
False
False
False
Named
False
False
Lease
Expiration
Date
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Resources
Hashed
Password
Enable
Resources
False
Named
False
False
Enable
Replication
Resorces
False
Named
False
False
Enable
Throttling
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Throttling
Unit
Replication
Resources
PassThru
<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 sets a new password for the cloud user account represented by the '$CloudUser1'
variable.
Example 2
This command disables lease expiration settings for the ABC company user account.
The EnableLeaseExpiration parameter is set to false to discard the set lease period.
Set-VBRCloudTenantNetworkAppliance
Short Description
Modifies the network extension appliance.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
This cmdlet provides two parameter sets.
Set-VBRCloudTenantNetworkAppliance -Appliance
<VBRCloudTenantNetworkAppliance> [-Name <string>] [-ProductionNetwork
<IVBRServerNetworkInfo>] [-ObtainIpAddressAutomatically]
[<CommonParameters>]
Set-VBRCloudTenantNetworkAppliance -Appliance
<VBRCloudTenantNetworkAppliance> -IpAddress <ipaddress> -DefaultGateway
<ipaddress> -SubnetMask <string> [-Name <string>] [-ProductionNetwork
<IVBRServerNetworkInfo>] [<CommonParameters>]
Related Commands
Get-VBRCloudTenantNetworkAppliance
Get-VBRHvServerNetworkInfo
Get-VBRViServerNetworkInfo
Return Type
VBRCloudTenantNetworkAppliance
Detailed Description
This cmdlet modifies a selected network extension appliance. To modify settings, you need to enter
the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Appliance
True
Named
False
Name
False
Named
False
False
Production
Network
False
Named
False
False
False
Named
False
False
IpAddress
True
Named
False
False
Default
Gateway
True
Named
False
False
Subnet
Mask
True
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.
Set-VBRCloudTenantResource
Short Description
Modifies user's backup resources settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRCloudTenantResource -CloudTenantResource <VBRCloudTenantResource> [Repository <CBackupRepository>] [-RepositoryFriendlyName <string>] [-Quota
<int>] [-EnableWanAccelerator] [-WanAccelerator <CWanAccelerator>]
[<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Get-VBRWANAccelerator
Return Type
VBRCloudTenantResource
Detailed Description
This cmdlet modifies the VBRCloudTenantResource object containing the backup resources for a user.
To modify settings, you need to enter the corresponding parameters with new values. The parameters
that you omit will remain unchanged.
Parameters
Parameter
Description
Cloud
Tenant
Resource
Repository
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
True
Named
False
False
True
Named
False
False
True
Named
False
False
Quota
True
Named
False
False
False
Named
False
False
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.
Set-VBRCloudVLANConfiguration
Short Description
Modifies a selected VLAN.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides 3 parameter sets.
Set-VBRCloudVLANConfiguration -Configuration <VBRCloudVLANConfiguration> [FirstVLANWithInternet <int>] [-LastVLANWithInternet <int>] [FirstVLANWithoutInternet <int>] [-LastVLANWithoutInternet <int>] [PassThru] [<CommonParameters>]
For VMware:
Set-VBRCloudVLANConfiguration -Configuration <VBRCloudVLANConfiguration> [ViVirtualSwitch <VBRViVirtualSwitch>] [-FirstVLANWithInternet <int>] [LastVLANWithInternet <int>] [-FirstVLANWithoutInternet <int>] [LastVLANWithoutInternet <int>] [-PassThru] [<CommonParameters>]
For Hyper-V:
Set-VBRCloudVLANConfiguration -Configuration <VBRCloudVLANConfiguration> [HvNetworkInfo <VBRHvServerNetworkInfo>] [-FirstVLANWithInternet <int>] [LastVLANWithInternet <int>] [-FirstVLANWithoutInternet <int>] [LastVLANWithoutInternet <int>] [-PassThru] [<CommonParameters>]
Related Commands
Get-VBRCloudVLANConfiguration
Get-VBRViVirtualSwitch
Get-VBRHvServerNetworkInfo
Return Type
VBRCloudVLANConfiguration
Detailed Description
This cmdlet modifies a selected VLAN configuration.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
ViVirtual
Switch
True
Named
False
False
HvNetwork
Info
True
Named
False
False
FirstVLAN
WithInternet
True
Named
False
False
LastVLAN
WithInternet
True
Named
False
False
FirstVLAN
Without
Internet
True
Named
False
False
LastVLAN
Without
Internet
True
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.
Set-VBRConfigurationBackupJob
Short Description
Modifies the configuration backup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRConfigurationBackupJob [-Enable] [-Repository <CBackupRepository>]
[-ScheduleOptions <VBRConfigurationBackupScheduleOptions>] [RestorePointsToKeep <int>] [-EnableEncryption] [-EncryptionKey
<VBREncryptionKey>] [-PassThru] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
New-VBRConfigurationBackupScheduleOptions
Get-VBREncryptionKey
Return Type
VBRConfigurationBackupJob
Detailed Description
This cmdlet modifies settings of the configuration backup job. To modify settings, you need to enter
the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Enable
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
Named
False
False
False
Named
False
False
False
Named
False
False
Schedule
Options
Accepts
VBRConfigurationBackupScheduleOptions
object.
RestorePoints Specifies the number of restore points you
want to keep on disk.
ToKeep
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Encryption
Key
PassThru
<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 disables the configuration backup job.
PS C:\PS> Set-VBRConfigurationBackupJob -Enable:$False
Example 2
This command modifies the configuration backup schedule and enables encryption. The job is set to
run at 00:00 every Saturday.
Run New-VBRDailyOptions to create an object with settings for the Daily type. Save the result
to the "$daily" variable.
Run Get-VBREncryptionKey to create an object that contains the encryption key. Save it to the
"$encryptionkey" variable.
Set-VBRCredentials
Short Description
Edits credentials records properties.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRCredentials -Credential <CCredentials> -Password <string>
[<CommonParameters>]
-ORSet-VBRCredentials -Credential <CCredentials> -Description <string>
[<CommonParameters>]
Related Commands
Get-VBRCredentials
Detailed Description
This cmdlet allows editing password or description of a selected credentials record. Select the
appropriate syntax for each case.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Credential
True
Named
False
User
True
Named
False
False
True
Named
False
False
Description
False
Named
False
False
although it is recommended to
input this value to make the
credential records easily
identified.
SshPort
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
AddToSudoers
RootPassword
<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 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.
PS C:\PS> 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.
PS C:\PS> Set-VBRCredentials -Credential $c -Description "ESXi Host
Credentials"
Set-VBRDefaultGateway
Short Description
Modifies the default gateway.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRDefaultGateway -Gateway <VBRDefaultGateway> [-IpAddress <string>] [NetworkMask <string>] [<CommonParameters>]
Related Commands
Set-VBRDefaultGatewayConfiguration
Return Type
VBRDefaultGateway
Detailed Description
This cmdlet modifies the default cloud gateway.
Parameters
Parameter
Gateway
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
PassThru
False
Named
False
False
Accepts VBRDefaultGateway
object.
IpAddress
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VBRDefaultGatewayConfiguration
Short Description
Modifies configuration of default gateways.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRDefaultGatewayConfiguration -Configuration
<VBRDefaultGatewayConfiguration> [-EnableRouting] [-PassThru]
[<CommonParameters>]
Related Commands
Get-VBRDefaultGatewayConfiguration
Return Type
VBRDefaultGatewayConfiguration[]
Detailed Description
This cmdlet modifies settings of the default gateway. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Configuration
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
PassThru
False
Named
False
False
Accepts
VBRDefaultGatewayConfiguration
object.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VBREncryptionKey
Short Description
Modifies encryption key.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBREncryptionKey -EncryptionKey <PSCryptoKey> [-Password
<securestring>] [-Description <string>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBREncryptionKey
Return Type
PSCryptoKey
Detailed Description
This cmdlet modifies encryption key that was created before. To modify settings, you need to enter
the corresponding parameters with new values. The parameters that you omit will remain unchanged.
This cmdlet accepts SecureString type. Use Microsoft PowerShell standard capabilities to convert your
password into the SecureString.
Parameters
Parameter
Description
Required Position
Accept
Wildcard
Characters
False
False
Named
False
False
Accept
Pipeline
Input
False
Named
False
False
WhatIf
False
Named
False
False
action.
Confirm
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 modifies description of the 'Veeam Administrator' encryption key.
PS C:\PS> Get-VBREncryptionKey -Description "Veeam Administrator" | SetVBREncryptionKey -Description "Veeam Tape Backup Administrator"
Example 2
This command sets a new password to the 'Veeam Administrator' encryption key.
Set-VBREPPermission
Short Description
Applies user access permissions to backup repositories used by Endpoint backup jobs.
Syntax
Set-VBREPPermission -Repository <CBackupRepository> [-Type
<VBREPPermissionType> {Everyone | NoOne | OnlySelectedUsers}] [-User
<string[]>] [-EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [PassThru] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Get-VBREncryptionKey
Return Type
VBREPPermission
Detailed Description
This cmdlet applies user access permissions to a selected repository for writing Endpoint backup jobs
data.
By default, the backup repositories are configured to have no permissions for writing Endpoint
backups. To start using a Veeam backup repository as target for Endpoint backups, you need to
change the access permissions to Everyone or OnlySelectedUsers. The OnlySelectedUsers option
allows you to submit usernames or names of Active Directory groups.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
User
False
Named
False
False
False
Named
False
False
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 sets permission to access WinLocal repository to administrator.
The type of permission is set to 'OnlySelectedUsers' and the User parameter is used to
indicate the Veeam administrators as permitted users.
:
:
:
:
:
88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
OnlySelectedUsers
{VEEAM\Administrator1, VEEAM\Administrator2}
False
Example 2
This command enables encryption for WinLocal repository.
The EnableEncryption switch and the EncryptionKey parameter are used to enable
encryption.
:
:
:
:
:
88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
OnlySelectedUsers
{VEEAM\Administrator}
True
ac87709d-b1a9-4c2e-8d55-557f8e49f639
Example 3
This command sets both user access permissions and encryption for WinLocal repository.
The EnableEncryption switch and the EncryptionKey parameter with the '$encryptionkey'
variable are used to enable encryption.
:
:
:
:
:
88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
Everyone
{VEEAM\Administrator}
True
ac87709d-b1a9-4c2e-8d55-557f8e49f639
Set-VBRFailoverPlan
Short Description
Modifies a selected failover plan or cloud failover plan.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan> [-Name <string>] [Description <string>] [-FailoverPlanObject <VBRFailoverPlanObject[]>] [PrefailoverCommand <string>] [-PostfailoverCommand <string>] [EnablePublicIpRule] [-PassThru] [<CommonParameters>]
Related Commands
New-VBRFailoverPlanObject
Return Type
VBRFailoverPlan
Detailed Description
This cmdlet modifies settings of an existing failover plan or cloud failover plan. To modify settings, you
need to enter the corresponding parameters with new values. The parameters that you omit will
remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
Accepts VBRFailoverPlan or
VBRCloudFailoverPlan object.
Name
False
Named
False
False
Failover
Plan
Object
False
Named
False
False
False
Named
False
False
Accepts VBRFailoverPlanObject or
VBRCloudFailoverPlanObject object.
You can assign multiple VMs to this
object.
Description
Prefailover
Command
False
Named
False
False
Postfailover
Command
False
Named
False
False
Enable
Public
IpRule
False
Named
False
False
PassThru
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 adds a pre-failover script to an existing failover plan named "MS Exchange Group
Failover".
The failover plan object is obtained with Get-VBRFailoverPlan and piped down.
The -PrefailoverCommand parameter is set to add the path to the script to the failover plan.
The other settings of the 'MS Exchange Group Failover' plan will remain unchanged.
Example 2
This command adds one more Microsoft Exchange server to the failover plan named "MS Exchange
Group Failover".
The new server object is assigned to the '$MSExchangeServer03' variable by running NewVBRFailoverPlanObject beforehand.
The objects of the failover plan (VMs added to the failover plan) are assigned to the
'$MSExchangeGroup' variable. The new server object is added to it.
The Set-VBRFailoverPlan command is run with the updated list of failover plan objects and a
new description. The other settings of the 'MS Exchange Group Failover' plan will remain
unchanged.
Set-VBRFailoverPlanObject
Short Description
Modifies the VBRFailoverPlanObject object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VBRFailoverPlanObject -Object <VBRFailoverPlanObject> [-BootOrder
<int>] [-BootDelay <int>] [<CommonParameters>]
Related Commands
None
Return Type
VBRFailoverPlanObject
Detailed Description
This cmdlet modifies the VBRFailoverPlanObject object that was created earlier. To modify settings,
you need to enter the corresponding parameters with new values. The parameters that you omit will
remain unchanged.
Parameters
Parameter
Object
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
False
Named
False
False
False
Named
False
False
Accepts VBRFailoverPlanObject.
<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 sets a new boot delay value for the Microsoft Exchange server that was earlier assigned
to the '$MSExchange01' variable.
Example 2
This command sets a new boot delay value for the Microsoft Exchange server that was earlier assigned
to the '$MSExchange01' variable.
Set-VBRFileToTapeJob
Short Description
Modifies file to tape job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRFileToTapeJob -Job <VBRFileToTapeJob> [-Name <String>] [-Description
<String>] [-EjectCurrentMedium] [-ExportCurrentMediaSet] [FullBackupMediaPool <VBRTapeMediaPool>] [-IncrementalBackupMediaPool
<VBRTapeMediaPool>] [-ExportDays <DayOfWeek[]>] [-FullBackupPolicy
<VBRFileToTapeBackupPolicy>] [-IncrementalBackupPolicy
<VBRFileToTapeBackupPolicy>] [-Object <VBRFileToTapeObject[]>] [-UseVSS] [UseHardwareCompression] [-NotificationOptions] [-JobScriptOptions] [PassThru] [-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRTapeJob
Get-VBRTapeMediaPool
New-VBRFileToTapeBackupPolicy
New-VBRFileToTapeObject
Return Type
VBRFileToTapeJob
Detailed Description
This cmdlet modifies a selected file to tape job that was created before. To modify settings, you need
to enter the corresponding parameters with new values. The parameters that you omit will remain
unchanged.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
True
Named
False
False
Accepts VBRFileToTapeJob or
TapeJob objects, GUID or string
type.
Name
Accept
Pipeline
Input
False
Named
False
False
False
Named
False
False
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Export
Current
MediaSet
FullBackup
MediaPool
Incremental
Backup
MediaPool
ExportDays
FullBackup
Policy
Incremental
Backup
Policy
Type: Daily
DailyOptions: Type:
SelectedDays, Period:
18:00, DayOfWeek:
Saturday
MonthlyOptions: Period:
22:00,
DayNumberInMonth:
Fourth, DayOfWeek:
Saturday, Months:
January, February, March,
April, May, June, July,
August, September,
October, November,
December
Enabled: false
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Notification
Options
False
Named
False
False
Accepts VBRFileToTapeBackupPolicy
object.
Default:
Object
Type: Daily.
DailyOptions: Type:
SelectedDays, Period:
18:00, DayOfWeek:
Saturday.
MonthlyOptions: Period:
22:00,
DayNumberInMonth:
Fourth, DayOfWeek:
Saturday, Months:
January, February, March,
April, May, June, July,
August, September,
October, November,
December.
Enabled: False.
UseVSS
object.
JobScript
Options
False
Named
False
False
Accepts VBRJobScriptOptions
object.
<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 sets a new media pool for the full backups.
1.
2.
Run Set-VBRBackupToTapeJob. Get the job with Get-VBRTapeJob and pipe it down. Use the
$newpool variable.
Set-VBRHvCloudHardwarePlan
Short Description
Modifies a selected Hyper-V hardware plan.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Set-VBRHvCloudHardwarePlan -HardwarePlan <VBRHvCloudHardwarePlan> [-Name
<String>] [-Description <String>] [-Server <CHost>] [-CPU <Int32>] [-Memory
<Int32>] [-NumberOfNetWithInternet <Int32>] [-NumberOfNetWithoutInternet
<Int32>] [-Datastore <VBRHvCloudHardwarePlanDatastore[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-PipelineVariable
<String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRHvCloudHardwarePlan
Detailed Description
This cmdlet modifies settings of an existing hardware plan. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Hardware
Plan
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
Server
False
Named
False
False
CPU
False
Named
False
False
Memory
False
Named
False
False
Number
OfNetWith
Internet
False
Named
False
False
Number
OfNet
Without
Internet
False
Named
False
False
Datastore
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.
Set-VBRHvCloudReplicaJob
Short Description
Modifies a Hyper-V cloud replication job.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRHvCloudReplicaJob -Job <CBackupJob> [-Name <string>] [-Datastore
<VBRCloudDatastore>] [-Entity <IHvItem[]>] [-Suffix <string>] [-Description
<string>] [-SourceRepository <CBackupRepository[]>] [-BackupRepository
<CBackupRepository>] [-EnableNetworkMapping] [-SourceNetwork
<VBRHvServerNetworkInfo[]>] [-TargetNetwork <VBRCloudServerNetworkInfo[]>]
[-EnableReIp] [-ReIpRule <VBRHvReplicaReIpRule[]>] [-UseWANAccelerator] [SourceWANAccelerator <CWanAccelerator>] [-SourceProxy <CHvProxy[]>]
[<CommonParameters>]
Related Commands
Get-VBRJob
Get-VBRCloudServer
Get-VBRCloudDatastore
Find-VBRHvEntity
Get-VBRBackupRepository
Get-VBRHvServerNetworkInfo
Get-VBRCloudServerNetworkInfo
Get-VBRWANAccelerator
Get-VBRHvProxy
Detailed Description
This cmdlet modifies an existing Hyper-V cloud replication job. To modify settings, you need to enter
the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Accept
Pipeline
Input
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Suffix
Source
Repository
Backup
Repository
False
Named
False
False
Source
Network
False
Named
False
False
Target
Network
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
ReIpRule
Source
Proxy
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VBRJobAdvancedBackupOptions
Short Description
Customizes advanced job backup settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet sets advanced backup options for the selected job.
You can select backup method: reverse incremental or incremental, 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.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Accept
Pipeline
Input
False
Named
False
False
False
Named
False
False
Transform
Increments
ToSyntethic
TransformTo
SyntethicDays
False
Named
False
False
Enable
FullBackup
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Months
DayOfWeek
<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 sets the following backup options for the backup job represented by the $job variable:
The job object is obtained with Get-VBRJob, assigned to the variable beforehand and piped down.
PS C:\PS> $job | Set-VBRJobAdvancedBackupOptions -Algorithm
ReverseIncremental -FullBackupScheduleKind Monthly
Example 2
This command sets the following backup options for all backup jobs:
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.
PS C:\PS> 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
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobAdvancedHvOptions -Job <CBackupJob[]> [-CanDoCrashConsistent
<bool>] [-EnableHvQuiescence <bool>] [-UseChangeTracking <bool>] [ExcludeSwapFile <bool>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Accept
Pipeline
Input
Default: FALSE.
EnableHv
Quiescence
UseChange
Tracking
Exclude
SwapFile
False
Named
False
False
Default: TRUE.
<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 edits advanced job settings to backup job named "Backup Job 01":
Set-VBRJobAdvancedNotificationOptions
Short Description
Customizes job notification settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobAdvancedNotificationOptions -Job <CBackupJob[]> [SnmpNotification <bool>] [-EmailNotificationAddresses <string>] [EmailNotification <bool>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet sets notification options for the selected job.
You can set SNMP and email notifications on job run results.
Email notification can be configured for jobs only in case that the global email notifications are
Important! enabled. Note that you cannot enable the global email notifications with Veeam PowerShell. Read
more about job notification settings in Veeam Backup & Replication user guide at
http://www.veeam.com/vmware-backup/help-center.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
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 sets SNMP and email notifications for the backup job named "Backup Job 01". The job
object is obtained with Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "Backup Job 01" | SetVBRJobAdvancedNotificationOptions -SnmpNotification $True EmailNotification $True -EmailNotificationAddresses
"administrator@veeam.com"
Example 2
This command turns off the previously set email notification for the backup job named "Backup Job
01". The job object is obtained with Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "Backup Job 01" | SetVBRJobAdvancedNotificationOptions -EmailNotification $False
Set-VBRJobAdvancedOptions
Short Description
Customizes advanced job settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobAdvancedOptions -Job <CBackupJob[]> [-Periodicity
<CDomJobScriptCommand+PeriodicityType>] [-Frequency <UInt32>] [-Enabled
[<Boolean>]] [-Days <DayOfWeek[]>] [-CommandLine <String>] [EnablePreScript [<Boolean>]] [-PreJobScript <String>] [EnableIntegrityChecks [<Boolean>]] [-RetainDays <Int32>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Accept
Pipeline
Input
Default: TRUE.
RetainDays
False
Named
False
False
Enabled
False
Named
False
False
False
Named
False
False
False
Named
False
False
Periodicity
False
Named
False
False
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 edits advanced job settings to backup job named "Backup Job 01":
Example 2
This command edits advanced job settings to backup job named "Backup Job 01":
The post job activity is enabled to run the "report.exe" command periodically after every fifth
job run.
Set-VBRJobAdvancedStorageOptions
Short Description
Customizes advanced job storage settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobAdvancedStorageOptions -Job <CBackupJob[]> [-EnableDeduplication
[<Boolean>]] [-CompressionLevel <Int32>] [-StorageBlockSize <EKbBlockSize>]
[-WarningAction <ActionPreference>] [-WarningVariable
<String>][<CommonParameters>]
Related Commands
Get-VBRJob
Get-VBREncryptionKey
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Compression
Level
False
Named
False
False
False
Named
False
False
0 = KbBlockSize256,
1 = KbBlockSize512,
3 = KbBlockSize1024,
4 = KbBlockSize2048,
5 = KbBlockSize4096,
6 = KbBlockSize8192,
7= Automatic.
Enable
Encryption
False
Named
False
False
Encryption
Key
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 edits advanced storage settings for the backup jobs named "Backup Job 01" and
"Backup Job 02".
Example 2
This command applies the optimal compression level (=5) to all jobs. The jobs are obtained with GetVBRJob and piped down.
PS C:\PS> Get-VBRJob | Set-VBRJobAdvancedStorageOptions -CompressionLevel 5
Set-VBRJobAdvancedViOptions
Short Description
Customizes VMware job settings.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobAdvancedViOptions -Job <CBackupJob[]> [-ExcludeSwapFile
[<Boolean>]] [-VmAttributeName <String>] [-SetResultsToVmAttribute
[<Boolean>]] [-EnableChangeTracking [<Boolean>]] [-UseChangeTracking
[<Boolean>]] [-VMToolsQuiesce [<Boolean>]] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
SetResults
ToVm
Attribute
False
Named
False
False
Enable
Change
Tracking
False
Named
False
False
Use
False
Named
False
False
Default: TRUE.
Change
Tracking
VMTools
Quiesce
False
Named
False
False
Default: 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
This command edits advanced job settings to backup job named "Backup Job 01":
Set-VBRJobObjectVssOptions
Short Description
Customizes job VSS settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Run Set-VBRJobVssOptions to set the VSS options to the whole job.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Object
True
True
(ByValue,
ByProperty
Name)
False
Options
True
False
False
True
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 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.
PS C:\PS> Get-VBRJob -Name "Active Directory Backup" | Get-VBRJobObject Name "AD_01" | Set-VBRJobObjectVssOptions -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.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> Set-VBRJobObjectVssOptions -Object $"SharePoint_SQL" -Credentials
$"Administrator"
Set-VBRJobOptions
Short Description
Applies custom job settings.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobOptions [-Job] <CBackupJob[]> [-Options] <CJobOptions> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRJob
New-VBRJobOptions
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Job
True
True
(ByValue,
ByProperty
Name)
False
Options
True
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 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.
PS C:\PS> 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.
PS C:\PS> Set-VBRJobOptions -Job $job -Options $options
Set-VBRJobProxy
Short Description
Assigns a specific proxy to a job or enables automatic proxy selection.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
If you want to set a custom proxy you should make sure that the proxy server is added to Veeam
Important! 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
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
False
False
Target
False
Named
False
False
True
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 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" | Set-VBRJobProxy -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" | Set-VBRJobProxy AutoDetect
Set-VBRJobSchedule
Short Description
Sets job schedule options.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobSchedule -Job <CBackupJob> [-Daily] [-At <datetime>] [-DailyKind
<DailyKinds> {Everyday | WeekDays | SelectedDays}] [-Days <DayOfWeek[]>
{Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}]
[<CommonParameters>]
-ORSet-VBRJobSchedule -Job <CBackupJob> [-At <datetime>] [-Days <DayOfWeek[]>
{Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday}] [Monthly] [-NumberInMonth <EDayNumberInMonth> {First | Second | Third |
Fourth | Last | OnDay}] [-Months <EMonth[]> {January | February | March |
April | May | June | July | August | September | October | November |
December}] [-DayOfMonth <string>] [<CommonParameters>]
-ORSet-VBRJobSchedule -Job <CBackupJob> [-Periodicaly] [-FullPeriod <int>] [PeriodicallyKind <VBRPeriodicallyKinds> {Hours | Minutes | Continuously}]
[-PeriodicallySchedule <VBRBackupWindowOptions>] [-PeriodicallyOffset
<int>] [<CommonParameters>]
-ORSet-VBRJobSchedule -Job <CBackupJob> [-After] [-AfterJob <CBackupJob>]
[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet sets custom schedule settings to the selected job.
You can schedule the job to run:
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Daily
Accept
Pipeline
Input
DailyKind
Days
At
Days
Number
InMonth
Monthly
Months
Periodicaly
FullPeriod
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
AfterJob
<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 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.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> 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.
PS C:\PS> 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
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobScheduleOptions [-Job] <CBackupJob[]> [-Options]
<ScheduleOptions> [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [<CommonParameters>]
Related Commands
Get-VBRJob
New-VBRJobScheduleOptions
Detailed Description
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.
Run Set-VSBJobScheduleOptions to set scheduling options to SureBackup job.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
True
False
False
Accept
Pipeline
Input
<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 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.
PS C:\PS> 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.
PS C:\PS> Set-VBRJobScheduleOptions -Job $job -Options $"Schedule Options"
Set-VBRJobVssOptions
Short Description
Applies custom VSS settings to a selected job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRJobVssOptions [-Job] <CBackupJob[]> [-Options]
<CGuestProcessingOptions> [<CommonParameters>]
-ORSet-VBRJobVssOptions [-Job] <CBackupJob[]> -Credentials <CCredentials>
[<CommonParameters>]
Related Commands
Get-VBRJob
New-VBRJobVssOptions
Get-VBRCredentials
Detailed Description
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.
This cmdlet provides two parameter sets:
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Job
True
True
(ByValue,
ByProperty
Name)
False
Options
True
False
False
True
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 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.
PS C:\PS> 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.
PS C:\PS> Set-VBRJobVssOptions -Job $job -Options $options
Set-VBRRepositoryExtent
Short Description
Modifies extents of scale-out backup repositories.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRRepositoryExtent -Extent <VBRRepositoryExtent[]> [-StoreFull] [StoreIncrement] [<CommonParameters>]
Related Commands
Get-VBRRepositoryExtent
Return Type
VBRDataLocalityExtent or VBRPerformanceExtent
Detailed Description
This cmdlet modifies selected extents of a scale-out repository. You can change the backup placement
mode for a selected extent(s) to store only full backups, only incremental backups or full and
incremental backups. By default, the extents are created with full and incremental backups placement
mode.
Parameters
Parameter
Extent
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
True (by
ValueFromPipeline
ByPropertyName)
False
False
Named
True (by
ValueFromPipeline
ByPropertyName)
False
Accepts
VBRDataLocalityExtent or
VBRPerformanceExtent
object, GUID or string (name of
the backup repository that is
used as extent).
<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 changes the storing mode to store only full backups for the extent named "Backup
Repository 1".
PS C:\PS> Set-VBRRepositoryExtent Extent Backup Repository 1 StoreFull
Example 2
This command enables storing of full and incremental backups on extents Backup Repository 1 and
Backup Repository 4.
PS C:\PS> Set-VBRRepositoryExtent Extent Backup Repository 1, Backup
Repository 4 StoreFull StoreIncrement
Set-VBRScaleOutBackupRepository
Short Description
Modifies a selected scale-out backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRScaleOutBackupRepository -Repository <VBRScaleOutBackupRepository>
[-Name <string>] [-Description <string>] [-PolicyType
<VBRScaleOutBackupRepositoryPolicyType> {DataLocality | Performance}] [Extent <CBackupRepository[]>] [-UsePerVMBackupFiles] [PerformFullWhenExtentOffline] [-PassThru] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository (with ScaleOut parameter)
Get-VBRRepositoryExtent
Return Type
VBRScaleOutBackupRepository
Detailed Description
This cmdlet modifies settings of an existing scale-out backup repository. To modify settings, you need
to enter the corresponding parameters with new values. The parameters that you omit will remain
unchanged.
Parameters
Parameter
Repository
Description
Required Position
Named
False
False
Named
True
(ValueFromPipeline
ByPropertyName)
False
False
Named
True
(ValueFromPipeline
ByPropertyName)
False
Accept
Wildcard
Characters
True
Accepts
VBRScaleOutBackupRepository
object, GUID or string (repository
name).
Name
Accept
Pipeline
Input
True
Named
True
(ValueFromPipeline
ByPropertyName)
False
Extent
True
Named
False
False
Named
True
(ValueFromPipeline
ByPropertyName)
False
False
Named
True
(ValueFromPipeline
ByPropertyName)
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 adds a new extent to the scale-out repository.
1.
Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to
the $scaleoutrepository variable.
2.
Run Set-VBRScaleOutBackupRepository with this variable. List the existing extents and the
new repository.
Example 2
This command changes the scale-out repository policy.
1.
Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to
the $scaleoutrepository variable.
2.
Run Set-VBRScaleOutBackupRepository with this variable. List the existing extents and the
new repository.
Set-VBRTapeGFSMediaPool
Short Description
Modifies GFS media pool.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRTapeGFSMediaPool -MediaPool <VBRTapeGFSMediaPool> [-Name <string>]
[-Description <string>] [-Library <VBRTapeLibrary[]>] [-Medium
<VBRTapeMedium[]>] [-MoveFromFreePool] [-EnableEncryption] [-EncryptionKey
<VBREncryptionKey>] [-NextLibOffline] [-NextLibDrivesBusy] [NextLibNoMedia] [-WeeklyOverwritePeriod <int>] [-MonthlyOverwritePeriod
<int>] [-QuarterlyOverwritePeriod <int>] [-YearlyOverwritePeriod <int>] [WeeklyMediaSetPolicy <VBRTapeGFSMediaSetPolicy>] [-MonthlyMediaSetPolicy
<VBRTapeGFSMediaSetPolicy>] [-QuarterlyMediaSetPolicy
<VBRTapeGFSMediaSetPolicy>] [-YearlyMediaSetPolicy
<VBRTapeGFSMediaSetPolicy>] [-PassThru] [<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Get-VBREncryptionKey
New-VBRTapeGFSMediaSetPolicy
Return Type
VBRTapeGFSMediaPool
Detailed Description
This cmdlet modifies GFS media pool.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
MediaPool
True
Named
False
Name
True
Named
False
False
Library
True
Named
False
False
Named
False
False
False
Named
False
False
MoveFrom
FreePool
False
Named
False
False
Enable
Encryption
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
NextLib
DrivesBusy
NextLib
NoMedia
Weekly
Overwrite
Period
Monthly
Overwrite
Period
Quarterly
Overwrite
Period
Yearly
Overwrite
Period
Weekly
MediaSet
Policy
Monthly
MediaSet
Policy
Quarterly
MediaSet
Policy
Yearly
MediaSet
Policy
PassThru
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Accepts
VBRTapeGFSMediaSetPolicy
object.
Accepts
VBRTapeGFSMediaSetPolicy
object.
Accepts
VBRTapeGFSMediaSetPolicy
object.
Accepts
VBRTapeGFSMediaSetPolicy
object.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VBRTapeGFSScheduleOptions
Short Description
Modifies VBRTapeGFSScheduleOptions object.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRTapeGFSScheduleOptions -Options <VBRTapeGFSScheduleOptions> [WeeklyDay <DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday |
Friday | Saturday}] [-WeeklyStartAt <timespan>] [-MonthlyKind
<VBRGFSMonthlyKind> {DayOfWeek | DayOfMonth}] [-MonthlyDayOfWeek
<DayOfWeek> {Sunday | Monday | Tuesday | Wednesday | Thursday | Friday |
Saturday}] [-MonthlyDayOfWeekNumber <VBRDayNumberInMonth> {First | Second |
Third | Fourth | Last | OnDay}] [-MonthlyDayOfMonth <string>] [QuarterlyKind <VBRGFSQuarterlyKind> {DayOfWeek | DayOfQuarter}] [QuarterlyDayOfWeekNumber <VBRDayNumberInMonth> {First | Second | Third |
Fourth | Last | OnDay}] [-QuarterlyDayOfWeek <DayOfWeek> {Sunday | Monday |
Tuesday | Wednesday | Thursday | Friday | Saturday}] [-QuarterlyDayOfMonth
<string>] [-QuarterlyMonthOfQuarter <VBRGFSMonthOfQuarter> {First | Last}]
[-YearlyKind <VBRGFSYearlyKind> {DayOfWeek | DayOfYear}] [YearlyDayOfWeekNumber <VBRDayNumberInMonth> {First | Second | Third |
Fourth | Last | OnDay}] [-YearlyDayOfWeek <DayOfWeek> {Sunday | Monday |
Tuesday | Wednesday | Thursday | Friday | Saturday}] [-YearlyDayOfMonth
<string>] [-MonthOfYear <VBRMonth> {January | February | March | April |
May | June | July | August | September | October | November | December}]
[<CommonParameters>]
Related Commands
None
Return Type
VBRTapeGFSScheduleOptions
Detailed Description
This cmdlet modifies the VBRTapeGFSScheduleOptions object. This object contains GFS scheduling
options and is used to set schedule to GFS jobs.
Parameters
Parameter
Description
Options
Specifies the
WeeklyDay
Require
d
Positio
n
Accept
Pipeline
Input
Accept
Wildcard
Character
s
True
Named
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
VBRTapeGFSScheduleOptions
object you want to modify.
MonthlyKind
DayOfWeek: The
monthly backup will be
archived on a selected
week day in month, for
example, every first
Sunday of month. Use
the
MonthlyDayOfWeek
parameter to set the day
of week and the
MonthlyDayOfWeekNu
mber parameter to set
the number of day, for
example, "first" (Sunday).
DayOfMonth: The
monthly backup will be
archived on a selected
day of month, for
example, on the 1st. Use
the
MonthlyDayOfMonth
parameter to set the day.
Monthly
DayOfWeek
Monthly
DayOfWeek
Number
Monthly
DayOfMonth
QuarterlyKind
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
YearlyKind
False
Named
False
False
DayOfWeek: The
quarterly backup will be
archived on a selected
week day, for example,
the first Sunday of a
quarter. Use the
QuarterlyDayOfWeekN
umber parameter to set
the number of the week
day and the
QuarterlyDayOfWeek
parameter to set the day
of week.
DayOfQuarter: The
quarterly backup will be
archived on a selected
day of month, for
example, on the 1st of
the first month of a
quarter. Use the
QuarterlyDayOfQuarter
parameter to set the day
of month and the
QuartetlyMonthOfQuarte
r to set the month.
Quarterly
DayOfWeek
Number
Quarterly
DayOfWeek
Quarterly
DayOfMonth
schedule:
Yearly
DayOfWeek
Number
Yearly
DayOfWeek
YearlyDay
OfMonth
MonthOfYear
False
Named
False
False
False
Named
False
False
False
Named
False
False
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.
Set-VBRTapeLibrary
Short Description
Modifies tape library.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRTapeLibrary -TapeLibrary <VBRTapeLibrary> -Name <string> [-PassThru]
[<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Return Type
VBRTapeLibrary
Detailed Description
This cmdlet modifies the name of the selected tape library.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
PassThru
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 modifies the name of the tape library named 'HP MSL G3 Series 3.00' to 'New York
Remote Tape'. The library object is obtained with Get-VBRTapeLibrary and piped down. The PassThru
parameter is set to get the output and view the details.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | SetVBRTapeLibrary -Name "New York Remote Tape" -PassThru
Drives
Enabled
Model
Slots
TapeServerId
Type
State
Id
Name
Description
:
:
:
:
:
:
:
:
:
:
{Tape0, Tape1}
True
MSL G3 Series
24
00000000-0000-0000-0000-000000000000
Automated
Online
2f1fdc3c-8a97-4fa0-b631-74a039e64d5c
New York Remote Tape
New York office Tape Library
Example 2
This command modifies the name of the tape library represented by the $tapelibrary variable. The
tape library object is obtained by running Get-VBRTapeLibrary and assigned to the variable
beforehand.
PS C:\PS> Set-VBRTapeLibrary -TapeLibrary $tapelibrary -Name "New York
Remote Tape"
Set-VBRTapeMediaPool
Short Description
Modifies media pool.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRTapeMediaPool -MediaPool <VBRTapeMediaPool> -Library
<VBRTapeLibrary[]> [-Name <string>] [-Description <string>] [MoveFromFreePool] [-MoveOfflineToVault] [-Vault <VBRTapeVault>] [EnableEncryption] [-EncryptionKey <VBREncryptionKey>] [MediaSetCreationPolicy <VBRTapeMediaSetCreationPolicy>] [-MediaSetName
<string>] [-RetentionPolicy <VBRTapeMediaPoolRetentionPolicy>] [NextLibOffline] [-NextLibDrivesBusy] [-NextLibNoMedia] [EnableMultiStreaming] [-NumberOfStreams <int>] [SplitJobFilesBetweenDrives] [-PassThru] [<CommonParameters>]
Related Commands
Get-VBRTapeMediaPool
Get-VBRTapeLibrary
Get-VBRTapeMedium
Get-VBRTapeVault
Get-VBREncryptionKey
New-VBRTapeMediaPoolRetentionPolicy
New-VBRTapeMediaSetCreationPolicy
Return Type
VBRTapeMediaPool
Detailed Description
This cmdlet modifies media pool that was created before. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Description
Require
d
Positio
n
Accept
Pipeline
Input
Accept
Wildcard
Character
s
MediaPool
True
Named
False
Name
True
Named
False
False
Library
False
Named
True (by
ValueFromPipelin
e
ByPropertyName)
False
False
Named
False
False
Medium
False
Named
False
False
False
Named
False
False
MoveOffline
ToVault
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
MediaSet
Creation
Policy
MediaSet
Name
Retention
Policy
NextLib
Offline
NextLib
DrivesBusy
NextLib
NoMedia
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
PassThru
<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 instructs the selected media pool to move the offline tapes to a particular tape vault.
Run Get-VBRTapeMediaPool to get the media pool and save it to the $mediapool variable.
Use the MoveOfflineToVault parameter to instruct the media pool to move the offline tapes
to a vault.
Run Get-VBRTapeVault to get the target vault and save it to the $vault variable.
Example 2
This command adds encryption settings to a selected media pool.
Run Get-VBRTapeMediaPool to get the media pool and save it to the $mediapool variable.
Use the EnableEncryption parameter to instruct the media pool to encrypt the archived
data.
Run Get-VBREncryptionKey to get the encryption key and save it to the $encryptionkey
variable.
Set-VBRTapeMedium
Short Description
Modifies tape properties.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRTapeMedium -Medium <VBRTapeMedium> [-Name <String>] [-Description
<String>] [-PassThru] [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMedium
Return Type
VBRTapeMedium
Detailed Description
This cmdlet modifies properties of a selected tape. You can modify name and/or description of the
tape. To modify settings, you need to enter the corresponding parameters with new values. The
parameters that you omit will remain unchanged.
Parameters
Parameter
Medium
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
or False
Name
False
Named
False
False
False
Named
False
False
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 renames the '0014001F' tape into 'SQL 9/2014' and sets a description for it.
The tape is obtained with Get-VBRTapeMedium and piped down.
PS C:\PS> Get-VBRTapeMedium -Name "0014001F" | Set-VBRTapeMedium -Name "SQL
9/2014" -Description "SQL DB monthly full backups: Sept/2014"
Example 2
This command renames a selected tape into 'SQL encrypted'.
The tape is obtained with Get-VBRTapeMedium and assigned to the '$tape' variable beforehand.
PS C:\PS> Set-VBRTapeMedium -Medium $tape -Name "SQL encrypted"
Set-VBRTapeServer
Short Description
Modifies tape server.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRTapeServer -TapeServer <VBRTapeServer> [-Description <string>] [PassThru] [<CommonParameters>]
Related Commands
Get-VBRTapeServer
Return Type
VBRTapeServer
Detailed Description
This cmdlet modifies tape server that was created before.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
PassThru
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
This command modifies the description of the tape server named "Sydney_Tape_Server". The tape
server is obtained by running Get-VBRTapeServer and piped down. The description is changed to
"Sydney_Remote_Tape_Server". The PassThru parameter is set to get the output and view the details.
PS C:\PS> Get-VBRTapeServer -Name "Sydney_Tape_Server" | Set-VBRTapeServer
-Description "Sydney_Remote_Tape_Server" -PassThru
ServerId
IsAvailable
Id
Name
Description
:
:
:
:
:
937f3556-e684-4b33-a8a9-d87d243948f6
True
6d3c4fd8-9d0a-454b-9ef0-32f72d577069
Sydney_Tape_Server
Sydney Remote Tape Server
Set-VBRTapeVault
Short Description
Modifies tape vault.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VBRTapeVault -Vault <VBRTapeVault> [-Name <String>] [-Description
<String>] [-Protect] [-PassThru] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeVault
Return Type
VBRTapeVault
Detailed Description
This cmdlet modifies tape vault that was created before. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Vault
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
Accept
Pipeline
Input
<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 modifies the name and the description of the vault named "Vault 01". The vault object
is obtained by running Get-VBRTapeVault and piped down. The PassThru parameter is set to get the
output and view the details.
PS C:\PS> Get-VBRTapeVault -Name "Vault 01" | Set-VBRTapeVault -Name
"Sydney Remote Storage" -Description "Secondary Sydney Remote Storage" PassThru
Location
Medium
Id
Name
Description
:
:
:
:
:
Example 2
This command modifies the name of the vault represented by the $vault variable. The vault object is
obtained by running Get-VBRTapeVault and assigned to the variable beforehand.
PS C:\PS> Set-VBRTapeVault -Vault $vault -Name "Sydney Remote Storage 02"
Set-VBRViCloudHardwarePlan
Short Description
Modifies a selected VMware hardware plan.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Requires a VCP license.
Syntax
Set-VBRViCloudHardwarePlan -HardwarePlan <VBRViCloudHardwarePlan> [-Name
<String>] [-Description <String>] [-Server <Object>] [-CPU <Int32>] [Memory <Int32>] [-NumberOfNetWithInternet <Int32>] [NumberOfNetWithoutInternet <Int32>] [-Datastore
<VBRViCloudHardwarePlanDatastore[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [-PipelineVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Return Type
VBRViCloudHardwarePlan
Detailed Description
This cmdlet modifies settings of an existing hardware plan. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Hardware
Plan
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
True
Named
False
False
False
Named
False
False
Server
True
Named
False
False
False
Named
False
False
Memory
False
Named
False
False
Number
OfNetWith
Internet
False
Named
False
False
Number
OfNet
Without
Internet
False
Named
False
False
Datastore
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.
Set-VBRViCloudReplicaJob
Short Description
Modifies a VMware cloud replication job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRViCloudReplicaJob -Job <CBackupJob> [-Name <string>] [-Entity
<IViItem[]>] [-Datastore <VBRCloudDatastore>] [-Suffix <string>] [BackupRepository <CBackupRepository>] [-Description <string>] [EnableNetworkMapping] [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork
<VBRCloudServerNetworkInfo[]>] [-SourceProxy <CViProxy[]>] [UseWANAccelerator] [-SourceWANAccelerator <CWanAccelerator>] [SourceRepository <CBackupRepository[]>] [-DiskType <EDiskCreationMode>
{Source | Thick | Thin}] [<CommonParameters>]
Related Commands
Get-VBRJob
Find-VBRViEntity
Get-VBRCloudServer
Get-VBRCloudDatastore
Get-VBRBackupRepository
Get-VBRViServerNetworkInfo
Get-VBRViProxy
Get-VBRWANAccelerator
Detailed Description
This cmdlet modifies an existing VMware cloud replication job. To modify settings, you need to enter
the corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
True (by
ValueFromPipeline
ByPropertyName)
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Accept
Pipeline
Input
Datastore
Suffix
Backup
Repository
False
Named
False
False
Source
Network
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
DiskType
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VBRViReplicaJob
Short Description
Modifies replication job.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Set-VBRViReplicaJob -Job <CBackupJob> [-Name <String>] [-Server <CHost>] [Entity <IViItem[]>] [-Datastore <CViDatastoreItem>] [-ResourcePool
<CViResourcePoolItem>] [-Folder <CViFolderItem>] [-Suffix <String>] [BackupRepository <CBackupRepository>] [-Description <String>] [EnableNetworkMapping] [-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork
<VBRViNetworkInfo[]>] [-SourceProxy <CViProxy[]>] [-TargetProxy
<CViProxy[]>] [-UseWANAccelerator] [-SourceWANAccelerator
<CWanAccelerator>] [-TargetWANAccelerator <CWanAccelerator>] [RestorePointsToKeep <Int32>] [-ReplicateFromBackup] [-SourceRepository
<CBackupRepository[]>] [-EnableReIp] [-ReIpRule <VBRViReplicaReIpRule[]>]
[-DiskType <EDiskCreationMode>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRJob
Get-VBRServer
Find-VBRViEntity
Find-VBRViDatastore
Find-VBRViResourcePool
Find-VBRViFolder
Get-VBRBackupRepository
Get-VBRViProxy
Get-VBRWANAccelerator
Get-VBRViServerNetworkInfo
New-VBRViReplicaReIpRule
Detailed Description
This cmdlet modifies an existing replication job. To modify settings, you need to enter the
corresponding parameters with new values. The parameters that you omit will remain unchanged.
Parameters
Parameter
Job
Description
Specifies the replication job you
want to modify.
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Server
True
Named
False
False
Entity
True
Named
True (ByValue,
ByProperty
Name)
False
False
Named
False
False
Resource
Pool
False
Named
False
False
Folder
False
Named
False
False
Suffix
False
Named
False
False
Backup
Repository
False
Named
False
False
Description
False
Named
False
False
False
Named
False
False
Source
Network
False
Named
False
False
False
Named
False
False
False
Named
False
False
Target
Proxy
False
Named
False
False
UseWAN
Accelerator
False
Named
False
Fals
False
Named
False
False
Target
WAN
Accelerator
False
Named
False
False
Restore
Points
ToKeep
False
Named
False
False
False
Named
False
False
False
Named
False
False
EnableReIp
False
Named
False
False
ReIpRule
False
Named
False
False
False
Named
False
False
Accepts VBRViReplicaReIpRule
object.
DiskType
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Set-VNXHost
Short Description
Modifies a selected EMC VNX storage.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Set-VNXHost -Host <CVnxHost> [-Description <string>] [-UserName <string>]
[-Password <string>] [-Credentials <CCredentials>] [-CredentialsScope
<VBRVNXBlockCredentialsScope> {Global | Local | LDAP}]
[<CommonParameters>]
Related Commands
Get-VBRCredentials
Detailed Description
This cmdlet adds the selected EMC VNX storage to Veeam Backup & Replication. To modify settings,
you need to enter the corresponding parameters with new values. The parameters that you omit will
remain unchanged.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Host
True
Named
False
Type
True
Named
False
False
UserName
True
Named
False
False
Password
True
Named
False
False
Name
False
Named
False
False
True
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Confirm
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.
Set-VSBJobOptions
Short Description
Applies custom SureBackup job options.
Applies to
Platform: VMware
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VSBJobOptions [-Job] <CSbJob> [-Options] <CDRJobOptions> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
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 CDRJobOptions object 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.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
True
False
False
Accept
Pipeline
Input
<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 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.
PS C:\PS> 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.
PS C:\PS> Set-VBRJobScheduleOptions -Job $SureJob -Options $"Sure Options"
Set-VSBJobSchedule
Short Description
Sets SureBackup job schedule options.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet sets custom schedule settings to the selected SureBackup job.
You can schedule the job to run:
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Job
True
Named
True
(ByValue,
ByProperty
Name)
False
Daily
False
Named
False
False
At
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Days
At
Days
Number
InMonth
Monthly
Months
After
AfterJob
<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 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.
PS C:\PS> 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.
PS C:\PS> 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 SureBackup job named "SureBackup Job 01" to run after the job
represented by the $job variable. 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.
PS C:\PS> Get-VSBJob -Name "SureBackup Job 01" | Set-VSBJobSchedule -After
-AfterJob $job
Set-VSBJobScheduleOptions
Short Description
Applies customized job scheduling options to a selected SureBackup job.
Applies to
Platform: VMware
Product Edition: Enterprise, Enterprise Plus
Syntax
Set-VSBJobScheduleOptions [-Job] <CSbJob> [-Options] <ScheduleOptions> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VSBJob
New-VBRJobScheduleOptions
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
True
False
False
Accept
Pipeline
Input
<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 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.
PS C:\PS> 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.
PS C:\PS> Set-VSBJobScheduleOptions -Job $SureJob -Options $"Schedule
Options"
Start-VBRConfigurationBackupJob
Short Description
Starts the configuration backup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRConfigurationBackupJob [-RunAsync] [<CommonParameters>]
Related Commands
None
Return Type
VBRSession
Detailed Description
This cmdlet starts the configuration backup job.
Parameters
Parameter
RunAsync
Description
Required Position
False
Named
Accept
Accept
Pipeline Wildcard
Input
Characters
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
This command starts the configuration backup job in the RunAsync mode.
PS C:\PS> Start-VBRConfigurationBackupJob -RunAsync
False
Start-VBRFailoverPlan
Short Description
Starts failover by failover plan.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Start-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-Force]
[<CommonParameters>]
-ORStart-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-FromDate
<datetime>] [-Wait] [-Force] [<CommonParameters>]
-ORStart-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-Force] [Test] [<CommonParameters>]
Related Commands
Get-VBRFailoverPlan
Return Type
VBRBackupSession[]
Detailed Description
This cmdlet starts failover by failover plan. With this cmdlet, you can start a number of failover
processes.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Accepts VBRFailoverPlan.
You can assign multiple plans to this
object.
FromDate
False
Named
False
False
Test
<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 starts failover process by failover plan named "MS Exchange Group Failover". The VMs
in the failover group are failed over to the latest restore point.
The FromDate parameter is omitted to select the latest restore point automatically.
Example 2
This command starts failover process represented by the '$MSExchangeGroup' variable. The VMs in
the failover group are failed over to the latest restore point.
The FromDate parameter is omitted to select the latest restore point automatically.
Example 3
This command starts failover processes by failover plans named "MS Exchange Group Failover" and
"SQLServers Group Failover". The VMs are failed over to a week ago state. The VM groups are failed
over one by one.
The date is obtained with the Date command and assigned to the '$date' variable
beforehand.
The failover plans are obtained with Get-VBRFailoverPlan and piped down.
The Wait parameter is used to start the failover processes one after the other.
Start-VBRHvInstantRecovery
Short Description
Starts Hyper-V Instant VM Recovery.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet allows to perform Instant Recovery of a Hyper-V VM. The Instant VM Recovery for Hyper-V
process creates a copy of a VM in a target location reading data from the directly from a compressed
and deduplicated backup file.
This cmdlet allows you to use the following options:
Restore the VM to any available restore point, full or increment. Use the RestorePoint
parameter to indicate the needed restore point.
Restore the VM to original location or to another location. Use the Server and Path
parameters to indicate the target location where the VM will be restored. You can indicate the
location of the original VM or any other host available with Veeam backup server that will act
as a staging location. If you choose the original location, make sure that the original VM is
powered off to avoid conflicts or restore the VM with a new name. Use the VMName
parameter to set the new name.
Connect VM to network. Use the NICsEnabled parameter to connect the restored VM to the
network.
Power on VM automatically. Use the PowerUp parameter to indicate that the VM must be
automatically powered on after restore.
Restore the VM with the original ID or with a new ID. 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.
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 one of the following steps:
Remove the restored VM. You can stop publishing the recovered VM and discard the changes
made to it while it was running from backup. To do this, run Stop-VBRInstantRecovery.
Run Restart-VBRInstantRecovery to restart the Instant Recovery session if it failed for some reason.
Run Get-VBRInstantRecovery to view the session status.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
RestorePoint
True
False
Server
True
False
False
Path
True
False
False
False
Named
False
False
False
Named
False
False
PowerUp
False
Named
False
False
NICsEnabled
False
Named
False
False
False
Named
False
False
Reason
False
Named
False
False
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
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.
Start-VBRHvInstantRecoveryMigration
Short Description
Performs VM migration to a Hyper-V host.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRHvInstantRecoveryMigration [-InstantRecovery] <InstantRecovery[]>
[-WarningAction <ActionPreference>][-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRInstantRecovery
Detailed Description
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.
Parameters
Parameter
Description
Instant
Recovery
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 finalizes the current instant recovery session. The session is obtained with GetVBRInstantRecovery and piped down.
PS C:\PS> 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.
PS C:\PS> Start-VBRHvInstantRecoveryMigration -InstantRecovery $"Hv Instant
Recovery"
Start-VBRHvReplicaFailback
Short Description
Performs failback to the production host.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRHvReplicaFailback -RestorePoint <COib> [-Reason <String>] [RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
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-VBRHvReplicaFailover 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 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.
PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object
$_.creationtime -Descending | Select -First 1 | Start-VBRHvReplicaFailback
-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.
PS C:\PS> Start-VBRHvReplicaFailback -RestorePoint $"WebServer_replica
restorepoint" -Reason "Data recovery" -RunAsync
Start-VBRHvReplicaFailover
Short Description
Fails over a corrupted VM to its replica.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRHvReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [RunAsync] [<CommonParameters>]
-ORStart-VBRHvReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [RunAsync] [-Definite] [<CommonParameters>]
-ORStart-VBRHvReplicaFailover [-RestorePoint] <COib> [-Reason <string>] [RunAsync] [-Planned] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
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 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-VBRHvReplicaFailback 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. You can also undo planned failover.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Restore
Point
True
True
(ByValue,
ByProperty
Name)
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Definite
False
Named
False
False
Planned
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.
Start-VBRHvRestoreVM
Short Description
Starts restore of the entire VM.
Applies to
Platform: Hyper-V
For VMware, run Start-VBRRestoreVM.
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
This cmdlet starts restore of the entire VM.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Restore
Point
True
True
(ByValue,
ByProperty
Name)
False
Server
False
Named
False
False
Path
False
Named
False
False
VMName
False
Named
False
False
Preserve
VmID
False
Named
False
False
False
Named
False
False
RegisterAs
Cluster
Resource
False
Named
False
False
NICsEnabled
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
Password
Credential
Reason
RunAsync
be performed.
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Start-VBRInstantRecovery
Short Description
Starts VMware Instant VM Recovery.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRInstantRecovery [-RestorePoint] <COib> [-Server] <CHost> [[ResourcePool] <CViResourcePoolItem>] [-VMName <string>] [-Datastore
<CViDatastoreItem>] [-StoragePolicy <VBRViStoragePolicy>] [-Folder
<CViFolderItem>] [-PowerUp] [-NICsEnabled] [-Reason <string>] [-RunAsync]
[<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Get-VBRServer
Find-VBRViResourcePool
Find-VBRViDatastore
Find-VBRViFolder
Detailed Description
This cmdlet starts VM instant recovery.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
RestorePoint
True
True
(ByValue,
ByProperty
Name)
False
VMName
False
Named
False
False
Server
True
False
False
False
False
False
False
Named
False
False
False
Named
False
False
Folder
False
Named
False
False
PowerUp
False
Named
False
False
NICsEnabled
False
Named
False
False
Reason
False
Named
False
False
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 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.
PS C:\PS> et-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 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 -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.
Start-VBRJob
Short Description
Starts backup, replication or copy job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRJob [-Job] <CBackupJob[]> [-FullBackup] [-RetryBackup] [-RunAsync]
[-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet allows you to start a created or stopped job. You can start a backup, replication or copy
job.
This cmdlet allows you to start a job for an ordinary run, force a full backup, or set the job to restart in
case it failed.
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.
Run Stop-VBRJob to stop a running job.
Run Enable-VBRJob to enable a disabled job.
Run Start-VSBJob to start a SureBackup job.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
RunAsync
False
Named
False
False
FullBackup
<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 starts the jobs named "WebApplications Server Backup" and "Fileserver Copy Job". The
job is obtained with Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "WebApplications Server Backup", "Fileserver
Copy Job" | Start-VBRJob
Example 2
This command starts a vCloud backup job right after it the job is created. The RunAsync parameter is
set to bring the process to the background.
PS C:\PS> Add-VBRvCloudJob -Entity $"vCloud Server" -Name "vCloud Server
Backpup" | Start-VBRJob -RunAsync
Example 3
This command performs a full backup for the job named "WebApplications Server Backup". The job is
obtained with Get-VBRJob and piped down.
PS C:\PS> Get-VBRJob -Name "WebApplications Server Backup" | Start-VBRJob FullBackup
Example 4
This command restarts a failed job represented by the $job variable. The job is obtained with GetVBRJob and assigned to the variable beforehand. The RunAsync parameter is set to bring the process
to the background.
PS C:\PS> Start-VBRJob -Job $job -RetryBackup -RunAsync
Start-VBRLinuxFileRestore
Short Description
Starts non-Windows VM guest OS file restore.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides 3 parameter sets.
Basic:
For VMware:
Start-VBRLinuxFileRestore -RestorePoint <COib> -Server <CHost> ResourcePool <CViResourcePoolItem> -NetworkInfo <IVBRServerNetworkInfo> [Reason <string>] [-IP <ipaddress>] [-NetworkMask <string>] [-Gateway
<ipaddress>] [-FromNSS] [-EnableFTP] [-Credentials <CCredentials>]
[<CommonParameters>]
For Hyper-V:
Related Commands
Get-VBRRestorePoint
Get-VBRServer
Get-VBRHvServerNetworkInfo / Get-VBRViServerNetworkInfo
Find-VBRViResourcePool
Detailed Description
This cmdlet starts restore of VM guest OS files from 15 file systems such as Linux, Unix, BSD, MacOS
and many others.
For non-Windows file level restore, an assisting proxy appliance running Linux is used. Veeam Backup
& Replication mounts disks of the restored VM to the proxy appliance as virtual hard drives.
For Windows OS file restore, run Start-VBRWindowsFileRestore.
This cmdlet requires finalizing. When you restore all needed files, run Stop-VBRLinuxFileRestore to
unmount disks and powers the proxy appliance off.
You need to save the restore session to a variable when you run this cmdlet. Otherwise you will be
Important! unable to finalize the restore session with PowerShell.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Restore
Point
True
Named
True (ByValue,
ByProperty
Name)
False
Reason
False
Named
False
False
True
Named
True (by
ValueFromPipeline
ByPropertyName)
False
Network
Info
True
Named
False
False
IP
False
Named
False
False
False
Named
False
False
Gateway
False
Named
False
False
VLanId
False
Named
False
False
False
Named
False
False
FTP
False
Named
False
False
Resource
Pool
True
Named
True (by
ValueFromPipeline
ByPropertyName)
False
FromNSS
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 example shows how to start a file restore session for a non-Windows VM in the Hyper-V
environment.
The restore session is saved to the '$linuxflr' variable to use it for finalizing in future.
The restore point is obtained with Get-VBRRestorePoint and assigned to the '$restorepoint'
variable beforehand.
The host where the proxy appliance will be deployed is obtained with Get-VBRServer and
assigned to the '$hvhost01' variable beforehand.
The network in which the proxy appliance will be registered is obtained with GetVBRHvServerNetworkInfo and assigned to the '$targetnetwork' variable beforehand.
Example 2
This example shows how to start a file restore session for a non-Windows VM in the VMware
environment.
The restore session is saved to the '$linuxflr' variable to use it for finalizing in future.
The restore point is obtained with Get-VBRRestorePoint and assigned to the '$restorepoint'
variable beforehand.
The host where the proxy appliance will be deployed is obtained with Get-VBRServer and
assigned to the '$esx01' variable beforehand.
The network in which the proxy appliance will be registered is obtained with GetVBRViServerNetworkInfo and assigned to the '$targetnetwork' variable beforehand.
Start-VBRQuickBackup
Short Description
Performs QuickBackup.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRQuickBackup -VM <IVmItem[]> [-Wait] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Find-VBRViEntity / Find-VBRHvEntity
Detailed Description
This cmdlet starts QuickBackup on selected VMs.
Quick backup performs on-demand incremental backup for VMs. The VM must be added to a backup
job and have at least one full backup.
Parameters
Parameter
VM
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
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.
Start-VBRQuickMigration
Short Description
Starts Quick Migration of a virtual machine.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRQuickMigration -Entity <CViVmItem[]> -Server <CHost> [ResourcePool <CViResourcePoolItem>] [-Datastore <CViDatastoreItem>] [Folder <CViFolderItem>] [-StoragePolicy <VBRViStoragePolicy>] [-SourceProxy
<CViProxy[]>] [-TargetProxy <CViProxy[]>] [-ForceVeeamQM] [DeleteSorceVmFiles] [-RunAsync] [<CommonParameters>]
Related Commands
Find-VBRViEntity
Get-VBRServer
Find-VBRViResourcePool
Find-VBRViDatastore
Find-VBRViFolder
Get-VBRViProxy
Detailed Description
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Entity
True
Named
True
(ByValue,
ByProperty
Name)
False
Server
True
Named
True
(ByValue,
ByProperty
Name)
False
ResourcePool
False
Named
False
False
Datastore
False
Named
False
False
False
Named
False
False
False
Named
False
False
SourceProxy
False
Named
False
False
False
Named
False
False
False
Named
False
False
TargetProxy
Force
VeeamQM
DeleteSorce
VmFiles
False
Named
False
False
RunAsync
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
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.
PS C:\PS> Start-VBRQuickMigration -Entity $vm -Server $server -ResourcePool
$pool -Datastore $d -Folder $folder -DeleteSorceVmFiles
Start-VBRRepositoryExtentBackupEvacuation
Short Description
Evacuates backups from a scale-out backup repository extent.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRRepositoryExtentBackupEvacuation -Extent <VBRRepositoryExtent[]>
[-RunAsync] [<CommonParameters>]
Related Commands
Get-VBRRepositoryExtent
Return Type
VBRSession
Detailed Description
This cmdlet evacuates backups from a scale-out backup repository extent. When you evacuate
backups, Veeam moves them to other extents according to the configured policy.
Parameters
Parameter
Extent
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True (for
string)
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
This command evacuates backups from an extent.
1.
Run Get-VBRBackupRepository to get the repository. Use the ScaleOut parameter. Save it to
the $scaleoutrepository variable.
2.
Run Set-VBRScaleOutBackupRepository with this variable. List the existing extents and the
new repository.
Start-VBRRestoreVirtualDisks
Short Description
Restores physical disks from Endpoint backups to virtual disk formats.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRRestoreVirtualDisks [-RestorePoint] <COib> [-Server] <CHost> [Path] <string> -RestoreDiskType <EVirtualDiskRestoreType> {Vmdk | Vhd |
Vhdx} [-Files <COIBFileInfo[]>] [-Reason <string>] [-RunAsync]
[<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Get-VBRServer
Get-VBRFilesInRestorePoint
Detailed Description
This cmdlet allows you to restore physical disks from Endpoint volume level backups and convert
them to VMDK, VHDX or VHD format. The data from the backups is restored as a folder to a selected
path.
You can restore disks to any Windows host added to Veeam Backup & Replication.
If the Endpoint backup contains several disks, you can restore specific disks from backup. Use the Files
parameter to select the disks to restore.
For virtual disks restore, run Start-VBRRestoreVMFiles.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
False
True
False
False
Path
True
False
False
True
Named
False
False
Files
False
Named
True
(ByName)
False
False
Named
False
False
RunAsync
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 restores all disks from an SRV03 Endpoint backup to Veeam backup server. The disks
are restored to the latest restore point. The resulting format is VMDK.
The Veeam backup server is obtained by Get-VBRLocalhost and assigned to the '$server'
variable.
The restore point is obtained by Get-VBRRestorePoint. The restore points are filtered with
Sort-Object method by the "CreationTime" property to get the most recent one. The restore
point is assigned to the '$restorepoint' variable.
Example 2
This command restores selected disks from an SRV03 computer to a Windows server added to Veeam
Backup & Replication. The disks are restored to the latest restore point. The resulting format is VHDX.
The restore point is obtained with Get-VBRRestorePoint. First, all Hyper-V backups are
selected by filtering all backups with ".BackupPlatform" property. Then, the available restore
points are filtered by the 'SRV03' name by '.Type' property. Then the restore points are sorted
with Sort-Object method by the "CreationTime" property to get the most recent one.
The target server is obtained with Get-VBRServer and assigned to the '$server' variable.
The disks in the backup are obtained with Get-VBRFilesInRestorePoint and assigned to the
'$disks' variable. The needed disks 1 and 3 will be restored.
Start-VBRRestoreVM
Short Description
Starts restore of the entire VM.
Applies to
Platform: VMware
For Hyper-V, run Start-VBRHvRestoreVM.
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Start-VBRRestoreVM [-RestorePoint] <COib> [-Server] <CHost> [[ResourcePool] <CViResourcePoolItem>] [[-Datastore] <CViDatastoreItem>] [Folder <CViFolderItem>] [-StoragePolicy <VBRViStoragePolicy>] [-VMName
<string>] [-DiskType <EDiskCreationMode> {Source | Thick | Thin}] [-PowerUp
<bool>] [-SkipTagsRestore] [-Reason <string>] [-RunAsync] [-QuickRollback]
[-Credentials <CCredentials>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Get-VBRServer
Find-VBRViResourcePool
Find-VBRViDatastore
Find-VBRViStoragePolicy
Find-VBRViFolder
Detailed Description
This cmdlet starts the entire VM restore.
With this cmdlet, you can restore the VM to the original location or to another location. Use an
appropriate parameter set for each case.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
RestorePoint
True
True
(ByValue,
ByProperty
Name)
False
Server
True
False
False
ResourcePool
False
False
False
Datastore
False
False
False
StoragePolicy
False
Named
False
False
Folder
False
Named
False
False
VMName
False
Named
False
False
False
Named
False
False
PowerUp
False
Named
False
False
Skip
Tags
Restore
False
Named
False
False
Reason
False
Named
False
False
False
Named
False
False
QuickRollback
False
Named
False
False
ToOriginal
Location
False
Named
False
False
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 restores a VM to the original location.
The restore point is obtained with Get-VBRRestorePoint and assigned to the the
'$restorepoint' variable.
Example 2
This example starts restore of the VM to another location.
The restore point is obtained with Get-VBRRestorePoint and assigned to the the '$point'
variable.
The target host is obtained with Get-VBRServer and assigned to the '$server' variable.
The resource pool is obtained with Find-VBRViResourcePool and assigned to the '$rpool'
variable.
The datastore is obtained with Find-VBRViDatastore and assigned to the '$datastore' variable.
Start-VBRRestoreVMFiles
Short Description
Restores VM configuration files.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
False
Server
True
False
False
Path
True
False
False
Files
False
Named
True
(ByName)
False
False
Named
False
False
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
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.
PS C:\PS> Start-VBRRestoreVMFiles RestorePoint $point Server $server
Path C:\BackupFiles
Start-VBRSQLDatabaseRestore
Short Description
Starts Microsoft SQL database restore.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets.
Related Commands
Get-VBRSQLDatabase
Return Type
VBRSession
Detailed Description
This cmdlet starts restore of a selected SQL database.
Parameters
Parameter
Database
Description
Required Position
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
Accepts VBRSQLDatabase
object.
ServerName
Accept
Pipeline
Input
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
False
Named
False
False
SqlCredentials
ToPointInTime
Force
Wait
<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 example shows how to restore a database to a selected point in time to the original location.
Run Get-VBRApplicationRestorePoint to get the "CRM_db" restore point. Save it to the $restorepoint
variable.
PS C:\PS> $restorepoint = Get-VBRApplicationRestorePoint -SQL -Name
"crm_db"
Select the third restore point from the list and run Get-VBRSQLDatabase with the $restorepoint[2]
variable to get the database named "Locations". Save it to the $locations_db variable.
PS C:\PS> $locations = Get-VBRSQLDatabase -ApplicationRestorePoint
$restorepoint[2] -Name "Locations"
Run Get-VBRCredentials to get the credentials to authenticate with the target server. Save it to the
$guestcreds variable.
Run Get-VBRCredentials to get the credentials to authenticate with the Microsoft SQL instance. Save it
to the $sqlcreds variable.
PS C:\PS> $guestcreds = Get-VBRCredentials -Name "tech\administrator"
PS C:\PS> $sqlcreds = Get-VBRCredentials -Name "sql_administrator"
Run Get-VBRSQLDatabaseRestoreInterval to check the available restore interval. Select the time to
restore the database.
PS C:\PS> Get-VBRSQLDatabaseRestoreInterval -Database $locations
Start-VBRTapeCatalog
Short Description
Starts tape catalog process.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRTapeCatalog -Library <VBRTapeLibrary[]> [-Wait]
[<CommonParameters>]
-ORStart-VBRTapeCatalog -Medium <VBRTapeMedium[]> [-Wait]
[<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Get-VBRTapeMedium
Return Type
VBRBackupSession
Detailed Description
This cmdlet starts catalog process. Catalog process scans tape contents and registers tapes in the
Veeam Backup & Replication database after which Veeam Backup & Replication is able to administrate
tape allocation and consumption and track data written to tapes.
You can run catalog job for selected libraries or for selected tapes.
Parameters
Parameter
Library
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
True
Named
False
object.
Wait
False
Named
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 catalogs a selected library.
Run Get-VBRTapeLibrary to get the library. Pipe it to Start-VBRTapeCatalog.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | StartVBRTapeCatalog
Example 2
This command catalogs tapes named "00140009" and "00140010".
1.
Run Get-VBRTapeMedium to get the tapes and save them to the $tape variable.
2.
False
Start-VBRTapeInventory
Short Description
Starts tape inventory.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRTapeInventory -Library <VBRTapeLibrary[]> [-Wait]
[<CommonParameters>]
-ORStart-VBRTapeInventory -Medium <VBRTapeMedium[]> [-Wait]
[<CommonParameters>]
Related Commands
Get-VBRTapeLibrary
Get-VBRTapeMedium
Return Type
VBRBackupSession
Detailed Description
This cmdlet starts inventory process.
You can run inventory job for selected libraries or for selected tapes.
Parameters
Parameter
Library
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
True
Named
False
Wait
False
Named
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 inventories a selected library.
Run Get-VBRTapeLibrary to get the library. Pipe it to Start-VBRTapeInventory.
PS C:\PS> Get-VBRTapeLibrary -Name "HP MSL G3 Series 3.00" | StartVBRTapeInventory
Example 2
This command inventories tapes named "00140009" and "00140010".
1.
Run Get-VBRTapeMedium to get the tapes and save them to the $tape variable.
2.
False
Start-VBRvCloudInstantRecovery
Short Description
Starts a vCloud VM instant recovery.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
vApp
False
Named
False
False
VmName
False
Named
False
False
Datastore
False
Named
False
False
False
Named
False
False
Reason
False
Named
False
False
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 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.
PS C:\PS> 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,
Start-VBRvCloudRestoreVApp
Short Description
Starts a vApp restore.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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 & Replication 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 a
CVcdVAppRestoreSettings object which unifies all the settings options required for restore. The
CVcdVAppRestoreSettings object 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
RestorePoint
False
Named
False
False
settings unchanged.
PowerUp
False
Named
False
False
Reason
False
Named
False
False
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 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.
PS C:\PS> 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.
PS C:\PS> $restoreparams = Get-VBRRestorePoint -Backup $backup | Where
{$_.Name -eq "vApp_01"} | New-VBRvCloudVAppRestoreSettings
Now you need to run Start-VBRvCloudRestoreVApp with the customized $restoreparams variable. The
RunAcync parameter is set to bring the process to the background:
PS C:\PS> Start-VBRvCloudRestoreVApp -RestoreParams $restoreparams RunAsync
Start-VBRvCloudRestoreVm
Short Description
Starts a vCloud VM restore.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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 & Replication 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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
Storage
Profile
False
Named
False
False
vCloud
Datastore
False
Named
False
False
False
Named
False
False
VMName
False
Named
False
False
PowerUp
False
Named
False
False
Reason
False
Named
False
False
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 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.
PS C:\PS> 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-VBRViReplicaFailback
Short Description
Fails back to production host.
Applies to
Platform: Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRViReplicaFailback -RestorePoint <COib> [-Reason <String>] [RunAsync] [-Complete] [-PowerOn] [-WarningAction <ActionPreference>] [WarningVariable <String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Complete
False
Named
False
False
PowerOn
False
Named
False
False
Skip
Tags
Restore
False
Named
False
False
Storage
Policy
Action
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 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.
PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object
$_.creationtime -Descending | Select -First 1 | Start-VBRViReplicaFailback
-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.
PS C:\PS> Start-VBRViReplicaFailback -RestorePoint $"WebServer_replica
restorepoint" -Reason "Data recovery" -RunAsync
Start-VBRViReplicaFailover
Short Description
Fails over a corrupted VM to its replica.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable <String>]
[-WhatIf] [-Confirm] [<CommonParameters>]
-ORStart-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [RunAsync] [-Definite] [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [-WhatIf] [-Confirm] [<CommonParameters>]
-ORStart-VBRViReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [RunAsync] [-Planned] [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
This cmdlet allows you fail over a corrupted VM to its successfully created replica.
This cmdlet provides 3 parameter sets for the following operations:
Performing failover. 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.
Performing permanent failover. You can perform the permanent failover to permanently move your
workload to the target host if the source is nonrecoverable. Your target host should have adequate
resources. The replica starts acting like source in this case.
Performing planned failover. In this case, the source VM is powered off properly, and the replica is fully
synchronized before the failover. The planned failover is used for maintenance or in other cases of
planned downtime.
In Veeam Backup & Replication, failover is a temporary stage that needs to be finalized. In case your
primary VM is unrecoverable, you can perform the permanent failover with this cmdlet. In case you
plan to switch to the replica temporarily, you need to take the following steps:
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Restore
Point
True
True
(ByValue,
ByProperty
Name)
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Definite
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
False
Named
False
False
Definite
False
Named
False
False
Planned
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 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.
PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object
$_.creationtime -Descending | Select -First 1 | Start-VBRViReplicaFailover
-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.
PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object
$_.creationtime -Descending | Select -First 1 | Start-VBRViReplicaFailover
-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.
PS C:\PS> Start-VBRViReplicaFailover -RestorePoint $"WebServer_replica
restorepoint" -Reason "Data recovery" -RunAsync
Example 4
This command performs the planned failover to the VM replica represented by the $"DC_replica
restorepoint" variable. The restore point is obtained with Get-VBRRestorePoint and assigned to the
variable beforehand. The reason is "Tsunami forecast". The Planned parameter is used to leverage the
planned failover mechanism.
PS C:\PS> Start-VBRViReplicaFailover -RestorePoint $"DC_replica
restorepoint" -Reason "Tsunami forecast" -Planned
Start-VBRWindowsFileRestore
Short Description
Starts VM files restore.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Start-VBRWindowsFileRestore [-RestorePoint] <COib> [[-Host] <CHost>] [[ResourcePool] <CViResourcePoolItem>] [[-Folder] <CViFolderItem>] [-Reason
<string>] [-Credentials <CCredentials>] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Get-VBRServer
Find-VBRViResourcePool
Find-VBRViFolder
Detailed Description
This cmdlet allows you to restore files stored on disks of VM running Windows or from Endpoint
backups.
This cmdlet mounts the disks of the backed up VM(s) to the Veeam backup server or other server in
your virtual infrastructure. The disks are published directly from the backup file. After the disks are
mounted, you can copy the needed files to any disk or folder accessible by Veeam backup server.
To stop the file restore session and unmount the disks, run Stop-VBRWindowsFileRestore.
You need to save the restore session to a variable when you run this cmdlet. Otherwise you will be
Important! unable to finalize the restore session with PowerShell.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
Reason
False
Named
False
False
Host
False
False
False
Resource
Pool
False
False
False
Folder
False
False
False
Credentials
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
This example shows how to perform the whole file restore process.
1.
2.
The list of available restore points produced by the backup job 'Job 1' is obtained
with Get-VBRRestorePoint and piped down.
The restore points are sorted with Sort-Object method by the "creationtime"
property to get the most recent one.
To copy the files, you need to obtain the mount point for the target mounted volume:
The mount point is used to obtain the path to the files. The path is assigned to the $file
variable.
PS C:\PS> $result = Get-VBRBackup | where {$_.jobname -eq "Job 1"} | GetVBRRestorePoint | where {$_.name -eq "VM1"} | Sort-Object creationtime Descending | Select-Object -First 1 | Start-VBRWindowsFileRestore
PS C:\PS> $flrmountpoint = ($result.MountSession.MountedDevices | ?
{$_.DriveLetter -eq (Split-Path -Qualifier $origfile)}).MountPoint
PS C:\PS> $file = $flrmountpoint + (Split-Path -NoQualifier $origfile)
PS C:\PS> Copy $file c:\
PS C:\PS> Stop-VBRWindowsFileRestore $result
Start-VBRZip
Short Description
Performs VeeamZIP on the selected VM.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
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
Detailed Description
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Backup
Repository
False
Named
False
False
Entity
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
RunAsync
False
Named
False
False
Folder
False
Named
False
False
EncryptionKey
False
Named
False
False
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 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.
PS C:\PS> 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 RunAsync parameter is set to bring the process to
the background.
PS C:\PS> Start-VBRZip -Folder "D:\Repository\VeeamZIP" -Entity $vm Compression 4 -DisableQuiesce -RunAsync
Start-VSBJob
Short Description
Starts a created SureBackup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Start-VSBJob [-Job] <CSbJob[]> [-RunAsync] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet allows you to start a created SureBackup job.
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
RunAsync
Accept
Pipeline
Input
<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 starts the SureBackup jobs named "SharePoint SureJob 01" and "SharePoint SureJob
02". The jobs are obtained with Get-VSBJob and piped down.
PS C:\PS> 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.
PS C:\PS> Start-VSBJob -Job $SureJob
Stop-VBRInstantRecovery
Short Description
Stops a running instant VM recovery process.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Stop-VBRInstantRecovery [-InstantRecovery] <InstantRecovery[]> [-RunAsync]
[-WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Related Commands
Get-VBRInstantRecovery
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Instant
Recovery
True
True
(ByValue,
ByProperty
Name)
False
RunAsync
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 stops the last instant recovery session. The needed session object is obtained with GetVBRInstantRecovery, selected by order and piped down.
PS C:\PS> 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.
PS C:\PS> Stop-VBRInstantRecovery -InstantRecovery $"Recovery Session"
Stop-VBRJob
Short Description
Stops a running backup, replication or copy job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Stop-VBRJob [-Job] <CBackupJob[]> [-RunAsync] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
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.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
RunAsync
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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.
753 | Veeam Backup PowerShell | Reference | REV 1
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.
PS C:\PS> 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.
PS C:\PS> Stop-VBRJob -Job $"SharePoint File Copy Job"
Stop-VBRLinuxFileRestore
Short Description
Finalizes non-Windows VM guest OS file restore.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Stop-VBRLinuxFileRestore -LinuxFlrObject <VBRLinuxFlrObject> [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Detailed Description
This cmdlet terminates non-Windows VM guest OS file restore process started with StartVBRLinuxFileRestore.
When you terminate the non-Windows VM guest OS file restore, Veeam Backup & Replication
unmounts virtual disks and powers the proxy appliance off. Note that you cannot restore files after the
disks are unmounted.
Parameters
Parameter
LinuxFlr
Object
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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
This command stops a file restore session initiated with Start-VBRLinuxFileRestore.
This example uses the '$linuxflr' variable that contains the object of the restore session. The session
object was saved to the variable during the restore session start.
PS C:\PS> Stop-VBRLinuxFileRestore -LinuxFlrObject $linuxflr
Stop-VBRReplicaFailover
Short Description
Undoes the replica failover.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Stop-VBRReplicaFailover [-RestorePoint] <COib> [-RunAsync] [-Force] [WarningAction <ActionPreference>] [-WarningVariable <String>] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
RunAsync
False
Named
False
False
Force
False
Named
False
False
WhatIf
False
Named
False
False
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 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.
PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object
$_.creationtime -Descending | Select -First 1 | Stop-VBRReplicaFailover 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.
PS C:\PS> Stop-VBRReplicaFailover -RestorePoint $"WebServer_replica
restorepoint" -Reason "Data recovery" -RunAsync
Stop-VBRViReplicaFailback
Short Description
Undoes replica failback.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
PS C:\PS> Start-VBRViReplicaFailback -RestorePoint <COib> [-Reason
<string>] [-RunAsync] [-Complete] [-PowerOn] [-StoragePolicyAction
<VBRStoragePolicyAction> {Current | Stored | Default}] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
RunAsync
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
False
Named
False
False
Storage
Policy
Action
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 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.
PS C:\PS> Get-VBRRestorePoint -Name "WebServer_replica" | Sort-Object
$_.creationtime -Descending | Select -First 1 | Stop-VBRViReplicaFailback 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.
PS C:\PS> Stop-VBRViReplicaFailback -RestorePoint $"WebServer_replica
restorepoint" -RunAsync
Stop-VBRWindowsFileRestore
Short Description
Stops guest OS file recovery session for VMs running Windows.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides two parameter sets:
To unmount disks:
Detailed Description
This cmdlet finalizes the restore session initiated with Start-VBRWindowsFileRestore.
To finalize the restore session, you can use the following options:
Submit the session object.
You need to save the object of the restore session the moment you start the session.
If you have saved it to a variable, you can use it with the FileRestore parameter.
Submit the path to any of disks that were mounted during the restore.
You need to know a temporary path to at least one of the VM virtual disks that were
mounted during the restore session. Note that when you provide path to one virtual
disk, as the result of the cmdlet all disk of the VM will be unmounted.
This cmdlet provides syntax for both scenarios accordingly.
Parameters
Parameter
FileRestore
Description
Required Position
Accept
Accept
Pipeline Wildcard
Input
Characters
False
False
False
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
This command stops a file restore session initiated with Start-VBRWindowsFileRestore.
This example uses the $result variable that contains the object of the restore session. The session
object was saved to the variable during the restore session start.
PS C:\PS> Stop-VBRWindowsFileRestore $Result
Stop-VSBJob
Short Description
Stops running SureBackup job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Stop-VSBJob [-Job] <CSbJob[]> [-RunAsync] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VSBJob
Detailed Description
This cmdlet stops a running SureBackup job. The job is stopped once, the scheduled SureBackup job
will start the next scheduled time.
Run Start-VSBJob to start the job manually.
Run Stop-VBRJob to stop a backup, replication or copy job.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
True
(ByValue,
ByProperty
Name)
False
RunAsync
False
Named
False
False
WhatIf
False
Named
False
False
Confirm
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 stops the SureBackup job named "AD SureJob". The needed job object is obtained with
Get-VSBJob and piped down.
PS C:\PS> 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.
PS C:\PS> Stop-VSBJob -Job $"AD SureJob"
Sync-HP3Storage
Short Description
Rescans HPE 3PAR StoreServ storages.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
Syntax
Sync-HP3Storage [-Storage <CHp3PARHost>] [<CommonParameters>]
Related Commands
Get-HP3Storage
Detailed Description
This cmdlet rescans the selected HPE 3PAR StoreServ 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.
Parameters
Parameter
Storage
Description
Required Position
False
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 synchronizes the storage named "HPE Store 01". The storage object is obtained with
Get-HP3Storage and piped down.
PS C:\PS> Get-HP3Storage -Name "HPE 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.
PS C:\PS> Sync-HP3Storage -Storage $"store01"
Sync-HP3Volume
Short Description
Rescans HPE 3PAR StoreServ volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE 3PAR StoreServ
Syntax
Sync-HP3Volume -Volume <CSanVolume[]> [<CommonParameters>]
Related Commands
Get-HP3Volume
Detailed Description
This cmdlet rescans the selected HPE 3PAR StoreServ storage 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 HPE 3PAR StoreServ storage.
Parameters
Parameter
Volume
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 synchronizes the volume named "HPE Vol 01". The volume object is obtained with GetHP3Volume and piped down.
PS C:\PS> Get-HP3Volume -Name "HPE Vol 01" | Sync-HP3Volume
Example 2
This command synchronizes the volume named "HPE Vol 01". The volume object is obtained with GetHP3Volume and assigned to the variable beforehand.
PS C:\PS> Sync-HP3Volume -Volume $"HPE Vol 01"
Sync-HP4Storage
Short Description
Rescans HPE StoreVirtual storages.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
Syntax
Sync-HP4Storage -Storage <CHpP4Group> [<CommonParameters>]
Related Commands
Get-HP4Storage
Detailed Description
This cmdlet rescans the selected HPE StoreVirtual 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.
Alias
Sync-VBRHPStorage
Parameters
Parameter
Storage
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 synchronizes the storage named "HPE Store 01". The storage object is obtained with
Get-HP4Storage and piped down.
PS C:\PS> Get-HP4Storage -Name "HPE Store 01" | Sync-HP4Storage
Example 2
This command synchronizes the storage named "HPE Store 01". The storage object is obtained with
Get-HP4Storage and assigned to the variable beforehand.
PS C:\PS> Sync-HP4Storage -Storage $"HPE Store 01"
Sync-HP4Volume
Short Description
Rescans HPE StoreVirtual storage volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: HPE StoreVirtual
Syntax
Sync-HP4Volume -Volume <CSanVolume[]> [<CommonParameters>]
Related Commands
Get-HP4Volume
Detailed Description
This cmdlet rescans the selected HPE StoreVirtual storage 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 storage.
Alias
Sync-VBRHPVolume
Parameters
Parameter
Volume
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 synchronizes the volume named "HPE Vol 01". The volume object is obtained with GetHP4Volume and assigned to the variable beforehand.
PS C:\PS> Get-HP4Volume -Name "HPE Vol 01" | Sync-HP4Volume
Example 2
This command synchronizes the volume named "HPE Vol 01". The storage object is obtained with GetHP4Volume and piped down.
PS C:\PS> Sync-HP4Volume -Volume $"HPE Vol 01"
Sync-NetAppHost
Short Description
Rescans NetApp storage.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Sync-NetAppHost [-Host <CNaHost>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-NetAppHost
Detailed Description
This cmdlet rescans the selected NetApp storage to synchronize the 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.
To rescan the selected volumes only, run Sync-NetAppVolume.
Parameters
Parameter
Host
Description
Required Position
False
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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
This command synchronizes the storage named "NetApp Store 01".
The storage object is obtained with Get-NetAppHost and piped down.
PS C:\PS> Get-NetAppHost -Name "NetApp Store 01" | Sync-NetAppHost
Sync-NetAppVolume
Short Description
Rescans selected NetApp storage volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Sync-NetAppVolume -Volume <CSanVolume[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-NetAppVolume
Detailed Description
This cmdlet rescans the selected NetApp storage volume(s) to synchronize the 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.
To rescan the storage, run Sync-NetAppHost.
Parameters
Parameter
Volume
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
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
This command synchronizes the volume named "NetApp Vol 01".
The storage object is obtained with Get-NetAppVolume and piped down.
PS C:\PS> Get-NetAppVolume -Name "NetApp Vol 01" | Sync-NetAppVolume
Sync-VBRBackupCopyJob
Short Description
Synchronizes backup copy job data.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Sync-VBRBackupCopyJob -Job <IJob> [-FullBackup]
[<CommonParameters>]
Related Commands
Get-VBRJob
Detailed Description
This cmdlet starts manual data synchronization for the selected backup copy job.
The backup copy job runs continuously synchronizing the backup repositories in user-defined time
periods. With this cmdlet, you can synchronize the source and the target repositories manually.
Parameters
Parameter
Job
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
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 synchronizes the "AD Backup Copy" job using pipeline.
1.
2.
Pipe it to Sync-VBRBackupCopyJob.
Example 2
This command synchronizes the "AD Backup Copy" job using variable.
1.
2.
Example 3
This command creates an active full for the "AD Backup Copy" job.
3.
4.
Sync-VBRBackupRepository
Short Description
Rescans a selected backup repository.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Sync-VBRBackupRepository -Repository <CBackupRepository[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRBackupRepository
Detailed Description
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.
Parameters
Parameter
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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
Sync-VBRBackupToTapeJob
Short Description
Starts an active full for a selected GFS backup to tape job.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
This cmdlet provides 4 parameter sets.
Related Commands
Get-VBRTapeJob
Detailed Description
This cmdlet starts an active full for a selected backup period of a GFS backup to tape job. The job must
be targeted to a GFS media pool.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Job
True
Named
True (by
Value
FromPipeline)
False
Weekly
True
Named
False
False
Monthly
True
Named
False
False
Quarterly
True
Named
False
False
Yearly
True
Named
False
False
Wait
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.
Sync-VNXHost
Short Description
Rescans EMC VNX storages.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Sync-VNXHost -Host <CVnxHost>
[<CommonParameters>]
Related Commands
Get-VNXHost
Detailed Description
This cmdlet rescans a selected EMC VNX storage to synchronize its infrastructure with Veeam Backup
& Replication.
Rescanning discovers new or checks for deleted volumes and snapshots.
Run Sync-VNXVolume to rescan the selected volumes only.
Parameters
Parameter
Storage
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Sync-VNXVolume
Short Description
Rescans EMC VNX storage volumes.
Applies to
Platform: VMware
Product Edition: Standard, Enterprise, Enterprise Plus
Storage system: EMC VNX
Syntax
Sync-VNXVolume -Volume <CSanVolume[]>
[<CommonParameters>]
Related Commands
Get-VNXVolume
Detailed Description
This cmdlet rescans selected EMC VNX storage volume(s) to synchronize the storage system
infrastructure with Veeam Backup & Replication.
Rescanning discovers new or checks for deleted snapshots.
Run Sync-VNXHost to rescan the storage.
Parameters
Parameter
Volume
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Undo-VBRFailoverPlan
Short Description
Undoes the failover by failover plan.
Applies to
Platform: VMware, Hyper-V
Product Edition: Enterprise, Enterprise Plus
Syntax
Undo-VBRFailoverPlan -FailoverPlan <VBRFailoverPlan[]> [-Wait] [-WhatIf] [Confirm] [<CommonParameters>]
Related Commands
Get-VBRFailoverPlan
Return Type
VBRBackupSession[]
Detailed Description
This cmdlet undoes the failover process. Undoing failover switches the workload back to source VMs.
All changes that were made to the replicas during failover are discarded.
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. Note that failback is not a group process and
must be performed for each VM individually.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
Named
False
False
False
Named
False
False
Accepts VBRFailoverPlan.
You can assign multiple plans to this
object.
Wait
WhatIf
Confirm
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 undoes the failover process by failover plan named "MS Exchange Group Failover". The
failover plan is obtained with Get-VBRFailoverPlan and piped down.
PS C:\PS> Get-VBRFailoverPlan -Name "MS Exchange Group Failover" | UndoVBRFailoverPlan
Example 2
This command undoes the failover process represented by the '$MSExchangeGroup' variable. The
failover plan is obtained with Get-VBRFailoverPlan and assigned to the variable beforehand.
PS C:\PS> Undo-VBRFailoverPlan -FailoverPlan $MSExchangeGroup
Example 3
This command undoes failover processes by failover plans named "MS Exchange Group Failover" and
"SQLServers Group Failover". The VM groups are processed one by one.
The failover plans are obtained with Get-VBRFailoverPlan and piped down.
The Wait parameter is used to undo the failover processes one after the other.
PSCryptoKey
This object contains the encryption key.
Transforms to the VBREncryptionKey object.
Properties
Property
Type
Description
Id
GUID
Description
string
EncryptedPassword
string
ModificationDateUtc
DateTime
VBRApplicationRestorePoint
This object contains the restore point created with the VSS-aware image processing enabled.
Related Commands
Get-VBRApplicationRestorePoint
Properties
Property
Type
Description
IsExchange
bool
IsActiveDirectory
bool
IsSharePoint
bool
IsSQL
bool
IsOracle
bool
DateTime
CreationTime
Type
VBRRestorePointType
IsIndexed
bool
IsCorrupted
bool
Name
string
Id
GUID
VBRBackupSession
This object contains job session.
Related Commands
Get-VBRSession
Properties
The "?" mark indicates that the type property accepts zero values.
Property
Type
Description
CreationTime
DateTime
EndTime
DateTime?
JobId
GUID
Progress
int32
Result
VBRSessionResult
RunManually
State
bool
VBRSessionState
Log
VBRLogItem []
None
Success
Warning
Failed.
Stopped
Starting
Stopping
Working
Pausing
Resuming
WaitingTape
Idle
Postprocessing
WaitingRepository.
VBRBackupToTapeJob
This object contains backup to tape job.
Related Commands
Add-VBRBackupToTapeJob
Properties
Property
FullBackupPolicy
Object
ProcessIncrementalBackup
ScheduleOptions
WaitForBackupJobs
WaitPeriod
Type
Description
VBRFullBackupToTapePolicy
CBackupJob[]
or
CBackupRepository[]
bool
TimeSpan
EjectCurrentMedium
bool
ExportCurrentMediaSet
bool
DayOfWeek[]
ExportDays
FullBackupMediaPool
IncrementalBackupMediaPool
UseHardwareCompression
NextRun
Target
Type
VBRTapeMediaPool
or
VBRTapeGFSMediaPool
VBRTapeMediaPool
bool
DateTime?
Object
VBRJobType
Property
LastResult
Type
Description
VBRSessionResult
LastState
VBRSessionState
None
Success
Warning
Failed.
Stopped
Starting
Stopping
Working
Pausing
Resuming
WaitingTape
Idle
Postprocessing
WaitingRepository.
Id
GUID
Name
string
Description
string
AlwaysCopyFromLatestFull
bool
GFSScheduleOptions
VBRTapeGFSScheduleOptions
NotificationOptions
VBRNotificationOptions
VBRJobScriptOptions
JobScriptOptions
VBRBackupToTapeScheduleOptions
This object contains schedule settings for backup to tape job.
Related Commands
New-VBRBackupToTapeScheduleOptions
Properties
Property
Type
Type
Description
VBRBackupToTapePolicyType
DailyOptions
MonthlyOptions
BackupWindowOptions
JobId
Enabled
VBRDailyOptions
VBRMonthlyOptions
VBRBackupWindowOptions
GUID?
bool
AfterJob
AfterNewBackup
Daily
Monthly.
VBRBackupWindowOptions
This object contains backup window settings passed to the jobs.
Related Commands
New-VBRBackupWindowOptions
This object does not have user accessible properties.
VBRCloudCertificate
This object contains the cloud SSL certificate. The object is a Microsoft X509Certificate2 class.
For more information about the Microsoft X509Certificate2 class, see https://msdn.microsoft.com/enus/library/system.security.cryptography.x509certificates.x509certificate2.
VBRCloudDatastore
This object contains the storage resources provided to the tenant on the service provider's cloud
server.
Related Commands
Get-VBRCloudDatastore
Properties
Property
Type
Description
CloudServerId
GUID
Capacity
int32
FreeSpace
int32
Platform
VBRPlatform
Name
string
Id
GUID
VBRCloudFailoverPlan
This object contains cloud failover plan.
Properties
Property
Type
Description
PublicIpEnabled
bool
ProviderId
GUID
Platform
Status
VBRPlatform
string
FailoverPlanObject
In progress
Undo in progress
Completed
Ready
Failed
Undo failed.
VBRCloudFailoverPlanObject[]
VMCount
int32
PrefailoverCommand
string
PostfailoverCommand
string
Type
VBRFailoverPlanType
Id
GUID
Name
string
Description
sting
VBRCloudFailoverPlanObject
This object contains cloud replica VMs added to a cloud failover plan.
Properties
Property
ProviderId
PublicIpRule
Item
Type
Description
GUID
VBRFailoverPlanPublicIPRule[]
IItem
BootOrder
int
BootDelay
int
VBRCloudGateway
This object contains cloud gateway.
Properties
Property
Host
Type
Description
CWinServer
Enabled
bool
NATPort
int
IncomingPort
int
string
IPAddress
NetworkMode
VBRGatewayNetworkMode
Direct
NAT.
Id
GUID
Name
string
Description
string
VBRCloudIP
This object contains the public IP address from the public IP addresses pool.
Related Commands
Add-VBRCloudPublicIP
Get-VBRCloudPublicIP
Remove-VBRCloudPublicIP
Properties
Property
Type
Description
Id
GUID
IpAddress
string
The IP address.
TenantId
GUID?
VBRCloudProvider
This object contains cloud provider.
Properties
Property
Type
Description
IpAddress
IPAddress
DNSName
string
int
Credentials
CCredentials
Certificate
VBRCloudCertificate
Port
ResourcesEnabled
bool
ReplicationPesourcesEnabled
bool
Resources
ReplicationResources
VBRCloudProviderResource[]
VBRCloudProviderReplicationReso
urce[]
Id
GUID
Description
string
VBRCloudProviderDatastore
This object contains array of datastores used for storing user data.
Related Objects
VBRCloudProviderReplicationResource
Properties
Property
Type
Description
DatastoreAllocatedSpace
int32
Name
string
Id
GUID
VBRCloudProviderReplicationResource
This object contains replication resources provided under a hardware plan.
Related Objects
VBRCloudProvider
Properties
Property
Type
Description
HardwarePlanName
string
CPU
int32
Memory
int32
VBRCloudProviderDatastore[]
NetworkCount
int32
PublicIpEnabled
bool
string[]
bool
Datastore
PublicIp
WanAcceleratorEnabled
VBRCloudProviderResource
This object contains cloud provider settings.
Related Objects
VBRCloudProvider
Properties
Property
RepositoryName
RepositoryAllocatedSpace
WanAcceleratorEnabled
Type
Description
string
int
bool
VBRCloudServer
This object contains the cloud server of the service provider.
Related Commands
Get-VBRCloudServer
Properties
Property
Type
Description
CloudProviderId
GUID
ApiVersion
string
CPU
int32
Memory
int32
Platform
VBRPlatform
Name
string
Id
GUID
VBRCloudServerNetworkInfo
This object contains networks connected to the cloud server of the service provider.
Related Commands
Get-VBRCloudServerNetworkInfo
Properties
Property
Platform
CloudServerId
Type
Description
VBRPlatform
GUID
Type
VBRViNetworkInfoType
Name
string
Id
GUID
VBRCloudTenant
This object contains the cloud tenant.
Properties
Property
Type
Description
Enabled
bool
LeaseExpirationEnabled
bool
LeaseExpirationDate
DateTime?
Password
string
Resources
VBRCloudTenantResource[]
VMCount
int
LastActive
string
LastResult
string
None
Success
Warning
Failed.
ResourcesEnabled
bool
ReplicationResourcesEnabled
bool
ThrottlingEnabled
bool
ThrottlingValue
ReplicationResources
decimal
VBRCloudTenantReplicationReso
urces
Id
GUID
Name
string
Description
string
VBRCloudTenantHwPlanOptions
This object contains the hardware plan options assigned to a tenant.
Related Commands
New-VBRCloudTenantHwPlanOptions
Properties
Property
HardwarePlan
WanAcceleratorEnabled
WanAccelerator
Type
Description
VBRCloudHardwarePlan
bool
CWanAccelerator
UsedCPU
int
UsedMemory
int
DatastoreQuota
VBRCloudDatastoreQuota[]
VBRCloudTenantNetworkAppliance
This object contains the network appliance on the tenant side.
Related Commands
Get-VBRCloudTenantNetworkAppliance
Set-VBRCloudTenantNetworkAppliance
The network appliance is created automatically by New-VBRCloudTenantReplicationResources when
you enable network failover resources.
Properties
Property
Host
Type
Description
CHost, CViClusterItem
TenantId
GUID
HardwarePlanId
GUID
IVBRServerNetworkInfo
ProductionNetwork
ObtainIpAddressAutomatically
bool
IpAddress
string
SubnetMask
string
DefaultGateway
string
Platform
VBRPlatform
VBRCloudTenantReplicationResources
This object contains the replication resources assigned to a tenant.
Related Commands
New-VBRCloudTenantReplicationResources
Properties
Property
NetworkFailoverResourcesEnabl
ed
HardwarePlanOptions
PublicIpEnabled
NumberOfPublicIp
TenantNetworkAppliance
Type
Description
bool
VBRCloudTenantHwPlanOptions[]
bool
int
VBRCloudTenantNetworkApplianc
e[]
VBRCloudTenantResource
This object contains the cloud user backup resources.
Properties
Property
Repository
Type
Description
CBackupRepository
RepositoryFriendlyName
string
RepositoryQuota
string
RepositoryQuotaPath
string
UsedSpace
int
UsedSpacePercentage
int
WanAccelerationEnabled
WanAccelerator
bool
CWanAccelerator
VBRConfigurationBackupJob
This object contains the configuration backup job.
Properties
Property
Enabled
Repository
ScheduleOptions
RestorePointsToKeep
EncryptionOptions
Type
Description
bool
CBackupRepository
VBRConfigurationBackupSchedule
Options
int
VBREncryptionOptions
VBRConfigurationBackupScheduleOptions
This object contains schedule settings of the configuration backup job.
Properties
Property
DailyOptions
MonthlyOptions
Enabled
Type
Type
Description
VBRDailyOptions
VBRMonthlyOptions
bool
VBRConfigurationBackup
ScheduleType
Daily
Monthly.
VBRDailyOptions
This object contains the job daily schedule settings.
Related Commands
New-VBRDailyOptions
Properties
Property
Type
Type
Description
VBRDailyOptionsType
Period
DayOfWeek
TimeSpan
DayOfWeek[]
Everyday
WeekDays
SelectedDays.
VBRDatabaseRestoreInterval
This object contains the date and time of the first and the last available restore point of a database.
Related Commands
Get-VBRSQLDatabaseRestoreInterval
Properties
Property
Type
Description
From
DateTime
To
DateTime
VBRDataLocalityExtent
This object contains extent of a scale-out backup repository with Data locality policy.
Related Commands
Get-VBRRepositoryExtent
Set-VBRRepositoryExtent
Properties
Property
Id
Type
Description
GUID
ParentId
GUID
Repository
Status
CBackupRepository
VBRRepositoryExtentStatus
VBRDefaultGateway
This object contains default gateway.
Related Commands
Get-VBRDefaultGatewayConfiguration
Properties
Property
Type
Description
IpAddress
string
NetworkMask
string
Name
string
Id
GUID
VBRDefaultGatewayConfiguration
This object contains default gateway configuration.
Related Commands
Get-VBRDefaultGatewayConfiguration
Properties
Property
Type
Description
ProviderId
GUID
RoutingEnabled
bool
DefaultGateway
VBRDefaultGateway[]
VBREncryptionOptions
This object contains the encryption options.
Properties
Property
Enabled
Key
Type
Description
bool
VBREncryptionKey
VBREPJob
This object contains Endpoint job.
Properties
The "?" mark indicates that the type property accepts zero values.
Property
Type
Description
RepositoryId
GUID
ObjectsCount
int
IsEnabled
bool
NextRun
DateTime?
Target
Type
LastResult
Object
VBRJobType
VBRSessionResult
LastState
VBRSessionState
None
Success
Warning
Failed.
Stopped
Starting
Stopping
Working
Pausing
Resuming
WaitingTape
Idle
Postprocessing
WaitingRepository.
Id
GUID
Name
string
Description
string
VBREPPermission
This object contains user access permissions for backup repositories used by Endpoint backup jobs.
Related Commands
Get-VBREPPermission
Set-VBREPPermission
Properties
Property
RepositoryId
PermissionType
Type
Description
GUID
VBREPPermissionType
Users
IsEncryptionEnabled
EncryptionKey
string[]
bool
VBREncryptionKey
Everyone
NoOne
OnlySelectedUsers.
VBRFailoverPlan
This object contains the failover plan.
Properties
Property
Type
Description
Id
GUID
Name
string
Description
string
Platform
Status
VBRPlatform
string
FailoverPlanObject
VMCount
In progress
Undo in progress
Completed
Ready
Failed
Undo failed.
VBRFailoverPlanObject[]
integer
PrefailoverCommand
string
PostfailoverCommand
string
Type
VBRFailoverPlanType
VBRFailoverPlanObject
This object contains the VM that you want to add to a failover plan and settings that will be applied
when processing the VM during the failover: the boot order and the delay time.
Properties
Property
Item
Type
Description
IItem
BootOrder
int
BootDelay
int
VBRFailoverPlanPublicIPRule
This object contains IP addresses and ports mapping rule.
Related Commands
New-VBRFailoverPlanPublicIPRule
Properties
Property
Type
Description
SourceIp
string
SourcePort
UInt16
TargetIp
string
TargetPort
UInt16
Description
string
VBRFileToTapeBackupPolicy
This object contains schedule settings for file to tape job.
Related Commands
New-VBRFileToTapeBackupPolicy
Properties
Property
Type
Description
Type
VBRFileToTapeBackupPolicyType
DailyOptions
MonthlyOptions
Enabled
VBRDailyOptions
Daily
Monthly.
VBRMonthlyOptions
bool
VBRFileToTapeJob
This object contains file to tape job.
Related Commands
Add-VBRFileToTapeJob
Get-VBRTapeJob
Set-VBRFileToTapeJob
Properties
Property
Type
Description
FullBackupPolicy
VBRFullBackupToTapePolicy
IncrementalBackupPolicy
VBRFileToTapeBackupPolicy
Object
VBRFileToTapeObject[]
UseVss
bool
EjectCurrentMedium
bool
ExportCurrentMediaSet
bool
ExportDays
DayOfWeek[]
FullBackupMediaPool
VBRTapeMediaPool
IncrementalBackupMediaPool
VBRTapeMediaPool
UseHardwareCompression
NextRun
Target
Type
LastResult
bool
DateTime?
Object
VBRJobType
VBRSessionResult
LastState
VBRSessionState
None
Success
Warning
Failed.
Stopped
Property
Type
Description
Starting
Stopping
Working
Pausing
Resuming
WaitingTape
Idle
Postprocessing
WaitingRepository.
Id
GUID
Name
string
Description
string
NotificationOptions
JobScriptOptions
VBRNotificationOptions
VBRJobScriptOptions
VBRFileToTapeObject
This object contains file system objects passed to the file to tape jobs.
Related Commands
New-VBRFileToTapeObject
Properties
Property
Type
Description
IncludeMask
string
Path
string
IsDirectory
bool
Server
Credentials
CHost
CCredentials
VBRFullBackupToTapePolicy
This object contains schedule settings for creating synthesized full backups for backup to tape job.
Related Commands
New-VBRFullBackupToTapePolicy
Properties
Property
Type
Description
Type
VBRFullBackupToTapePolicyType
Monthly
WeeklyOnDays.
WeeklyOnDays
DayOfWeek[]
MonthlyOptions
VBRMonthlyOptions
VBRGlobalMediaPoolOptions
This object contains global media pool settings.
Related Objects
VBRTapeGFSMediaPool
VBRTapeMediaPool
Properties
Property
Type
Description
NextLibOffline
bool
NestLibDrivesBusy
bool
NextLibNoMedia
bool
LibraryId
GUID[]
VBRHvCloudHardwarePlan
This object contains Hyper-V hardware plan.
Properties
Property
Type
Description
Id
GUID
Name
string
Description
string
Datastore
CPU
int
Memory
int
NumberOfNetWithInternet
int
NumberOfNetWithoutInternet
int
SubscribedTenantId
GUID[]
Host
CHost
Platform
VBRPlatform
VBRHvCloudHardwarePlanDatastore
This object contains datastore used by a Hyper-V hardware plan.
Related Commands
New-VBRHvCloudHWPlanDatastore
New-VBRViCloudHWPlanDatastore
Properties
Property
Type
Description
Id
GUID
Datastore
string
FriendlyName
string
Quota
Platform
int
VBRPlatform
VBRHvCloudProviderNetworkAppliance
This object contains Hyper-V network appliance on the service provider side.
Properties
Property
Type
Description
Folder
string
VLanId
int32
Host
CHost
Network
IVBRServerNetworkInfo
IpAddress
string
SubnetMask
string
DefaultGateway
string
Platform
VBRPlatform
ObtainIpAddressAutomatically
bool
Name
string
Id
GUID
VBRHvCloudVLANConfiguration
This object contains the Hyper-V VLAN settings.
Properties
Property
Host
VirtualSwitch
Platform
Type
Description
CHost
VBRHvServerNetworkInfo
VBRPlatform
FirstVLANWithInternet
int32
LastVLANWithInternet
int32
FirstVLANWithoutInternet
int32
LastVLANWithoutInternet
int32
Id
GUID
VBRJob
The global object containing Veeam job.
Properties
The "?" mark indicates that the type property accepts zero values.
Property
NextRun
Target
Type
Type
Description
DateTime?
Object
VBRJobType
LastResult
VBRSessionResult
LastState
VBRSessionState
None
Success
Warning
Failed
Session state:
BackupToTape
FileToTape
TapeCatalog
TapeEject
TapeErase
TapeExport
TapeImport
TapeInventory
TapeRescan
Backup
BackupSync
EndpointBackup
ConfigurationBackup
Stopped
Starting
Stopping
Working
Pausing
Resuming
WaitingTape
Idle
Postprocessing
WaitingRepository
VBRJobScriptOptions
This object contains job scripts options.
Related Commands
New-VBRJobScriptOptions
Properties
Property
Type
Description
PreScriptEnabled
bool
PreCommand
string
PostScriptEnabled
bool
PostCommand
string
Days
DaysOfWeek[]
Periodicity
VBRPeriodicityType
Frequency
UInt
VBRLogItem
This object contains a job session log.
Created by
Properties
Property
Type
Description
Id
int32
Usn
int32
Title
string
Description
string
Not supported.
Time
DateTime
StartTime
DateTime
Status
VBRLogStatus
None
Success
Warning
Failed.
VBRMonthlyOptions
This object contains the job monthly schedule settings.
Related Commands
New-VBRMonthlyOptions
Properties
Property
Period
DayOfWeek
DayNumberInMonth
Type
Description
Timespan
DayOfWeek
VBRDayNumberInMonth
Months
VBRMonth[]
First
Second
Third
Fourth
Last
OnDay.
VBRMultiStreamingOptions
This object contains multistreaming options set for a media pool.
Related Objects
VBRTapeMediaPool
Properties
Property
EnableMultiStreaming
NumberOfStreams
SplitJobFilesBetweenDrives
Type
Description
bool
int
bool
Indicates if multistreaming is
enabled.
The maximum number of drives
that can be used by the media pool
simultaneously.
Indicates if the tape job data will
be written with miltiple drives.
VBRNotificationOptions
This object contains notification options.
Related Commands
New-VBRNotificationOptions
Properties
Property
EnableAdditionalNotification
AdditionalAddress
UseNotificationOptions
Type
Description
bool
string[]
bool
NotifyOnSuccess
NotifyOnWarning
NotifyOnError
NotifyOnLastRetryOnly.
NotificationSubject
string
NotifyOnSuccess
bool
NotifyOnWarning
bool
NotifyOnError
bool
NotifyOnLastRetryOnly
bool
VBRPerformanceExtent
This object contains extent of a scale-out backup repository with Performance policy.
Related Commands
Get-VBRRepositoryExtent
Set-VBRRepositoryExtent
Properties
Property
Id
Type
Description
GUID
ParentId
GUID
Repository
Status
CBackupRepository
VBRRepositoryExtentStatus
StoreFull
bool
StoreIncrement
bool
VBRRepositoryExtent
This is a basic object containing scale-out backup repository extent.
Related Objects
VBRDataLocalityExtent
VBRPerformanceExtent
Properties
Property
Id
Type
Description
GUID
ParentId
GUID
Repository
Status
CBackupRepository
VBRRepositoryExtentStatus
VBRScaleOutBackupRepository
This object contains scale-out backup repository.
Properties
Property
Type
Description
Id
GUID
Name
string
Description
string
PolicyType
VBRScaleOutBackup
RepositoryPolicyType
VBRRepositoryExtent
UsePerVMBackupFiles
bool
PerformFullWhenExtentOffline
bool
Extent
DataLocality
Performance.
VBRSession
This object contains Endpoint backup job session.
Related Commands
Get-VBRSession
Properties
The "?" mark indicates that the type property accepts zero values.
Property
ID
State
Type
Description
GUID
VBRSessionState
Result
VBRSessionResult
JobId
GUID
Stopped
Starting
Stopping
Working
Pausing
Resuming
WaitingTape
Idle
Postprocessing
WaitingRepository.
None
Success
Warning
Failed.
CreationTime
DateTime
EndTime
DateTime?
VBRSQLDatabase
This object contains database in backup.
Related Commands
Get-VBRSQLDatabase
Properties
Property
Type
Description
RestorePoint
GUID
ServerName
string
InstanceName
string
IsSystem
bool
IsReadonly
bool
CreationTime
DateTime
Name
string
Id
GUID
VBRTapeDrive
This object contains a tape library drive.
Properties
Property
Address
Type
Description
int
Device
string
Enabled
bool
IsLocked
bool
LibraryId
GUID
Medium
VBRTapeMedium
Model
string
SerialNumber
string
State
VBRTapeDriveState
Loaded
Empty.
Id
GUID
Name
string
Description
string
VBRTapeGFSMediaPool
This object contains GFS media pool.
Related Commands
Add-VBRTapeGFSMediaPool
Set-VBRTapeGFSMediaPool
Remove-VBRTapeMediaPool
Properties
Property
Type
Description
Name
string
Description
string
LibraryId
GUID
MoveFromFreePool
bool
WeeklyMediaSetOptions
VBRTapeGFSMediaSetOptions
MonthlyMediaSetOptions
VBRTapeGFSMediaSetOptions
QuarterlyMediaSetOptions
VBRTapeGFSMediaSetOptions
YearlyMediaSetOptions
VBRTapeGFSMediaSetOptions
EncryptionOptions
GlobalOptions
VBREncryptionOptions
VBRGlobalMediaPoolOptions
VBRTapeGFSMediaSetOptions
This object contains GFS media set options.
Related Objects
VBRTapeGFSMediaPool
Properties
Property
Type
Description
OverwritePeriod
int
MediaSetPolicy
VBRTapeGFSMediaSetPolicy
VBRTapeGFSMediaSetPolicy
This object contains advanced options of GFS media set.
Related Commands
New-VBRTapeMediaSetCreationPolicy
Properties
Property
Medium
Type
Description
VBRTapeMedium[]
MoveFromMediaPoolAutomatic
ally
bool
Name
string
AppendToCurrentTape
bool
MoveOfflineToVault
bool
VBRTapeVault
Vault
VBRTapeGFSScheduleMonthlyOptions
This object contains monthly schedule options for tape jobs targeted to a GFS media pool.
Related Objects
VBRTapeGFSScheduleOptions
Properties
Property
Kind
Type
Description
VBRGFSMonthlyKind
DayOfWeek
DayOfWeekNumber
DayOfWeek
VBRDayNumberInMonth
DayOfMonth
string
on a selected day in
month, for example, the
first Sunday of month
(DayOfWeek)
on a selected date, for
example, on the 1st
(DayOfMonth).
First
Second
Third
Forth/Last.
VBRTapeGFSScheduleOptions
This object contains schedule options for tape jobs targeted to a GFS media pool.
Related Objects
VBRTapeGFSScheduleMonthlyOptions
VBRTapeGFSScheduleQuarterlyOptions
VBRTapeGFSScheduleWeeklyOptions
VBRTapeGFSScheduleYearlyOptions
Properties
Property
Type
Description
WeeklyOptions
MonthlyOptions
QuarterlyOptions
YearlyOptions
VBRTapeGFSScheduleQuarterlyOptions
This object contains quarterly schedule options for tape jobs targeted to a GFS media pool.
Related Objects
VBRTapeGFSScheduleOptions
Properties
Property
Kind
Type
Description
VBRGFSQuarterlyKind
DayOfWeekNumber
VBRDayNumberInMonth
DayOfWeek
DayOfWeek
DayOfMonth
string
MonthOfQuarter
VBRGFSMonthOfQuarter
First
Second
Third
Fourth
Last.
First
Last.
VBRTapeGFSScheduleWeeklyOptions
This object contains weekly schedule options for tape jobs targeted to a GFS media pool.
Related Objects
VBRTapeGFSScheduleOptions
Properties
Property
WeeklyDay
StartAt
Type
Description
DayOfWeek
TimeSpan
VBRTapeGFSScheduleYearlyOptions
This object contains yearly schedule options for tape jobs targeted to a GFS media pool.
Related Objects
VBRTapeGFSScheduleOptions
Properties
Property
Kind
Type
Description
VBRGFSYearlyKind
DayOfWeekNumber
VBRDayNumberInMonth
DayOfWeek
DayOfWeek
DayOfMonth
string
MonthOfYear
VBRMonth
First
Second
Third
Fourth
Last.
VBRTapeLibrary
This object contains a tape library.
Properties
Property
Drives
Type
Description
VBRTapeDrive[]
Enabled
bool
Model
string
Slots
TapeServerId
Type
int
GUID
VBRTapeLibraryType
State
VBRTapeLibraryState
Automated
StandaloneDrive.
Online
Offline.
Id
GUID
Name
string
Description
string
VBRTapeMediaPool
This object contains media pool.
Related Commands
Add-VBRTapeMediaPool
Get-VBRTapeMediaPool
Remove-VBRTapeMediaPool
Set-VBRTapeMediaPool
Properties
Property
Capacity
Type
Description
int64
VBREncryptionOptions
FreeSpace
int64
LibraryId
GUID
EncryptionOptions
MediaSetCreationPolicy
MediaSetName
Medium
VBRTapeMediaSetCreationPolicy
string
VBRTapeMedium
MoveFromFreePool
bool
MoveOfflineToVault
bool
RetentionPolicy
VBRTapeMediaPoolRetentionPoli
cy
Vault
VBRTapeVault
Type
VBRTapeMediaPoolType
MultiStreamingOptions
VBRMultiStreamingOptions
Unrecognized
Free
Retired
Custom
Imported
Gfs.
Property
Type
Description
applied to this media pool.
GlobalOptions
VBRGlobalMediaPoolOptions
VBRTapeMediaPoolRetentionPolicy
This object contains the retention settings of media pool.
Related Commands
New-VBRTapeMediaPoolRetentionPolicy
Properties
Property
Type
Description
Type
VBRTapeMediaPoolRetentionTyp
e
Period
VBRTapeMediaPooPeriod
Value
int32
Never
Period
Cyclic.
None
Days
Weeks
Months.
VBRTapeMediaSetCreationPolicy
This object contains the set of rules for creating media sets.
Related Commands
New-VBRTapeMediaSetCreationPolicy
Properties
Property
Type
Description
Type
VBRTapeMediaPoolRetentionTyp
e
DailyOptions
VBRDailyOptions
Never
Always
Daily
Monthly.
VBRTapeMedium
This object contains tape.
Properties
The "?" mark indicates that the type property accepts zero values.
Property
Type
Description
Barcode
string
Capacity
int64
Description
string
ExpirationDate
DateTime?
Free
int64
HasBarcode
bool
Id
GUID
IsExpired
bool
IsFree
bool
IsFull
bool
IsLocked
bool
IsRetired
bool
LastWriteTime
DateTime?
LibraryId
GUID
Location
VBRTapeMediumLocation
MediaPoolId
MediaSet
Name
GUID
VBRTapeMediaSet
string
Property
Type
Description
PreviousLibraryId
GUID?
PreviousMediaPoolId
GUID?
ProtectedByHardware
bool
ProtectedBySoftware
bool
SequenceNumber
int?
VBRTapeServer
This object contains a tape server.
Properties
Property
Type
Description
Id
GUID
Name
string
Description
string
ServerId
GUID
IsAvailable
bool
VBRTapeVault
This object contains a tape vault.
Properties
Property
Type
Description
Id
GUID
Name
string
Description
string
Location
string
Medium
VBRTapeMedium[]
VBRTenantFailoverPlan
This object contains failover plan of a tenant on the service provider side.
Properties
Property
Type
Description
TenantId
GUID
Platform
VBRPlatform
Status
string
FailoverPlanObject
In progress
Undo in progress
Completed
Ready
Failed
Undo failed.
VBRCloudFailoverPlanObject[]
VMCount
int32
PrefailoverCommand
string
PostfailoverCommand
string
Type
VBRFailoverPlanType
Id
GUID
Name
string
Description
sting
VBRViCloudHardwarePlan
This object contains VMware hardware plan.
Properties
Property
Type
Description
Id
GUID
Name
string
Description
string
Datastore
VBRViCloudHardwarePlanDatastor
e[]
CPU
int
Memory
int
NumberOfNetWithInternet
int
NumberOfNetWithoutInternet
int
GUID[]
SubscribedTenantId
Host
Platform
CHost
or
CViClusterItem
VBRPlatform
VBRViCloudHardwarePlanDatastore
This object contains datastore used by a VMware hardware plan.
Related Commands
New-VBRViCloudHWPlanDatastore
Properties
Property
Type
Description
Id
GUID
Datastore
string
StoragePolicy
VBRViStoragePolicy
FriendlyName
string
Quota
Platform
int
VBRPlatform
VBRViCloudProviderNetworkAppliance
This object contains VMware network appliance on the service provider side.
Properties
Property
Datastore
ResourcePool
Host
Network
Type
Description
VBRViDatastore
CViResourcePoolItem
CHost
IVBRServerNetworkInfo
IpAddress
string
SubnetMask
string
DefaultGateway
string
Platform
VBRPlatform
ObtainIpAddressAutomatically
bool
Name
string
Id
GUID
VBRViCloudVLANConfiguration
This object contains the Hyper-V VLAN settings.
Properties
Property
Host
VirtualSwitch
Platform
Type
Description
CHost
VBRHvServerNetworkInfo
VBRPlatform
FirstVLANWithInternet
int32
LastVLANWithInternet
int32
FirstVLANWithoutInternet
int32
LastVLANWithoutInternet
int32
Id
GUID
VBRViDatastoreCluster
This object contains datastore cluster.
Related Commands
Find-VBRViDatastoreCluster
Properties
Property
ConnHost
Type
Type
Description
CHost
VBRViType
Reference
string
Capacity
int64
FreeSpace
int64
Id
string
Path
string
Name
string
VBRViStoragePolicy
This object contains the VMware storage policy profile.
Related Commands
Find-VBRViStoragePolicy
Properties
Property
Type
Description
Id
String
Name
String
Description
String
UpdateTime
DateTime
GUID
HostId
VBRViVirtualSwitch
This object contains the VMware virtual switch.
Related Commands
Get-VBRViVirtualSwitch
Properties
Property
HostId
Type
Type
Description
GUID
VBRVirtualSwitchType
DVS
Simple.
Id
string
Name
string
OBSOLETE CMDLETS
Some cmdlets are obsolete in Veeam Backup & Replication v.9.0. Most of them work so that you do
not have your scripts fail, however it is suggested to rewrite your scripts using the new cmdlets.
This section contains the cmdlets that are obsolete for the Veeam Backup & Replication v.9.0.
Add-VBRBackupJob (obsolete)
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
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
Detailed Description
This cmdlet allows you to create a new backup job.
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
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
True
False
False
Type
False
False
False
True
False
False
Folder
False
False
False
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
Objects
True
Named
True
(ByValue,
ByProperty
Name)
False
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
This example allows you to create a backup job with the following parameters:
Variable which contains the target host DNS name or IP address: $server
Add-VBRJobObject (obsolete)
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
Platform: VMware
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
Detailed Description
This cmdlet allows you to add VMs or VM containers to existing backup, replication or copy job.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Job
True
False
False
Server
True
False
False
Objects
True
True
(ByValue,
ByProperty
Name)
False
True
True
(ByValue,
ByProperty
Name)
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 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-VBRReplicaJob (obsolete)
Short Description
Creates new replication job.
Note:
This cmdlet is obsolete and is not supported. In Veeam Backup & Replication v6 this cmdlet was
replaced by Add-VBRViReplicaJob and Add-VBRHvReplicaJob due to multihypervisor support
introduced in the new version.
Applies to
Platform: VMware
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
Detailed Description
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.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
True
False
False
Type
False
False
False
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
False
False
Datastore
True
False
False
Objects
True
Named
True
(ByValue,
ByProperty
Name)
False
False
Named
False
False
False
Named
False
False
Example
This example allows you to create a replication job with the following parameters:
Add-VBRTapeFilesJob (obsolete)
Short Description
Creates a new files to tape copy job.
Note:
This cmdlet is obsolete. It Veeam Backup & Replication v.8.0 it was replaced by AddVBRFileToTapeJob. The cmdlet will still work but it is advised to rewrite your scripts using the new
cmdlet for added benefits.
Applies to
Platform: VMware, Hyper-V
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
Detailed Description
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.
Note that when you create a copy job, you need to run it manually.
Run Start-VBRJob to start the created job.
Parameters
Parameter
Name
Description
Specifies the name you want to assign to the
new files to tape copy job.
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
True
Named
False
False
Path
True
Named
True
(ByValue,
ByProperty
Name)
False
Parameter
MediaPool
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
False
False
False
Named
False
False
Description
False
Named
False
False
Credentials
False
Named
False
False
Masks
False
Named
False
False
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 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-VBRTapeVMJob (obsolete)
Short Description
Creates a new backup to tape copy job.
Note:
This cmdlet is obsolete. In Veeam Backup & Replication v.8.0 it was replaced by AddVBRBackupToTapeJob. The cmdlet will still work but it is advised to rewrite your scripts using the
new cmdlet for added benefits.
Applies to
Platform: VMware, Hyper-V
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
Detailed Description
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.
Note that when you create a copy job, you need to run it manually.
Run Start-VBRJob to start the created job.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
False
Named
False
False
Repository
False
Named
True
(ByValue,
ByProperty
False
Parameter
Description
Required Position
Accept
Wildcard
Characters
Name)
False
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
False
False
Accept
Pipeline
Input
False
Named
False
False
Disable
Incremental
False
Named
False
False
False
Named
False
False
Description
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 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" | Add-VBRTapeVMJob 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-VSBApplicationGroup (obsolete)
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
Platform: VMware
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
Detailed Description
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.
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Name
True
False
False
Vm
True
True
(ByValue,
ByProperty
Name)
False
True
True
(ByValue,
ByProperty
Name)
<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 example allows you to create an application group with the following parameters:
False
Eject-VBRTapeDrive (obsolete)
Short Description
Ejects tape from the selected media drive.
Note:
This cmdlet is obsolete. The cmdlet will still work but it is advised to rewrite your scripts using the
Eject-VBRTapeMedium for added benefits.
Applies to
Platform: VMware, Hyper-V
Syntax
Eject-VBRTapeDrive -Drive <TapeDrive> [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeDrive
Detailed Description
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.
Parameters
Parameter
Drive
Description
Specifies the drive you want to eject.
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
True (ByValue,
ByProperty
Name)
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 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
Export-VBRConfiguration (obsolete)
Short Description
Starts configuration backup job.
Note:
This cmdlet is obsolete. In Veeam Backup & Replication v.9.0 it was replaced by the StartVBRConfigurationBackupJob cmdlets. The cmdlet will still work but it is advised to rewrite your
scripts using the new cmdlets for added benefits.
Applies to
Platform: VMware, Hyper-V
Product Edition: Standard, Enterprise, Enterprise Plus
Syntax
Export-VBRConfiguration [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
This cmdlet backs up current configuration of Veeam Backup & Replication 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. In case the Veeam Backup &
Replication host is failed or configuration is corrupted, you can restore configuration with this copy.
The configuration backup is job-driven. You can configure settings of the configuration backup job,
including schedule, in the main menu of the Veeam backup console. With Veeam PowerShell, you can
start a job session but you cannot change the settings.
By default, the configuration backup job runs daily. The resulting backup files are stored to the
C:\backup\VeeamConfigBackup\%BackupServer% folder on the Veeam backup default repository.
You cannot restore configuration with Veeam PowerShell. It is recommended to perform the restore
operation with Veeam Backup & Replication UI for full functionality.
<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 backs up current configuration of Veeam Backup & Replication host.
Export-VBRConfiguration
Find-VBRDatastore (obsolete)
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
Platform: VMware
Syntax
Find-VBRDatastore [-Server] <CHost> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns a list of all datastores connected to the specified ESX(i) host.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
True
(ByValue,
ByProperty
Name)
False
Name
False
Named
False
True
<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 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-VBRObject (obsolete)
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. The cmdlet will still work but it is advised
to rewrite your scripts using new cmdlets for added benefits.
Applies to
Platform: VMware
Syntax
Find-VBRObject [-Server] <CHost> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns a list of all VMs and VM containers on the specified ESX(i) host.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
True
(ByValue,
ByProperty
Name)
False
Name
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 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 (obsolete)
Short Description
Looks for VMware resource pools.
Note:
This cmdlet is obsolete. In Backup & Replication v6 this cmdlet was replaced by FindVBRViResourcePool.
Applies to
Platform: VMware
Syntax
Find-VBRResourcePool [-Server] <CHost> [-Name <String[]>] [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRServer
Detailed Description
This cmdlet returns a list of all VMware resource pools on the specified ESX(i) host.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Server
True
True
(ByValue,
ByProperty
Name)
False
Name
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.
Find-VBRTapeCatalog (obsolete)
Short Description
Looks for files stored on tapes.
Note:
This cmdlet is obsolete. The cmdlet will still work in Veeam Backup & Replication v.8.0 but will not be
supported in further versions.
Applies to
Platform: VMware, Hyper-V
Syntax
Find-VBRTapeCatalog [-Name <String[]>] [-WarningAction <ActionPreference>]
[-WarningVariable <String>] [<CommonParameters>]
Detailed Description
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.
Parameters
Parameter
Name
Description
Specifies the name of the file to look for or search
conditions.
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
False
Named
False
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
True
Find-VBRTapeCatalogVersion (obsolete)
Short Description
Looks for versions of files stored on tapes.
Note:
This cmdlet is obsolete. The cmdlet will still work in Veeam Backup & Replication v.8.0 but will not be
supported in further versions.
Applies to
Platform: VMware, Hyper-V
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
Detailed Description
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.
Parameters
Parameter
Name
Description
Specifies the name of the file you want to get
versions for, or search conditions.
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
True
False
Named
True
(ByValue,
ByProperty
Name)
False
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
Get-VBRTapeBackup (obsolete)
Short Description
Returns the list of backups recorded to tape.
Note:
This cmdlet is obsolete. The cmdlet will still work in Veeam Backup & Replication v.8.0 but will not be
supported in further versions.
Applies to
Platform: VMware, Hyper-V
Syntax
Get-VBRTapeBackup [-Name <String[]>] [-WarningAction <ActionPreference>] [WarningVariable <String>] [<CommonParameters>]
Detailed Description
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.
Parameters
Parameter
Name
Description
Specifies the name(s) of the backup or search
conditions.
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
False
Named
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
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-VBRTapeMediaPoolOptions (obsolete)
Short Description
Returns settings of a selected media pool.
Note:
This cmdlet is obsolete. The cmdlet will still work in Veeam Backup & Replication v.8.0 but will not be
supported in further versions.
Applies to
Platform: VMware, Hyper-V
Syntax
Get-VBRTapeMediaPoolOptions [-MediaPool] <MediaPool> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [<CommonParameters>]
Related Commands
Get-VBRTapeMediaPool
Detailed Description
This cmdlet returns settings applied to a selected media pool.
Parameters
Parameter
Description
Required Position
True
Named
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
<CommonParameters>
This cmdlet supports Microsoft PowerShell common parameters. For more information about
common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.
Import-VBRConfiguration (obsolete)
Short Description
Imports backup of Veeam Backup & Replication server configuration file.
Note:
This cmdlet is obsolete and not supported in Veeam Backup & Replication v.8.0.
Applies to
Platform: VMware, Hyper-V
Syntax
Import-VBRConfiguration -FileName <String> [-DatabaseName <String>] [WarningAction <ActionPreference>] [-WarningVariable <String>]
[<CommonParameters>]
Detailed Description
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 (obsolete) to retrieve and export your current configuration.
Parameters
Parameter
FileName
Description
Specifies the configuration file path you
want to restore.
Accept
Accept
Required Position Pipeline Wildcard
Input
Characters
True
Named
False
False
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 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"
Remove-VBRBackupSession (obsolete)
Short Description
Removes a specified backup session.
Note:
This cmdlet is obsolete and not supported in Veeam Backup & Replication v.8.0.
Applies to
Platform: VMware
Syntax
Remove-VBRBackupSession [-Session] <CBackupSession[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VBRBackupSession
Detailed Description
This cmdlet removes specified backup session from Veeam Backup & Replication.
Parameters
Parameter
Session
Description
Specifies the backup session you want to
remove.
You can assign multiple sessions to this
object.
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 removes the backup session named "Fileserver Backup". The backup session is
obtained with Get-VBRBackupSession and piped down.
Get-VBRBackupSession -Name "Fileserver Backup" | Remove-VBRBackupSession
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-VSBSession (obsolete)
Short Description
Removes a specified SureBackup job session from Veeam Backup & Replication.
Note:
This cmdlet is obsolete and not supported in Veeam Backup & Replication v.8.0.
Applies to
Platform: VMware, Hyper-V
Syntax
Remove-VSBSession [-Sessions] <CSbSession[]> [-WarningAction
<ActionPreference>] [-WarningVariable <String>] [-WhatIf] [-Confirm]
[<CommonParameters>]
Related Commands
Get-VSBSession
Detailed Description
This cmdlet removes a specified SureBackup job session from Veeam Backup & Replication.
Parameters
Parameter
Sessions
Description
Specifies the SureBackup job session you
want to remove.
You can assign multiple sessions to this
object.
Required Position
True
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
(ByValue,
ByProperty
Name)
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 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" | RemoveVSBSession
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
Start-VBRReplicaFailover (obsolete)
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
Platform: VMware, Hyper-V
Syntax
Start-VBRReplicaFailover [-RestorePoint] <COib> [-Reason <String>] [Planned] [-RunAsync] [-WarningAction <ActionPreference>] [-WarningVariable
<String>] [-WhatIf] [-Confirm] [<CommonParameters>]
Related Commands
Get-VBRRestorePoint
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Restore
Point
True
True
(ByValue,
ByProperty
Name)
False
Reason
False
Named
False
False
RunAsync
False
Named
False
False
Planned
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 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 | Start-VBRReplicaFailover -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-VBRTapeRestore (obsolete)
Short Description
Starts VM restore from tape.
Note:
This cmdlet is obsolete. The cmdlet will still work but it is recommended to perform the tape restore
operation with Veeam Backup & Replication UI for full functionality.
Applies to
Platform: VMware, Hyper-V
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
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
True
Named
True
(ByValue,
ByProperty
Name)
False
True
Named
False
False
Reason
False
Named
False
False
Server
True
Named
False
False
Path
True
Named
False
False
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
False
False
Named
<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 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.
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,
Start-VBRTapeRestoreFiles (obsolete)
Short Description
Starts files restore from tape.
Note:
This cmdlet is obsolete. The cmdlet will still work but it is recommended to perform the tape restore
operation with Veeam Backup & Replication UI for full functionality.
Applies to
Platform: VMware, Hyper-V
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
Detailed Description
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.
Parameters
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
Files
False
Named
True
(ByValue,
ByProperty
Name)
False
Version
False
Named
True
(ByValue,
ByProperty
Name)
False
Server
True
Named
False
False
Path
True
Named
False
False
Preserve
Hierarhy
False
Named
False
False
Parameter
Description
Required Position
Accept
Pipeline
Input
Accept
Wildcard
Characters
False
Named
False
False
False
Named
True
(ByValue,
ByProperty
Name)
False
RunAsync
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 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,
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,