--- title: "Start-VBRLinuxFileRestore" description: "Starts a restore session of Linux-based or Unix-based guest OS files. Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: This cmdlet mounts disks from a backup or replica" canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/start-vbrlinuxfilerestore.html" breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Data Recovery > Guest OS File Recovery > Start-VBRLinuxFileRestore" dateModified: "2026-08-19" --- # 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)
MountServer
HelperHost
HvFlr
ToOriginal
ApplianceFlr
|
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. |
|
False |
Named |
False |
|
ApplianceOptions |
Specifies configuration settings for a temporary helper appliance. Accepts the |
|
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 Accepts the |
|
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 |
Named |
False |
|
ForceArchivedSnapshotsRestore |
Defines that the cmdlet will use archive snapshots for restore without showing warnings in the PowerShell console. |
|
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 |
Named |
False |
|
Gateway |
Specifies the IPv4 address of the default gateway in the network where the helper appliance resides. |
|
False |
Named |
False |
|
HelperHost |
Specifies the temporary Linux helper host. Accepts the |
|
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. |
|
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. |
|
False |
Named |
False |
|
IPv6AlternateDNSServer |
Specifies the IPv6 address of the alternate DNS server in the network where the appliance resides. |
|
False |
Named |
False |
|
IPv6Gateway |
Specifies the IPv6 address of the default gateway in the network where the appliance resides. |
|
False |
Named |
False |
|
IPv6PreferredDNSServer |
Specifies the IPv6 address of the DNS server in the network where the helper appliance resides. |
|
False |
Named |
False |
|
IPv6PrefixLength |
For the IPv6 addresses specified. Specifies the length of the IPv6 prefix. |
|
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 |
|
True |
Named |
True (ByPropertyName) |
|
MountToOriginalHost |
Specifies whether to mount disks to the original server and use it as a helper host. Default: Note: You can set this parameter to |
|
True |
Named |
True (ByPropertyName) |
|
NetworkInfo |
Specifies the network settings for the helper appliance. Note:
Accepts the |
|
False |
Named |
False |
|
NetworkMask |
For the 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. |
|
False |
Named |
False |
|
PreferredDNSServer |
Specifies the IPv4 address of the DNS server in the network where the helper appliance resides. |
|
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. |
|
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 |
|
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 |
|
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 |
|
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 |
|
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. |
|
False |
Named |
False |