---
title: "Install-VBRLinuxTransportService"
description: "This cmdlet installs Veeam Data Mover for guest processing on Linux VMs. For more information on Linux distributives, for which guest processing is supported, see the Platform Support section of Veeam Backup & Replication User Guide."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/install-vbrlinuxtransportservice.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Jobs > Veeam Data Movers for Guest Processing > Install-VBRLinuxTransportService"
dateModified: "2026-08-20"
---

# Install-VBRLinuxTransportService

## Short Description
Installs Veeam Data Mover for guest processing on Linux VMs.

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

## Syntax
```
Install-VBRLinuxTransportService -Entity <IVmItem[]> -SSHUser <String> -SSHPassword <String> [-SSHPort <Int32>]
 [-SSHElevateToRoot] [-SSHAddToSudoers] [-SSHFailoverToSu] [-SSHRootPassword <String>] [<CommonParameters>]
```

## Detailed Description
This cmdlet installs Veeam Data Mover for guest processing on Linux VMs. For more information on Linux distributives, for which guest processing is supported, see the [Platform Support](https://helpcenter.veeam.com/docs/vbr/userguide/platform_support.html?ver=13) section of Veeam Backup & Replication User Guide.

After you install Veeam Data Mover, Veeam Backup & Replication will use it for guest processing tasks.

## 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">Entity</span></p>
        </td>
        <td>
          <p>Specifies an array of Linux VMs to which you want to install Veeam Data Mover.</p><p>Accepts the <code>IVmItem</code>[] object. To get this object, run the <a href="find-vbrhventity.md"><code>Find-VBRHvEntity</code></a>, <a href="find-vbrvientity.md"><code>Find-VBRViEntity</code></a> or <a href="find-vbrvcloudentity.md"><code>Find-VBRvCloudEntity</code></a> cmdlets.</p>
        </td>
        <td style="width:10%;">
          <p><code>IVmItem[]</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 the <code>sudoers</code> file.</p><p>Default: (if the <code>ElevateToRoot</code> parameter is set to <code>False</code>) <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>
        </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 <code>su</code> command if the <code>sudo</code> command fails.</p><p>If you do not provide this parameter and <code>sudo</code> fails, Veeam Backup & Replication will not be able to connect to a Linux VMs.</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">SSHPassword</span></p>
        </td>
        <td>
          <p>Specifies the password you want to use for authenticating with the Linux VMs.</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 Web service port for connection to the Linux server.</p><p>Default: <code>22</code>.</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 VMs.</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 `VBRLinuxTransportService` object that contains Veeam Data Mover settings for guest processing on a Linux VM.

## Examples

::: example
### Installing Veeam Data Mover to Linux VM

This example shows how to install Veeam Data Mover to the `Lin2049` Linux VM.

```
$linVm = Find-VBRViEntity -Name "Lin2049"
Install-VBRLinuxTransportService -Entity $linVm -SSHUser Administrator -SSHPassword XXXXXXXXXX -SSHElevateToRoot -SSHAddToSudoers -SSHFailoverToSu -SSHRootPassword XXXXXXXXXX
```

Perform the following steps:

1. Run the [`Find-VBRViEntity`](find-vbrvientity.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$linsrv` variable.
2. Run the `Install-VBRLinuxTransportService` cmdlet. Specify the following settings: 

   - Set the `$linVm` variable as the `Entity` parameter value.
   - Specify the `SSHUser` parameter value.
   - Specify the `SSHPassword` parameter value.
   - Provide the `SSHElevateToRoot` parameter.
   - Provide the `SSHAddToSudoers` parameter.
   - Provide the `SSHFailoverToSu` parameter.
   - Specify the `SSHRootPassword` parameter value.

:::

## Related Commands

- [`Find-VBRViEntity`](find-vbrvientity.md)
- [`Find-VBRHvEntity`](find-vbrhventity.md)
- [`Find-VBRvCloudEntity`](find-vbrvcloudentity.md)