Start-VBRLinuxFileRestore

Short Description

Starts a restore session of Linux-based or Unix-based guest OS files.

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

Syntax

This cmdlet provides parameter sets that allow you to:

  • Start a restore session of Linux-based or Unix-based guest OS files using the VMware platform.

Start-VBRLinuxFileRestore -RestorePoint <COib> -Server <CHost> [-Reason <string>] [-ResourcePool <CViResourcePoolItem>] [-NetworkInfo <IVBRServerNetworkInfo>] [-IP <ipaddress>] [-NetworkMask <string>] [-Gateway <ipaddress>] [-FromNSS] [-EnableFTP] [-Credentials <CCredentials>]  [<CommonParameters>]

  • Start a restore session of Linux-based or Unix-based guest OS files using an existing Linux-based machine as a helper appliance.

Start-VBRLinuxFileRestore -RestorePoint <COib> -MountServer <CHost> [-Reason <string>] [-Credentials CCredentials>]  [<CommonParameters>]

  • Start a restore session of Linux-based or Unix-based guest OS files using the Hyper-V platform.

Start-VBRLinuxFileRestore -RestorePoint <COib> -Server <CHost> [-Reason <string>] [-NetworkInfo <IVBRServerNetworkInfo>] [-IP <ipaddress>] [-NetworkMask <string>] [-Gateway <ipaddress>] [-VLanId <int>] [-EnableFTP] [-Credentials <CCredentials>]  [<CommonParameters>]]

Detailed Description

This cmdlet mounts disks of a VM from the backup or replica to the helper appliance. After that you can restore VM guest OS files from file systems supported by Linux-based and Unix-based OSes:

  1. Run the Get-VBRLinuxGuestItem cmdlet to get details on the files and folders that are available for restore.
  2. Run the Start-VBRLinuxGuestItemRestore cmdlet to restore the necessary files and folders.

Note

Mind the following:

  • If you plan to restore OS files using an existing Linux-based machine as a helper appliance, you must first add this machine to the backup infrastructure. Run the Add-VBRLinux cmdlet to add the necessary machine.
  • After you restore the necessary files, you must stop the restore session. After you stop the session, Veeam Backup & Replication will unmount disks from the helper appliance and will unregister the helper appliance on the ESXi host. Run run the Stop-VBRLinuxFileRestore cmdlet to stop the session.
  • This method supports recovery of files and folders only. Recovery of other file system objects such as pipes is not supported.

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

RestorePoint

Specifies the restore point to start a restore session. You will be able to use the session to perform operations with VM guest OS files.

Accepts the COib object. To create this object, run the Get-VBRRestorePoint cmdlet.

True

Named

True (ByValue,
ByProperty
Name)

Server

Specifies a host on which the helper appliance must be registered.

Note: If you specify the host for the Novell file system proxy appliance, make sure that it allows running VMs with 64-bit guest OSes.

Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet.

False

Named

True (ByProperty
Name)

ResourcePool

To start a restore session using the VMware platform.

Specifies a resource pool to which the helper appliance must be placed.

Accepts the CViResourcePoolItem object. To create this object, run the Find-VBRViResourcePool cmdlet.

False

Named

True (ByProperty
Name)

MountServer

Specifies an existing Linux-based machine. The cmdlet will mount VM disks from a backup or replica to this machine and will use it as a helper appliance.

Note: If you do not specify this parameter, the cmdlet will mount VM disks to a temporary helper appliance

Accepts the CHost object. To create this object, run the Get-VBRServer cmdlet.

False

Named

True (ByValue,
ByProperty
Name)

Reason

Specifies the reason for starting a restore session of VM guest OS files.

The information you provide will be saved in the session history so that you can reference it later.

String

False

Named

False

NetworkInfo

Specifies the network settings for the helper appliance.

Note:

  • The helper appliance must be placed in the same network where the backup server resides.
  • If you do not provide this parameter, the cmdlet will apply the VM network settings for the helper appliance.

Accepts the IVBRServerNetworkInfo[] object. To get this object, run the Get-VBRViServerNetworkInfo cmdlet.

False

Named

False

IP

Specifies an IP address that you want to assign to the helper appliance.

Note: The helper appliance must be placed in the same network where the backup server resides.

IpAddress

False

Named

False

NetworkMask

Specifies a network mask that you want to assign to the helper appliance.

Note: The helper appliance must be placed in the same network where the backup server resides.

String

False

Named

False

Gateway

Specifies a default gateway that you want to assign to the helper appliance.

Note: The helper appliance must be placed in the same network where the backup server resides.

IpAddress

False

Named

False

VLanId

To start a restore session using the Hyper-V platform.

Specifies the VLAN ID where the helper appliance must reside.

Int

False

Named

False

FromNSS

Defines that the cmdlet will start a restore session of VM guest OS using the Novell Storage Services file system.

If you provide this parameter, the cmdlet will deploy a specific appliance that supports the Novell Storage Services file system.

Default: False.

SwitchParameter

False

Named

False

EnableFTP

Enables the FTP access to the restored file system.

If you provide this parameter, users will be able to access the helper appliance over FTP, browse the file system of the restored VM and download necessary files on their own.

Default: False.

SwitchParameter

False

Named

False

Credentials

Specifies the credentials to authenticate against an existing Linux-based machine that you want to use as a helper appliance.

Accepts the CCredentials object. To create this object, run the Get-VBRCredentials cmdlet.

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 VBRLinuxFlrObject object that contains settings of a restore session of VM guest OS files from file systems supported by Linux-based and Unix-based OSes.

Examples

Start-VBRLinuxFileRestoreExample 1. Starting Restore Session of Linux or Unix-Based Guest OS Files Using VMware

This example shows how to start a restore session of Linux or Unix-based guest OS files of the UbuntuSrv VM. The cmdlet will register a helper appliance on the ESXi01 host in the Servers resource pool.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$server = Get-VBRServer -Name "ESXi01"

$resoursepool = Find-VBRViResourcePool -Server $server -Name "Servers"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -Server $server -ResourcePool $resoursepool

Perform the following steps:

  1. Get the restore point:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable
  2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Find-VBRViResourcePool cmdlet. Specify the Server and Name parameter values. Save the result to the $resoursepool variable.
  3. Run the Start-VBRLinuxFileRestore cmdlet. Specify the following settings:
  • Set the $restorepoint variable as the RestorePoint parameter value.
  • Set the $server variable as the Server parameter value.
  • Set the $resoursepool variable as the ResourcePool parameter value.
  • Save the result to the $session variable.

Start-VBRLinuxFileRestoreExample 2. Starting Restore Session of Linux or Unix-Based Guest OS Files Using Hyper-V

This example shows how to start a restore session of Linux or Unix-based guest OS files of the UbuntuSrv VM. The cmdlet will register a helper appliance on the HV05 Hyper-V host.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$server = Get-VBRServer -Name "HV05"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -Server $server

Perform the following steps:

  1. Get the restore point:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable
  2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Start-VBRLinuxFileRestore cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Set the $server variable as the Server parameter value. Save the result to the $session variable.

Start-VBRLinuxFileRestoreExample 3. Starting Restore Session of Linux or Unix-Based Guest OS Files Using Exising Linux Machine as Helper Appliance

This example shows how to start a restore of Linux or Unix-based guest OS files of the UbuntuSrv VM. The cmdlet will use the LinSrv05 machine as a helper appliance.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$server = Get-VBRServer -Name "LinSrv05"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -MountServer $server

Perform the following steps:

  1. Get the restore point:
  1. Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable
  2. Run the Get-VBRRestorePoint cmdlet. Specify the Backup parameter value. Save the result to the $restorepoint variable.
  1. Run the Get-VBRServer cmdlet. Specify the Name parameter value. Save the result to the $server variable.
  2. Run the Start-VBRLinuxFileRestore cmdlet. Set the $restorepoint variable as the RestorePoint parameter value. Set the $server variable as the MountServer parameter value. Save the result to the $session variable.

Related Commands