Start-VBRRestoreVM

Short Description

Starts restore of the entire VMware VM.

Platform: VMware

For Hyper-V, run the Start-VBRHvRestoreVM cmdlet.

Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

DifferentLocation (Default)

Start-VBRRestoreVM [-RestorePoint] <COib> [-Server] <CHost> [[-ResourcePool] <CViResourcePoolItem>]

[[-Datastore] <CViDatastoreItem>] [-Folder <CViFolderItem>] [-StoragePolicy <VBRViStoragePolicy>]

[-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRViNetworkInfo[]>] [-VMName <String>]

[-DiskType <EDiskCreationMode>] [-PowerUp <Boolean>] [-SkipTagsRestore] [-Reason <String>] [-RunAsync]

[-Credentials <CCredentials>] [-Force] [-EnableAntivirusScan] [-EnableYARAScan] [-YARAScanRule <String>]

[-EnableEntireVolumeScan] [-VirusDetectionAction <VBRVirusDetectionAction>] [-NICsEnabled]

[-Proxy <CViProxy[]>] [<CommonParameters>]

StagedRestore

Start-VBRRestoreVM [-RestorePoint] <COib> [-Server] <CHost> [[-ResourcePool] <CViResourcePoolItem>]

[[-Datastore] <CViDatastoreItem>] [-Folder <CViFolderItem>] [-StoragePolicy <VBRViStoragePolicy>]

[-SourceNetwork <VBRViNetworkInfo[]>] [-TargetNetwork <VBRViNetworkInfo[]>] [-VMName <String>]

[-DiskType <EDiskCreationMode>] [-PowerUp <Boolean>] [-SkipTagsRestore] [-Reason <String>] [-RunAsync]

[-Credentials <CCredentials>] [-Force] [-EnableAntivirusScan] [-EnableYARAScan] [-YARAScanRule <String>]

[-EnableEntireVolumeScan] [-VirusDetectionAction <VBRVirusDetectionAction>] [-EnableStagedRestore]

-StagingVirtualLab <ISbVirtualLab> [-StagingApplicationGroup <CSbAppGroup>] -StagingScript <String>

-StagingCredentials <CInternalCredentials> [-StagingStartupOptions <VBRApplicationGroupStartupOptions>]

[-NICsEnabled] [-Proxy <CViProxy[]>] [<CommonParameters>]

OriginalLocation

Start-VBRRestoreVM [-RestorePoint] <COib> [-DiskType <EDiskCreationMode>] [-PowerUp <Boolean>]

[-SkipTagsRestore] [-Reason <String>] [-RunAsync] [-QuickRollback] [-ToOriginalLocation]

[-StoragePolicyAction <VBRStoragePolicyAction>] [-Credentials <CCredentials>] [-Force] [-EnableAntivirusScan]

[-EnableYARAScan] [-YARAScanRule <String>] [-EnableEntireVolumeScan]

[-VirusDetectionAction <VBRVirusDetectionAction>] [-NICsEnabled] [-Proxy <CViProxy[]>] [<CommonParameters>]

Detailed Description

This cmdlet starts the entire VM restore. With this cmdlet, you can restore the VM with the following options:

Restore to original location
Restore to original location with different settings
Restore to another location
Staged restore
Secure restore

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Credentials	Specifies the credentials you want to use for authenticating with the VM.	`CCredentials`	False	Named	False
Datastore	For restore to another location. Specifies the datastore to which you want to connect the restored VM. Accepts the `CViDatastoreItem` object. To get this object, run the `Find-VBRViDatastore` cmdlet.	`CViDatastoreItem`	False	3	False
DiskType	Specifies the disk type you want to apply to the restored VM: `Thin` `Thick` `AsOriginal`	`EDiskCreationMode`	False	Named	False
EnableAntivirusScan	Enables the secure restore option. Veeam Backup & Replication will trigger the antivirus software to scan selected VMs before the restore.	`SwitchParameter`	False	Named	False
EnableEntireVolumeScan	For secure restore. Defines that the antivirus will continue VMs scan after the first virus threat is found. Use this option if you want to get the report on all virus threats.	`SwitchParameter`	False	Named	False
EnableStagedRestore	For staged restore. Enables the staged restore option.	`SwitchParameter`	True	Named	False
EnableYARAScan	Enables the YARA scan for the selected VMs. Use the `YARAScanRule` parameter to specify the YARA rule to be used.	`SwitchParameter`	False	Named	False
Folder	For restore to another location. Specifies the folder where you want to locate the restored VM. Accepts the `CViFolderItem` object. To get this object, run the `Find-VBRViEntity` cmdlet.	`CViFolderItem`	False	Named	False
Force	Defines that the cmdlet will perform VM restore even if the geographic location of the repository where VM backups reside and the target host location do not match.	`SwitchParameter`	False	Named	False
NICsEnabled	Defines that the restored VM will be connected to the network. Default: `True`. Note: To disable this option, set the parameter value to `$false`. That is, parameter_name`:$false`.	`SwitchParameter`	False	Named	False
PowerUp	Defines that the restored VM will be powered up immediately after the restore. Otherwise, you will have to power up the VM manually.	`Boolean`	False	Named	False
Proxy	Specifies the backup proxy that the cmdlet will use during restore. If you do not provide this parameter, the cmdlet will use select the backup proxy automatically. Accepts the `CViProxy[]` object. To get this object, run the `Get-VBRViProxy` cmdlet.	`CViProxy[]`	False	Named	False
QuickRollback	For restore to original location. Defines that the incremental restore must be performed.	`SwitchParameter`	False	Named	False
Reason	Specifies the reason for performing restore of the selected VM. The information you provide will be saved in the session history so that you can reference it later.	`String`	False	Named	False
ResourcePool	For restore to another location. Specifies the resource pool where you want to locate the restored VM. Accepts the `CViResourcePoolItem` object. To get this object, run the `Find-VBRViEntity` cmdlet.	`CViResourcePoolItem`	False	2	False
RestorePoint	Specifies the VM restore point to which you want to restore. Accepts the `COib` object. To get this object, run the `Get-VBRRestorePoint` cmdlet.	`COib`	True	0	True (ByPropertyName, ByValue)
RunAsync	Defines that the command returns immediately without waiting for the task to complete.	`SwitchParameter`	False	Named	False
Server	Specifies the ESXi host where you want to locate the restored VM. Note: The cmdlet will not run if you specify this parameter with the ToOriginalLocation parameter.	`CHost`	True	1	False
SkipTagsRestore	Defines that the VM will be restored without its VMware tag. Otherwise, the restored VM will keep its original tag.	`SwitchParameter`	False	Named	False
SourceNetwork	For restore to another location. Specifies the source site network. Veeam Backup & Replication will map it to the target network. Note: This parameter is required if you specify the `TargetNetwork` parameter. Accepts the `VBRViNetworkInfo[]` object. To get this object, run the `Get-VBRViServerNetworkInfo` cmdlet.	`VBRViNetworkInfo[]`	False	Named	False
StagingApplicationGroup	For staged restore. Specifies the application group that the cmdlet will use for staged restore. Accepts the `CSbAppGroup` object. To get this object, run the `Get-VSBApplicationGroup` cmdlet.	`CSbAppGroup`	False	Named	False
StagingCredentials	For staged restore. Specifies the VM guest credentials for the staged restore. Veeam Backup & Replication will use these credentials for authenticating with the VM and run the script. Accepts the `CInternalCredentials` object. To get this object, run the `Get-VBRCredentials` cmdlet.	`CInternalCredentials`	True	Named	False
StagingScript	For staged restore. Specifies the script location. Veeam Backup & Replication will use this script to prepare VMs before the restore.	`String`	True	Named	False
StagingStartupOptions	For staged restore. Specifies startup settings of VMs that you want to restore. Veeam Backup & Replication will use these settings to start selected VMs after recovery. Accepts the `VBRApplicationGroupStartupOptions` object. To create this object, run the `New-VBRApplicationGroupStartupOptions` cmdlet.	`VBRApplicationGroupStartupOptions`	False	Named	False
StagingVirtualLab	For staged restore. Specifies the virtual lab. The cmdlet will use this virtual lab to start VMs and run the script. Specifies the virtual lab that you will use for staged restore. Veeam Backup & Replication will move VMs into the isolated environment and will run the staging script. Accepts the `ISbVirtualLab` object. To get this object, run the `Get-VBRVirtualLab` cmdlet.	`ISbVirtualLab`	True	Named	False
StoragePolicy	Specifies the VMware storage policy profile that must be applied to the restored virtual disks. Accepts `VBRViStoragePolicy` object. To get this object, run the `Find-VBRViStoragePolicy` cmdlet.	`VBRViStoragePolicy`	False	Named	False
StoragePolicyAction	Specifies the strategy for selecting storage policy profile in case the storage profile of the backed up VM differs from the profile of the original VM: `Current`: the restored VM will be subscribed to the same profile as in backup (if such profile still exists) or to the profile to which the original VM is subscribed (if profile as in backup was removed). `Default`: the restored VM will be subscribed to the profile that is set as default for the target datastore. `Stored`: the restored VM will be subscribed to the profile as in backup (if such profile still exists).	`VBRStoragePolicyAction`	False	Named	False
TargetNetwork	For restore to another location. Specifies the target site network. Veeam Backup & Replication will map it with the source network. Note: This parameter is required if you specify the `SourceNetwork` parameter. Accepts the `VBRViNetworkInfo[]` object. To get this object, run the `Get-VBRViServerNetworkInfo` cmdlet.	`VBRViNetworkInfo[]`	False	Named	False
ToOriginalLocation	Defines that the VM must be restored with original ResourcePool, Datastore and Folder settings. Note: The cmdlet will not run if you specify this parameter with the `Server` parameter.	`SwitchParameter`	True	Named	False
VirusDetectionAction	For secure restore. Specifies the secure restore action when the infection is detected. `DisableNetwork` — use this option if you want to restore VMs with disabled network adapters (NICs). `AbortRecovery` — use this option if you want to cancel the restore session.	`VBRVirusDetectionAction`	False	Named	False
VMName	Specifies the name you want to apply to the restored VM. By default, the original VM name is applied.	`String`	False	Named	False
YARAScanRule	Specifies the YARA rule. Veeam Backup & Replication will scan VMs with this rule. Veeam Backup & Replication searches for YARA rules in the `YaraRules` folder. The default path is: `C:\Program Files\Veeam\Backup and Replication\Backup\YaraRules`. To use a YARA rule, you must specify its name and extension. Veeam Backup & Replication accepts only `.yar` and `.yara` extensions.	`String`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Examples

Start-VBRRestoreVM Example 1. Restoring VM to Original Location

This example shows how to start restore of a VM to the original location.

$restorepoint = Get-VBRRestorePoint

Start-VBRRestoreVM -RestorePoint $restorepoint -Reason "Test restore" -ToOriginalLocation -StoragePolicyAction Default

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.
Run the Start-VBRRestoreVM cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
- Specify the Reason parameter value.
- Provide the ToOriginalLocation parameter.
- Set the Default value for the StoragePolicyAction parameter.

Start-VBRRestoreVM Example 2. Restoring VM to Another Location

This example shows how to restore a VM to another location.

$restorepoint = Get-VBRRestorePoint

$server = Get-VBRServer -Name "north.support.local"

$rpool = Find-VBRViResourcePool -Server $server

$datastore = Find-VBRViDatastore -Server $server

Start-VBRRestoreVM -RestorePoint $restorepoint[1] -Server $server -ResourcePool $rpool -Datastore $datastore -PowerUp:$true -NICsEnabled:$false

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Find-VBRViResourcePool cmdlet. Set the $server variable as the Server parameter value. Save the result to the $rpool variable.
Run the Find-VBRViDatastore cmdlet. Set the $server variable as the Server parameter value. Save the result to the $datastore variable.
Run the Start-VBRRestoreVM cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
  
  The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the second restore point is used.
- Set the $server variable as the Server parameter value.
- Set the $rpool variable as the ResourcePool parameter value.
- Set the $datastore variable as the Datastore parameter value.
- Set the $true value for the PowerUp parameter.
- Set the $false value to the NICsEnabled parameter.

Start-VBRRestoreVM Example 3. Performing Staged Restore of VM

The example shows how perform staged restore of the selected VM.

$restorepoint = Get-VBRRestorePoint

$server = Get-VBRServer -Name "north.support.local"

$lab = Get-VSBVirtualLab -Name "VirtualLab"

$creds = Get-VBRCredentials -Name "Administrator"

Start-VBRRestoreVM -RestorePoint $restorepoint[0] -Server $server -StagingVirtualLab $lab -StagingScript "c:/script.cmd" -EnableStagedRestore -StagingCredentials $creds

Perform the following steps:

Run the Get-VBRRestorePoint cmdlet. Save the result to the $restorepoint variable.
Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
Run the Get-VSBVirtualLab cmdlet. Specify the Name parameter value. Save the result to the $lab variable.
Run the Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $creds variable.
Run the Start-VBRRestoreVM cmdlet. Specify the following settings:
- Set the $restorepoint variable as the RestorePoint parameter value.
  
  The Get-VBRRestorePoint cmdlet will return an array of restore points. Consider that the array numbering starts with 0. In our example, the first restore point is used.
- Set the $server variable as the Server parameter value.
- Set the $lab variable as the StagingVirtualLab parameter value.
- Specify the StagingScript parameter value.
- Provide the EnableStagedRestore parameter.
- Set the $creds variable as the StagingCredentials parameter value.