---
title: "New-VBRFileRestoreLinuxHelperApplianceOptions"
description: "Defines configuration settings for a temporary helper appliance. Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet defines configuration settings for a temporary helper appliance."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrfilerestorelinuxhelperapplianceoptions.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Data Recovery > Guest OS File Recovery > New-VBRFileRestoreLinuxHelperApplianceOptions"
dateModified: "2026-08-19"
---

# New-VBRFileRestoreLinuxHelperApplianceOptions

## Short Description
Defines configuration settings for a temporary helper appliance.

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

## Syntax
```
New-VBRFileRestoreLinuxHelperApplianceOptions -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] [-VLanId <Int32>] [<CommonParameters>]
```

## Detailed Description
This cmdlet defines configuration settings for a temporary helper appliance.

## 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">AlternateDNSServer</span></p>
        </td>
        <td>
          <p>Specifies the IPv4 address of the alternate DNS server in the network where the helper appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">EnableFTP</span></p>
        </td>
        <td>
          <p>Enables the FTP access to the restored file system.</p><p>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.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</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">FromNSS</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will deploy a specific appliance that supports the Novell Storage Services file system.</p><p>Default: <code>False</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>SwitchParameter</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">Gateway</span></p>
        </td>
        <td>
          <p>Specifies the IPv4 address of the DNS server in the network where the helper appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">IP</span></p>
        </td>
        <td>
          <p>Specifies the IPv4 address that you want to assign to the helper appliance.</p><p><strong>Note</strong>: The helper appliance must be placed in the same network where the backup server resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">IPv6</span></p>
        </td>
        <td>
          <p>Specifies the IPv6 address that you want to assign to the helper appliance.</p><p><strong>Note</strong>: The helper appliance must be placed in the same network where the backup server resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">IPv6AlternateDNSServer</span></p>
        </td>
        <td>
          <p>Specifies the IPv6 address of the alternate DNS server in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">IPv6Gateway</span></p>
        </td>
        <td>
          <p>Specifies the IPv6 address of the default gateway in the network where the appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">IPv6PreferredDNSServer</span></p>
        </td>
        <td>
          <p>Specifies the IPv6 address of the DNS server in the network where the helper appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">IPv6PrefixLength</span></p>
        </td>
        <td>
          <p>For the IPv6 addresses specified.</p><p>Specifies the length of the IPv6 prefix.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</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">NetworkInfo</span></p>
        </td>
        <td>
          <p>Specifies the network settings for the helper appliance.</p><p><strong>Note</strong>:</p><ul><li>The helper appliance must be placed in the same network where the backup server resides.</li><li>If you do not provide this parameter, the cmdlet will apply the VM network settings for the helper appliance.</li></ul><p>Accepts the <code>IVBRServerNetworkInfo[]</code> object. To get this object, run the <a href="get-vbrviservernetworkinfo.md"><code>Get-VBRViServerNetworkInfo</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>IVBRServerNetworkInfo</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">NetworkMask</span></p>
        </td>
        <td>
          <p>For the <code>IP</code> parameter specified.</p><p>Specifies the network mask that you want to assign to the helper appliance.</p><p><strong>Note</strong>: The helper appliance must be placed in the same network where the backup server resides.</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>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">PreferredDNSServer</span></p>
        </td>
        <td>
          <p>Specifies the IPv4 address of the alternate DNS server in the network where the helper appliance resides.</p>
        </td>
        <td style="width:10%;">
          <p><code>IPAddress</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">ResourcePool</span></p>
        </td>
        <td>
          <p>Specifies the resource pool to which the helper appliance must be placed.</p><p>Accepts the <code>CViResourcePoolItem</code> object. To get this object, run the <a href="find-vbrviresourcepool.md"><code>Find-VBRViResourcePool</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CViResourcePoolItem</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">Server</span></p>
        </td>
        <td>
          <p>Specifies the ESXi host on which the temporary helper appliance must be registered.</p><p><strong>Note</strong>: If you specify a host for the Novell file system proxy appliance, make sure that it allows running VMs with 64-bit guest OSes.</p><p>Accepts the <code>CHost</code> object. To get 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">VLanId</span></p>
        </td>
        <td>
          <p>Specifies an ID of an isolated network. The cmdlet will create the isolated network with the specified ID.</p>
        </td>
        <td style="width:10%;">
          <p><code>Int32</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 `VBRFileRestoreLinuxHelperApplianceOptions` object that defines settings for a temporary helper appliance.

## Examples

::: example
### Defining Temporary Helper Appliance for File Restore from CDP Replica

This example shows how to define settings for a temporary helper appliance for file restore from a CDP replica. The helper appliance will be deployed on the `ESXi01` ESXi host in the `Servers` resource pool.

```
$server = Get-VBRServer -Name "ESXi01"
$resourcepool = Find-VBRViResourcePool -Server $server -Name "Servers"
$helper = New-VBRFileRestoreLinuxHelperApplianceOptions -Server $server -ResourcePool $resourcepool
```

Perform the following steps:

1. Run the [`Get-VBRServer`](get-vbrserver.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$server` variable.
2. Run the [`Find-VBRViResourcePool`](find-vbrviresourcepool.md) cmdlet. Set the `$server` variable as the `Server` parameter value. Specify the `Name` parameter value. Save the result to the `$resourcepool` variable.
3. Run the `New-VBRFileRestoreLinuxHelperApplianceOptions` cmdlet. Set the `$server` variable as the `Server` parameter value. Set the `$resourcepool` variable as the `ResourcePool` parameter value. Save the result to the `$helper` variable.

:::