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 the following parameter sets:

ViFlr (Default)

Start-VBRLinuxFileRestore -RestorePoint <COib> [-Reason <String>] -Server <CHost>

[-ResourcePool <CViResourcePoolItem>] [-NetworkInfo <IVBRServerNetworkInfo>] [-IP <IPAddress>]

[-NetworkMask <String>] [-Gateway <IPAddress>] [-PreferredDNSServer <IPAddress>]

[-AlternateDNSServer <IPAddress>] [-IPv6 <IPAddress>] [-IPv6PrefixLength <Int32>] [-IPv6Gateway <IPAddress>]

[-IPv6PreferredDNSServer <IPAddress>] [-IPv6AlternateDNSServer <IPAddress>] [-FromNSS] [-EnableFTP]

[-ShareCredentials <CCredentials>] [-ForceArchivedSnapshotsRestore] [<CommonParameters>]

MountServer

Start-VBRLinuxFileRestore -RestorePoint <COib> [-Reason <String>] -MountServer <CHost>

[-ShareCredentials <CCredentials>] [-ForceArchivedSnapshotsRestore] [<CommonParameters>]
HelperHost

Start-VBRLinuxFileRestore -RestorePoint <COib> [-Reason <String>] -HelperHost <VBRLinuxFileRestoreHelperHost>

[-ShareCredentials <CCredentials>] [-ForceArchivedSnapshotsRestore] [<CommonParameters>]

HvFlr

Start-VBRLinuxFileRestore -RestorePoint <COib> [-Reason <String>] -Server <CHost>

[-NetworkInfo <IVBRServerNetworkInfo>] [-IP <IPAddress>] [-NetworkMask <String>] [-Gateway <IPAddress>]

[-PreferredDNSServer <IPAddress>] [-AlternateDNSServer <IPAddress>] [-IPv6 <IPAddress>]

[-IPv6PrefixLength <Int32>] [-IPv6Gateway <IPAddress>] [-IPv6PreferredDNSServer <IPAddress>]

[-IPv6AlternateDNSServer <IPAddress>] [-VLanId <Int32>] [-EnableFTP] [-ShareCredentials <CCredentials>]

[-ForceArchivedSnapshotsRestore] [<CommonParameters>]

ToOriginal

Start-VBRLinuxFileRestore -RestorePoint <COib> [-Reason <String>] [-Credentials <CCredentials>]

[-ShareCredentials <CCredentials>] [-MountToOriginalHost] [-ForceArchivedSnapshotsRestore] [<CommonParameters>]

ApplianceFlr

Start-VBRLinuxFileRestore -RestorePoint <COib> [-Reason <String>] [-ShareCredentials <CCredentials>]

-ApplianceOptions <VBRFileRestoreLinuxHelperApplianceOptions> [-ForceArchivedSnapshotsRestore] [<CommonParameters>]

Detailed Description

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

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

Note

Consider the following:

If you plan to restore OS files using an existing Linux-based machine as a helper host, 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. Run the Stop-VBRLinuxFileRestore cmdlet to stop the session.

After you stop the session, Veeam Backup & Replication unmounts disks from the helper host or helper appliance. If you use the helper appliance, Veeam Backup & Replication unregisters the helper appliance from the ESXi or Microsoft Hyper-V host.
This method supports recovery of files and folders only. Recovery of other file system objects such as pipes is not supported.

Tip

To start a restore session for a CDP replica, use the Start-VBRCDPLinuxFileRestore cmdlet.

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
AlternateDNSServer	Specifies the IPv4 address of the alternate DNS server in the network where the helper appliance resides.	`IPAddress`	False	Named	False
ApplianceOptions	Specifies configuration settings for a temporary helper appliance. Accepts the `VBRLinuxFileRestoreHelperHost` object. To get this object, run the `New-VBRFileRestoreLinuxHelperApplianceOptions` cmdlet.	`VBRFileRestoreLinuxHelperApplianceOptions`	True	Named	True (ByPropertyName)
Credentials	Specifies the credentials to authenticate against the original Linux-based machine that will be used as a helper host. Note: This parameter can be used only when `MountToOriginalHost` is `true`. Accepts the `CCredentials` object. To create this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	False	Named	True (ByPropertyName)
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
ForceArchivedSnapshotsRestore	Defines that the cmdlet will use archive snapshots for restore without showing warnings in the PowerShell console.	`SwitchParameter`	False	Named	False
FromNSS	Defines that the cmdlet will start a restore session of a 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
Gateway	Specifies the IPv4 address of the default gateway in the network where the helper appliance resides.	`IPAddress`	False	Named	False
HelperHost	Specifies the temporary Linux helper host. Accepts the `VBRLinuxFileRestoreHelperHost` object. To get this object, run the `New-VBRLinuxFileRestoreHelperHost` cmdlet.	`VBRLinuxFileRestoreHelperHost`	True	Named	False
IP	Specifies the IPv4 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
IPv6	Specifies the IPv6 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
IPv6AlternateDNSServer	Specifies the IPv6 address of the alternate DNS server in the network where the appliance resides.	`IPAddress`	False	Named	False
IPv6Gateway	Specifies the IPv6 address of the default gateway in the network where the appliance resides.	`IPAddress`	False	Named	False
IPv6PreferredDNSServer	Specifies the IPv6 address of the DNS server in the network where the helper appliance resides.	`IPAddress`	False	Named	False
IPv6PrefixLength	For the IPv6 addresses specified. Specifies the length of the IPv6 prefix.	`Int32`	False	Named	False
MountServer	Specifies an existing Linux-based machine. The cmdlet will mount disks from a backup or replica to this machine and will use it as a helper host. Accepts the `CHost` object. To create this object, run the `Get-VBRServer` cmdlet.	`CHost`	True	Named	True (ByPropertyName)
MountToOriginalHost	Specifies whether to mount disks to the original server and use it as a helper host. Default: `False`. Note: You can set this parameter to `$true` only if the `Server` and `MountServer` parameters are not specified.	`SwitchParameter`	True	Named	True (ByPropertyName)
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.	`IVBRServerNetworkInfo`	False	Named	False
NetworkMask	For the `IP` parameter specified. Specifies the 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
PreferredDNSServer	Specifies the IPv4 address of the DNS server in the network where the helper appliance resides.	`IPAddress`	False	Named	False
Reason	Specifies the reason for starting restore. The information you provide will be saved in the session history so that you can reference it later.	`String`	False	Named	True (ByPropertyName)
ResourcePool	To start a restore session using the VMware platform. Specifies the resource pool to which the helper appliance must be placed. Accepts the `CViResourcePoolItem` object. To get this object, run the `Find-VBRViResourcePool` cmdlet.	`CViResourcePoolItem`	False	Named	True (ByPropertyName)
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.	`COib`	True	Named	True (ByPropertyName)
Server	Specifies the ESXi or Microsoft Hyper-V host on which the helper appliance must be registered. Note: If you specify a host for the Novell file system proxy appliance, make sure that it can run VMs with 64-bit guest OSes. Accepts the `CHost` object. To get this object, run the `Get-VBRServer` cmdlet.	`CHost`	True	Named	True (ByPropertyName)
ShareCredentials	Specifies the credentials to authenticate against a backup repository where the backup from which you restore is stored. Note: This parameter is required if you restore files using a helper appliance from a backup imported from an SMB share. This applies if the server where the share is located and the share itself is not added to the backup infrastructure. Accepts the `CCredentials` object. To create this object, run the `Get-VBRCredentials` cmdlet.	`CCredentials`	False	Named	True (ByPropertyName)
VLanId	To start a restore session using the Hyper-V platform. Specifies the VLAN ID where the helper appliance must reside.	`Int32`	False	Named	False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see 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-VBRLinuxFileRestore Example 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"

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

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

Perform the following steps:

Get the restore point:
- Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. 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. Specify the Name parameter value. Save the result to the $resourcepool variable.
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 $resourcepool variable as the ResourcePool parameter value.
- Save the result to the $session variable.

Start-VBRLinuxFileRestore Example 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:

Get the restore point:
- Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. 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 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-VBRLinuxFileRestore Example 3. Starting Restore Session of Linux or Unix-Based Guest OS Files Using Existing Linux Machine as Helper Host

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

$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:

Get the restore point:
- Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. 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 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.

Start-VBRLinuxFileRestore Example 4. Starting Restore Session of Linux or Unix-Based Guest OS Files Using Original Server

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 original VM as a helper appliance.

$backup = Get-VBRBackup -Name "UbuntuSrv"

$restorepoint = Get-VBRRestorePoint -Backup $backup

$credentials = Get-VBRCredentials -Name "root"

$session = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -Credentials $credentials -MountToOriginal

Perform the following steps:

Get the restore point:
- Run the Get-VBRBackup cmdlet. Specify the Name parameter value. Save the result to the $backup variable.
- Run the Get-VBRRestorePoint cmdlet. Set the $backup variable as the Backup parameter value. Save the result to the $restorepoint variable.
Run Get-VBRCredentials cmdlet. Specify the Name parameter value. Save the result to the $credentials variable.
Run the Start-VBRLinuxFileRestore cmdlet.
- Set the $restorepoint variable as the RestorePoint parameter value.
- Set the $credentials variable as the Credentials parameter value.
- Specify the MountToOriginal parameter.
- Save the result to the $session variable.