---
title: "Set-VBRLinuxFileRestoreHelperHost"
description: "Modifies temporary Linux helper host specifications. Product Edition: Standard, Enterprise, Enterprise Plus, Veeam Universal License This cmdlet provides the following parameter sets: This cmdlet modifies temporary Linux helper host specifications."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/set-vbrlinuxfilerestorehelperhost.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Data Recovery > Guest OS File Recovery > Set-VBRLinuxFileRestoreHelperHost"
dateModified: "2026-08-19"
---

# Set-VBRLinuxFileRestoreHelperHost

## Short Description
Modifies temporary Linux helper host specifications.

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

## Syntax

This cmdlet provides the following parameter sets:

<ul class="syntax-sets">
  <li>
    <p><code>AddCredentials (Default)</code></p>

```
Set-VBRLinuxFileRestoreHelperHost -HelperHost <VBRLinuxFileRestoreHelperHost> -SSHUser <String>
 -SSHPassword <String> [-SSHPort <Int32>] [-SSHElevateToRoot] [-SSHAddToSudoers] [-SSHFailoverToSu]
 [-SSHRootPassword <String>] [-SSHFingerprint <String>] [-Force] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>Credentials</code></p>

```
Set-VBRLinuxFileRestoreHelperHost -HelperHost <VBRLinuxFileRestoreHelperHost> [-Credentials <CCredentials>]
 [-SSHFingerprint <String>] [-Force] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet modifies temporary Linux helper host specifications.

Note that the cmdlet creates a copy of the `HelperHost` you provide in a command. To use the new helper host, you must assign it to a variable.

::: note

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameter values with new values. The parameters that you omit will remain unchanged.

:::

## 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">Credentials</span></p>
        </td>
        <td>
          <p>Specifies the credentials you want to use for authenticating with the Linux server.</p><p>Accepts the <code>CCredentials</code> object. To get 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>False</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">Force</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will modify temporary Linux helper host specification without showing warnings in the PowerShell console.</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">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>True (ByPropertyName, ByValue)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SSHAddToSudoers</span></p>
        </td>
        <td>
          <p>Defines that the user account is added to sudoers file.</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">SSHElevateToRoot</span></p>
        </td>
        <td>
          <p>Defines that non-root users are provided with the root account privileges.</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">SSHFailoverToSu</span></p>
        </td>
        <td>
          <p>Defines that Veeam Backup & Replication will use the su command if the sudo command fails.</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">SSHFingerprint</span></p>
        </td>
        <td>
          <p>Specifies the SSH host fingerprint.</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">SSHPassword</span></p>
        </td>
        <td>
          <p>Specifies the password you want to use for authenticating with the Linux server.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</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">SSHPort</span></p>
        </td>
        <td>
          <p>Specifies the SSH port for connection to the Linux server.</p><p>Default: 22.</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">SSHRootPassword</span></p>
        </td>
        <td>
          <p>Specifies the root password used for authentication.</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">SSHUser</span></p>
        </td>
        <td>
          <p>Specifies the user name you want to use for authenticating with the Linux server.</p>
        </td>
        <td style="width:10%;">
          <p><code>String</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>
    </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 `VBRLinuxFileRestoreHelperHost` object that contains settings for a temporary Linux helper host specifications.

## Examples

::: example
### Example 1. Modifying Connectivity Options Using Existing Credentials

This example shows how to modify the connectivity options using the credentials that already exist in Veeam Backup & Replication.

```
$cred1 = Get-VBRCredentials -Name "root"
$cred2 = Get-VBRCredentials -Name "Linux Admin"
$hh1 = New-VBRLinuxFileRestoreHelperHost -Force -Name "154.19.90.152" -Credentials $cred1
$hh2 = Set-VBRLinuxFileRestoreHelperHost -HelperHost $hh1 -Credentials $cred2
```

Perform the following steps:

1. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$cred1` variable.
2. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$cred2` variable.
3. Run the [`New-VBRLinuxFileRestoreHelperHost`](new-vbrlinuxfilerestorehelperhost.md) cmdlet. Provide the `Force` parameter. Specify the `Name` parameter value. Set the `$cred1` variable as the `Credentials` parameter value. Save the result to the `$hh1` variable.
4. Run the `Set-VBRLinuxFileRestoreHelperHost` cmdlet. Set the `$hh1` variable as the `HelperHost` parameter value. Set the `$cred2` variable as the `Credentials` parameter value. Save the result to the `$hh2` variable.

:::

::: example
### Example 2. Modifying Connectivity Options by Specifying SSH Options

This example shows how to modify the connectivity options by specifying each SSH option separately.

```
$cred1 = Get-VBRCredentials -Name "root"
$hh1 = New-VBRLinuxFileRestoreHelperHost -Force -Name "Linux User" -Credentials $cred1
$hh2 = Set-VBRLinuxFileRestoreHelperHost -HelperHost $hh1 -SSHUser LinuxUser -SSHPassword P@ssw0rd -SSHElevateToRoot
```

Perform the following steps:

1. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$cred1` variable.
2. Run the [`New-VBRLinuxFileRestoreHelperHost`](new-vbrlinuxfilerestorehelperhost.md) cmdlet. Provide the `Force` parameter. Specify the `Name` parameter value. Set the `$cred1` variable as the `Credentials` parameter value. Save the result to the `$hh1` variable.
3. Run the `Set-VBRLinuxFileRestoreHelperHost` cmdlet.  Specify the following settings:

- Set the `$hh1` variable as the `HelperHost` parameter value.
- Specify the `SSHUser` parameter value.
- Specify the `SSHPassword` parameter value.
- Provide the `SSHElevateToRoot` parameter. 

Save the result to the `$hh2` variable.

:::

## Related Commands

- [`Get-VBRCredentials`](get-vbrcredentials.md)
- [`New-VBRLinuxFileRestoreHelperHost`](new-vbrlinuxfilerestorehelperhost.md)