Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Start-VBRLinuxFileRestore

Short Description

Starts non-Windows VM guest OS file restore.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

This cmdlet provides 3 parameter sets.

  • Basic:

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

  • For VMware:

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

  • For Hyper-V:

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

Use the appropriate syntax for respective platform.

Detailed Description

This cmdlet starts restore of VM guest OS files from 15 file systems such as Linux, Unix, BSD, MacOS and many others.

For non-Windows file level restore, an assisting proxy appliance running Linux is used. Veeam Backup & Replication mounts disks of the restored VM to the proxy appliance as virtual hard drives.

For Windows OS file restore, run Start-VBRWindowsFileRestore.

This cmdlet requires finalizing. When you restore all needed files, run Stop-VBRLinuxFileRestore to unmount disks and powers the proxy appliance off.

Start-VBRLinuxFileRestore Important!

You need to save the restore session to a variable when you run this cmdlet. Otherwise you will be unable to finalize the restore session with PowerShell.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Restore
Point

Specifies the restore point from which you want to restore the VM guest OS files.

True

Named

True (ByValue,
ByProperty
Name)

False

Reason

Specifies the reason for performing files restore.

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

False

Named

False

False

Server

Specifies the host on which the proxy appliance must be registered.

IMPORTANT! When choosing the host for the Novell file system proxy appliance, make sure that it allows running VMs with 64-bit guest OS'es.

True

Named

True (ByProperty
Name)

False

Network
Info

Specifies the network settings for the proxy appliance. The proxy appliance must be placed in the same network where the Veeam backup server resides.

True

Named

False

False

IP

Specifies the IP address for the proxy appliance. The proxy appliance must be placed in the same network where the Veeam backup server resides.

Accepts IPAddress or string type.

False

Named

False

False

Network
Mask

Specifies the network mask for the proxy appliance. The proxy appliance must be placed in the same network where the Veeam backup server resides.

False

Named

False

False

Gateway

Specifies the default gateway for the proxy appliance. The proxy appliance must be placed in the same network where the Veeam backup server resides.

False

Named

False

False

VLanId

Used for Hyper-V platform.

Specifies the VLAN ID for the proxy appliance.

False

Named

False

False

Enable
FTP

Indicates that the FTP access to the restored file system will be enabled.

False

Named

False

False

Credentials

Specifies the credentials to authenticate with the backup share folder.

False

Named

False

False

Resource
Pool

Used for VMware platform.

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

True

Named

True (ByProperty
Name)

False

FromNSS

Used for restore files in Novell Storage services file system.

Indicates that Veeam Backup & Replication will deploy a specific proxy appliance that supports the Novell file system.

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 example shows how to start a file restore session for a non-Windows VM in the Hyper-V environment.

  • The restore session is saved to the '$linuxflr' variable to use it for finalizing in future.
  • The restore point is obtained with Get-VBRRestorePoint and assigned to the '$restorepoint' variable beforehand.
  • The host where the proxy appliance will be deployed is obtained with Get-VBRServer and assigned to the '$hvhost01' variable beforehand.
  • The network in which the proxy appliance will be registered is obtained with Get-VBRHvServerNetworkInfo and assigned to the '$targetnetwork' variable beforehand.

PS C:\PS> $linuxflr = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -Server $hvhost01 -NetworkInfo $targetnetwork

Example 2

This example shows how to start a file restore session for a non-Windows VM in the VMware environment.

  • The restore session is saved to the '$linuxflr' variable to use it for finalizing in future.
  • The restore point is obtained with Get-VBRRestorePoint and assigned to the '$restorepoint' variable beforehand.
  • The host where the proxy appliance will be deployed is obtained with Get-VBRServer and assigned to the '$esx01' variable beforehand.
  • The resource pool is obtained with Find-VBRViResourcePool and assigned to the '$resourcepool' variable beforehand.
  • The network in which the proxy appliance will be registered is obtained with Get-VBRViServerNetworkInfo and assigned to the '$targetnetwork' variable beforehand.

PS C:\PS> $linuxflr = Start-VBRLinuxFileRestore -RestorePoint $restorepoint -Server $esx01 -ResourcePool $resourcepool -NetworkInfo $targetnetwork

Related Commands

Get-VBRRestorePoint

Get-VBRServer

Get-VBRHvServerNetworkInfo / Get-VBRViServerNetworkInfo

Find-VBRViResourcePool

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation