---
title: "New-VEMDBLinuxCredentials"
description: "Creates a Linux credential record to connect to a target MongoDB server. Product: Veeam Backup & Replication Product Edition: Enterprise Plus, Veeam Universal License This cmdlet creates a Linux credential record."
canonical: "https://helpcenter.veeam.com/docs/vbr/explorers_powershell/new-vemdblinuxcredentials.html"
breadcrumb: "Veeam Explorers PowerShell Reference > Veeam Explorers PowerShell Reference > Veeam Explorer for MongoDB > New-VEMDBLinuxCredentials"
dateModified: "2026-08-18"
---

# New-VEMDBLinuxCredentials

## Short Description
Creates a Linux credential record to connect to a target MongoDB server.

**Product**: Veeam Backup & Replication

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

## Syntax
```
New-VEMDBLinuxCredentials [-Account] <String> [-Password <SecureString>] [-PrivateKeyFilePath <String>]
 [-Passphrase <SecureString>] [-ElevateAccountToRoot] [-AddToSudoers] [-UseSuIfSudoUnavailable]
 [-RootPassword <SecureString>] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates a Linux credential record. You can use this credential record to connect to the target Linux machine with MongoDB. Note that the user must have root privileges on the target server.

Run the [`Start-VEMDBDataRestore`](start-vemdbdatarestore.md) cmdlet to restore MongoDB collections to the primary node of a MongoDB replica set or restore the entire instance to a target Linux machine with MongoDB.

## 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">Account</span></p>
        </td>
        <td>
          <p>Specifies the user name of the account that will be used to connect to the target 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>0</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">AddToSudoers</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will add the account to the <em>sudoers</em> file.</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">ElevateAccountToRoot</span></p>
        </td>
        <td>
          <p>Defines that the account must be elevated to <em>root</em>.</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">Passphrase</span></p>
        </td>
        <td>
          <p>Specifies a passphrase. The cmdlet will use that passphrase to connect to the target Linux server.</p>
        </td>
        <td style="width:10%;">
          <p><code>SecureString</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">Password</span></p>
        </td>
        <td>
          <p>Specifies a password that will be used to connect to the target Linux server.</p>
        </td>
        <td style="width:10%;">
          <p><code>SecureString</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">PrivateKeyFilePath</span></p>
        </td>
        <td>
          <p>Specifies the path for the private key. The cmdlet will use that key to connect to the target Linux server.</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">RootPassword</span></p>
        </td>
        <td>
          <p>Specifies the <em>root</em> password.</p>
        </td>
        <td style="width:10%;">
          <p><code>SecureString</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">UseSuIfSudoUnavailable</span></p>
        </td>
        <td>
          <p>Defines that the <em>su</em> command is used instead of the <em>sudo</em> command.</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>
    </table>

`<CommonParameters>`

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the [About Common Parameters](http://go.microsoft.com/fwlink/p/?LinkID=113216) section of Microsoft Docs.

## Output Object
The cmdlet returns the [`VEMDBLinuxCredentials`](vemdblinuxcredentials.md) object that contains a Linux credential record.

## Examples

::: example
### Example 1. Creating Linux Credential Record with Password

This example shows how to create a Linux credential record with the password authentication method. Veeam Explorer for MongoDB will use these credentials to connect to the target Linux machine.

```
$securepassword = Read-Host -Prompt "Enter password" -AsSecureString
$credentials = New-VEMDBLinuxCredentials -Account "root" -Password $securepassword
```

Perform the following steps:

1. Run the [`Read-Host`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host?view=powershell-7.6) cmdlet to create a secure password. Enter credentials that will be used to connect to the target Linux machine. Provide the `AsSecureString` parameter. Save the result to the `$securepassword` variable.
2. Run the `New-VEMDBLinuxCredentials` cmdlet. Specify the `Account` parameter value. Set the `$securepassword` variable as the `Password` parameter value. Save the result to the `$credentials` variable to use it with other cmdlets.

:::

::: example
### Example 2. Creating Linux Credential Record with Private Key

This example shows how to create a Linux credential record with the private key authentication method. Veeam Explorer for MongoDB will use these credentials to connect to the target Linux machine.

```
$securepassword = Read-Host -Prompt "Enter secure string" -AsSecureString
$credentials = New-VEMDBLinuxCredentials -Account "root" -PrivateKeyFilePath "/home/.ecryptfs/<user>/.Private/" -Passphrase $securepassword
```

Perform the following steps:

1. Run the [`Read-Host`](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host?view=powershell-7.6) cmdlet to create a secure password. Enter credentials that will be used to connect to the target Linux machine. Provide the `AsSecureString` parameter. Save the result to the `$securepassword` variable.
2. Run the `New-VEMDBLinuxCredentials` cmdlet. Specify the following settings:

   - Specify the `Account` parameter value.
   - Specify the `PrivateKeyFilePath` parameter value.
   - Set the `$securepassword` variable as the `Passphrase` parameter value.

   Save the result to the `$credentials` variable to use it with other cmdlets.

:::

## Related Commands

[``Read-Host``](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.utility/read-host?view=powershell-7.6)