---
title: "Start-VBRCDPLinuxFileRestore"
description: "Starts a restore session of Linux-based or Unix-based guest OS files from a CDP replica. Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: This cmdlet starts a restore s"
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/start-vbrcdplinuxfilerestore.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Data Recovery > Guest OS File Recovery > Start-VBRCDPLinuxFileRestore"
dateModified: "2026-08-20"
---

# Start-VBRCDPLinuxFileRestore

## Short Description
Starts a restore session of Linux-based or Unix-based guest OS files from a CDP replica.

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

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>ToPointInTime</code></p>

```
Start-VBRCDPLinuxFileRestore -Replica <VBRCDPReplica> [-ToPointInTime <DateTime>] [-Reason <String>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>MountServer</code></p>

```
Start-VBRCDPLinuxFileRestore -Replica <VBRCDPReplica> [-ToPointInTime <DateTime>]
 [-LongTermRestorePoint <VBRCDPLongTermRestorePoint>] [-Reason <String>] -MountServer <CHost> [<CommonParameters>]
```
  </li>
  <li>
    <p><code>ViFlr</code></p>

```
Start-VBRCDPLinuxFileRestore -Replica <VBRCDPReplica> [-ToPointInTime <DateTime>]
 [-LongTermRestorePoint <VBRCDPLongTermRestorePoint>] [-Reason <String>]
 -ApplianceOptions <VBRFileRestoreLinuxHelperApplianceOptions> [<CommonParameters>]
```
  </li>
  <li>
    <p><code>ToOriginal</code></p>

```
Start-VBRCDPLinuxFileRestore -Replica <VBRCDPReplica> [-ToPointInTime <DateTime>]
 [-LongTermRestorePoint <VBRCDPLongTermRestorePoint>] [-Reason <String>] [-Credentials <CCredentials>]
 [-MountToOriginalHost] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>LongTermRestorePoint</code></p>

```
Start-VBRCDPLinuxFileRestore -Replica <VBRCDPReplica> -LongTermRestorePoint <VBRCDPLongTermRestorePoint>
 [-Reason <String>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>HelperHost</code></p>

```
Start-VBRCDPLinuxFileRestore -Replica <VBRCDPReplica> [-Reason <String>]
 -HelperHost <VBRLinuxFileRestoreHelperHost> [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet starts a restore session of guest OS files for a CDP replica that has Linux-based or Unix-based OS.

::: 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`](add-vbrlinux.md) cmdlet to add the necessary machine.
- After you restore the necessary files, you must stop the restore session. Run run the [`Stop-VBRLinuxFileRestore`](stop-vbrlinuxfilerestore.md) 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 host.

- This method supports recovery of files and folders only. Recovery of other file system objects such as pipes is not supported.

:::

## Parameters

<table style="width:100%;" class="Blue_Table">
      <tr style="vertical-align:top">
        <th style="width:20%;">
          <p>Parameter</p>
        </th>
        <th style="width:20%;">
          <p>Description</p>
        </th>
        <th style="width:20%;">
          <p>Type</p>
        </th>
        <th style="width:10%;">
          <p>Required</p>
        </th>
        <th style="width:10%;">
          <p>Position</p>
        </th>
        <th style="width:10%;">
          <p>Accept Pipeline Input</p>
        </th>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ApplianceOptions</span></p>
        </td>
        <td>
          <p>Specifies configuration options for a temporary helper appliance.</p><p><strong>Note</strong>: This parameter is required if you do not specify the <code>MountServer</code> and <code>MountToOriginalHost</code> parameters.</p><p>Accepts the <code>VBRFileRestoreLinuxHelperApplianceOptions</code> object. To create this object, run the <a href="new-vbrfilerestorelinuxhelperapplianceoptions.md"><code>New-VBRFileRestoreLinuxHelperApplianceOptions</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRFileRestoreLinuxHelperApplianceOptions</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Credentials</span></p>
        </td>
        <td>
          <p>Specifies the credentials to authenticate against an existing Linux-based machine that you want to use as a helper host.</p><p><strong>Note</strong>: This parameter can be used only when <code>MountToOriginalHost</code> is <code>true</code>.</p><p>Accepts the <code>CCredentials</code> object. To create this object, run the  <a href="get-vbrcredentials.md"><code>Get-VBRCredentials</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CCredentials</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">HelperHost</span></p>
        </td>
        <td>
          <p>Specifies the temporary Linux helper host.</p><p>Accepts the <code>VBRLinuxFileRestoreHelperHost</code> object. To get this object, run the <a href="new-vbrlinuxfilerestorehelperhost.md"><code>New-VBRLinuxFileRestoreHelperHost</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRLinuxFileRestoreHelperHost</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">LongTermRestorePoint</span></p>
        </td>
        <td>
          <p>Specifies a long-term restore point of a CDP replica. The cmdlet will start the restore session for this restore point.</p><p>Accepts the <code>VBRCDPLongTermRestorePoint</code> object. To get this object, run the <a href="get-vbrcdplongtermrestorepoint.md"><code>Get-VBRCDPLongTermRestorePoint</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRCDPLongTermRestorePoint</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">MountServer</span></p>
        </td>
        <td>
          <p>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.</p><p><strong>Note</strong>: This parameter is required if you do not specify the <code>ApplianceOptions</code> and <code>MountToOriginalHost</code> parameters.</p><p>Accepts the <code>CHost</code> object. To create this object, run the <a href="get-vbrserver.md"><code>Get-VBRServer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CHost</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">MountToOriginalHost</span></p>
        </td>
        <td>
          <p>Specifies whether to mount disks to the original server and use it as a helper host.</p><p>Default: <code>False</code>.</p><p><strong>Note</strong>: Set this parameter to <code>$true</code> if the <code>Server</code>, <code>MountServer</code> and <code>ApplianceOptions</code> parameters are not specified.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Reason</span></p>
        </td>
        <td>
          <p>Specifies the reason for starting a restore session.</p><p>The information you provide will be saved in the session history so that you can reference it later.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Replica</span></p>
        </td>
        <td>
          <p>Specifies the CDP replica for which you want to restore files.</p><p>Accepts the <code>VBRCDPReplica</code> object. To create this object, run the <a href="get-vbrcdpreplica.md"><code>Get-VBRCDPReplica</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRCDPReplica</code></p>
        </td>
        <td style="width:10%;">
          <p>True</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">ToPointInTime</span></p>
        </td>
        <td>
          <p>Specifies date and time when a restore point was created. The cmdlet will start the restore session for the short-term restore point created at the specified date and time or will take the nearest restore point.</p><p>Accepts the <code>DateTime</code> object. To get this object, run the <a href="https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/get-date?view=powershell-7.1"><code>Get-Date</code></a> or <a href="get-vbrcdpshorttermrestoreinterval.md"><code>Get-VBRCDPShortTermRestoreInterval</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>DateTime</code></p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
        <td style="width:10%;">
          <p>Named</p>
        </td>
        <td style="width:10%;">
          <p>False</p>
        </td>
      </tr>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
The cmdlet returns the `FileRestore` object that contains settings of a restore session of Linux-based or Unix-based guest OS files.

## Examples

::: example
### Starting Restore Session of Linux or Unix-Based Guest OS Files Using Existing Linux Machine as Helper Appliance

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

```
$replica = Get-VBRCDPReplica -Name "UbuntuSrv"
$restorepoint = Get-VBRCDPLongTermRestorePoint -Replica $replica -Last
$server = Get-VBRServer -Name "LinSrv05"
$creds = Get-VBRCredentials -Name *Administrator*
$session = Start-VBRCDPLinuxFileRestore -Replica $replica -LongTermRestorePoint $restorepoint -MountServer $server -Credentials $creds
```

Perform the following steps:

1. Get the restore point:

   - Run the [`Get-VBRCDPReplica`](get-vbrcdpreplica.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$replica` variable.
   - Run the [`Get-VBRCDPLongTermRestorePoint`](get-vbrcdplongtermrestorepoint.md) cmdlet. Set the `$replica` variable as the `Replica` parameter value. Provide the `Last` parameter. Save the result to the `$restorepoint` variable.

2. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$server` variable.
3. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$creds` variable.
4. Run the `Start-VBRCDPLinuxFileRestore` cmdlet:

   - Set the `$replica` variable as the `Replica` parameter value.
   - Set the `$restorepoint` variable as the `LongTermRestorePoint` parameter value.
   - Set the `$server` variable as the `MountServer` parameter value.
   - Set the `$creds` variable as the `Credentials` parameter value.
   - Save the result to the `$session` variable.

:::

## Related Commands

- [`Get-VBRCDPReplica`](get-vbrcdpreplica.md)
- [`Get-VBRCDPLongTermRestorePoint`](get-vbrcdplongtermrestorepoint.md)
- [`Get-VBRServer`](get-vbrserver.md)
- [`Get-VBRCredentials`](get-vbrcredentials.md)