This is an archive version of the document. To get the most up-to-date information, see the current version.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:
- 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 |
Mind the following:
|
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, |
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 |
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 |
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, |
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:
| 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
Example 1. Starting Restore Session of Linux or Unix-Based Guest OS Files Using VMware
Example 2. Starting Restore Session of Linux or Unix-Based Guest OS Files Using Hyper-V
Example 3. Starting Restore Session of Linux or Unix-Based Guest OS Files Using Exising Linux Machine as Helper Appliance
Related Commands
