This is an archive version of the document. To get the most up-to-date information, see the current version.

Start-VBRRestoreVM

In this article

    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.

    • For restore to another location:

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

    • For restore to original location:

    Start-VBRRestoreVM [-RestorePoint] <COib> [-VMName <string>] [-DiskType <EDiskCreationMode> {Source | Thick | Thin}] [-PowerUp <bool>] [-SkipTagsRestore] [-Reason <string>] [-RunAsync] [-QuickRollback] [-ToOriginalLocation] [-StoragePolicyAction <VBRStoragePolicyAction> {Current | Stored | Default}] [-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

    Specifies the VM restore point to which you want to restore.

    True

    1

    True (ByValue,
    ByProperty
    Name)

    False

    Server

    Specifies the host where you want to locate the restored VM.

    True

    2

    False

    False

    ResourcePool

    Specifies the resource pool where you want to locate the restored VM.

    False

    3

    False

    False

    Datastore

    Specifies the datastore to which you want to connect the restored VM.

    False

    4

    False

    False

    StoragePolicy

    Specifies the VMware storage policy profile that must be applied to the restored virtual disks.

    False

    Named

    False

    False

    Folder

    Specifies the folder where you want to locate the restored VM.

    False

    Named

    False

    False

    VMName

    Specifies the name you want to apply to the restored VM.

    By default, the original VM name is applied.

    False

    Named

    False

    False

    DiskType

    Specifies the disk type you want to apply to the restored VM: Thin, Thick or AsOriginal.

    False

    Named

    False

    False

    PowerUp

    If set, the restored VM will be powered up immediately after the restore. Otherwise, you will have to power up the VM manually.

    False

    Named

    False

    False

    Skip
    Tags
    Restore

    If set, the VM will be restored without its VMware tag. Otherwise, the restored VM will keep its original tag.

    False

    Named

    False

    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.

    False

    Named

    False

    False

    RunAsync

    Indicates that the command returns immediately without waiting for the task to complete.

    False

    Named

    False

    False

    QuickRollback

    Indicates that the incremental restore must be performed.

    False

    Named

    False

    False

    ToOriginal
    Location

    Indicates that the VM must be restored with original ResourcePool, Datastore and Folder settings.

    False

    Named

    False

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

    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.
    • The storage policy selection strategy is set to Default.

    PS C:\PS> Start-VBRRestoreVM -RestorePoint $restorepoint -Reason "Test restore" -ToOriginalLocation -StoragePolicyAction Default

    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.
    • The PowerUp parameter is set to to boot the VM after it is restored.

    PS C:\PS> Start-VBRRestoreVM –RestorePoint $point –Server $server –ResourcePool $rpool –Datastore $datastore –PowerUp