Start-VBRNasBackupRestore

Short Description

Starts a restore of backups created by the file backup job.

Applies to

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Start-VBRNasBackupRestore -RestorePoint <VBRNASBackupRestorePoint> [-DestinationServer <VBRNASServer>][-DestinationFolderPath <string>] [-PreservePermissions] [-PreserveHierarchy] [-RollBack] [-RunAsync][-OverwriteMode <VBRNASBackupRestoreOverwriteMode> {Leave | Overwrite | OverwriteIfOlder}]  [<CommonParameters>]

Detailed Description

This cmdlet starts a restore of backups created by the file backup job.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

RestorePoint

Specifies a restore point. The cmdlet will start a restore to recover backup files to the specified restore point.

Accepts the VBRNASBackupRestorePoint object. To get this object, run the Get-VBRNASBackupRestorePoint cmdlet.

True

Named

True (ByValue, ByPropertyName)

 

DestinationServer

Specifies a target file share. The cmdlet will start a restore to recover backup files to this file share.

Accepts the VBRNASServer object. To get this object, run the Get-VBRNASServer cmdlet.

False

Named

False

 

DestinationFolderPath

Specifies the path to the folder on the file share. The cmdlet will restore backups to the specified folder.

String

False

Named

False

 

PreservePermissions

Defines that the cmdlet will restore permissions and security attributes of recovered backups.

If you provide this parameter, the cmdlet will restore backup files with security attributes and permissions set by the user. Otherwise, permissions and security attributes of restored backups will not be recovered.

SwitchParameter

False

Named

False

 

PreserveHierarchy

Defines that the cmdlet will restore the hierarchy of recovered backups.

If you provide this parameter, the cmdlet will restore hierarchy of recovered backups. Otherwise, the folder hierarchy of backups will not be recovered.

SwitchParameter

False

Named

False

 

RollBack

Defines that the cmdlet will roll back backup files that have been modified to a previous version. Files, that have not been modified will remain unchanged.

If you provide this parameter, the cmdlet will roll back the modified backup files. Otherwise, the cmdlet will restore the latest version of files that have been modified.

Note: You must specify either this or the OverwriteMode parameter.

SwitchParameter

False

Named

False

 

RunAsync

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

SwitchParameter

False

Named

False

 

OverwriteMode

Specifies restore options for files, that you want to restore if they are already added to the target file share. You can select either of the following restore options:

  • Leave: use this option if you do not want to overwrite the existing file version with the restored file version. The cmdlet will keep the existing file version on the target file share.
  • Overwrite: use this option if you want to overwrite the existing file version with the restored file version.
  • OverwriteIfOlder: use this option if the backed-up file version is newer than the existing file version on the file share. The cmdlet will overwrite the existing file versions with the backed-up file versions.

Note: You must specify either this or the RollBack parameter.

VBRNASBackupRestoreOverwriteMode

False

Named

False

 

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Output Object

The cmdlet returns the VBRNasBackupRestore object that contains settings of restore sessions that are started to recover backups created by file backup jobs.

Examples

Start-VBRNasBackupRestoreExample 1. Restoring Backups to Original Location

This example shows how to restore backup files to the original location. The backups will be restored with the following settings:

  • Veeam Backup & Replication will restore permissions of restored files.
  • Veeam Backup & Replication will restore the hierarchy of restored files.
  • Veeam Backup & Replication will overwrite the existing file versions with the restored file versions.

 

$restorepoint = Get-VBRNASBackupRestorePoint

Start-VBRNasBackupRestore -RestorePoint $restorepoint -PreservePermissions -PreserveHierarchy -OverwriteMode Overwrite

Restore Type       VM Name                    State      Start Time             End Time               Description

------------       -------                    -----      ----------             --------               -----------

NasRestore         \\FileShare09\Reports      Stopped    9/5/2019 7:13:52 AM    9/5/2019 7:14:12 AM    

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
  2. Run the Start-VBRNasBackupRestore cmdlet. Specify the following settings:
  • Set the $restorepoint variable as the RestorePoint parameter value.
  • Specify the PreservePermissions parameter.
  • Specify the PreserveHierarchy parameter.
  • Set the Overwrite option as the OverwriteMode parameter value.
  1. The cmdlet output will contain the following details on the restore session: Restore Type, VM Name, State, Start Time, End Time, Description.

Start-VBRNasBackupRestoreExample 2. Restoring Backups to Different Location

This example shows how to restore backup files to the \\SMBSRV\Documents\ server. The backups will be restored with the following settings:

  • Veeam Backup & Replication will restore permissions of restored files.
  • Veeam Backup & Replication will restore the hierarchy of restored files.
  • Veeam Backup & Replication will restore backup files to the \\SMBSRV\Documents\restored folder.
  • Veeam Backup & Replication will keep the existing file version on the target file share.

 

$restorepoint = Get-VBRNASBackupRestorePoint

$destinationsrv = Get-VBRNASServer -Name "\\SMBSRV\Documents\"

Start-VBRNasBackupRestore -RestorePoint $restorepoint -DestinationServer $destinationsrv -DestinationFolderPath "\\SMBSRV\Documents\restored" -PreservePermissions -PreserveHierarchy -OverwriteMode Leave

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
  2. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $destinationsrv variable.
  3. Run the Start-VBRNasBackupRestore cmdlet. Specify the following settings:
  • Set the $restorepoint variable as the RestorePoint parameter value.
  • Set the $destinationsrv variable as the DestinationServer parameter value.
  • Specify the DestinationFolderPath parameter value.
  • Specify the PreservePermissions parameter.
  • Specify the PreserveHierarchy parameter.
  • Set the Leave option for the OverwriteMode parameter.

Start-VBRNasBackupRestoreExample 3. Restoring Corrupted Backups to Original Location

This example shows how to restore corrupted backup files to the original location.

$restorepoint = Get-VBRNASBackupRestorePoint

Start-VBRNasBackupRestore -RestorePoint $restorepoint -RollBack

Restore Type       VM Name                    State      Start Time             End Time               Description

------------       -------                    -----      ----------             --------               -----------

NasRestore         \\FileShare09\Reports      Stopped    9/5/2019 7:13:52 AM    9/5/2019 7:14:12 AM    UrgentRetore

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
  2. Run the Start-VBRNasBackupRestore cmdlet. Set the $restorepoint as the RestorePoint parameter value. Specify the RollBack parameter.

Start-VBRNasBackupRestoreExample 4. Restoring Corrupted Backups to Different Location

This example shows how to restore corrupted backup files to the \\SMBSRV\Documents\ server. The backups will be restored with the following settings:

  • Veeam Backup & Replication will restore permissions of restored files.
  • Veeam Backup & Replication will restore hierarchy of of restored files.
  • Veeam Backup & Replication will restore backup files to the \\SMBSRV\Documents\restored folder.
  • Veeam Backup & Replication will will keep the existing file version on the target file share.

 

 

$restorepoint = Get-VBRNASBackupRestorePoint

$destinationsrv = Get-VBRNASServer -Name "\\SMBSRV\Documents\"

Start-VBRNasBackupRestore -RestorePoint $restorepoint -DestinationServer $destinationsrv -DestinationFolderPath "\\SMBSRV\Documents\restored" -PreservePermissions -PreserveHierarchy -RollBack

Perform the following steps:

  1. Run the Get-VBRNASBackupRestorePoint cmdlet. Save the result to the $restorepoint variable.
  2. Run the Get-VBRNASServer cmdlet. Specify the Name parameter value. Save the result to the $destinationsrv variable.
  3. Run the Start-VBRNasBackupRestore cmdlet. Specify the following settings:
  • Set the $restorepoint variable as the RestorePoint parameter value.
  • Set the $destinationsrv variable as the DestinationServer parameter value.
  • Specify the DestinationFolderPath parameter value.
  • Specify the PreservePermissions parameter.
  • Specify the PreserveHierarchy parameter.
  • Specify the RollBack parameter.

Related Commands

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.