---
title: "New-VBRMongoDBCustomCredentials"
description: "This cmdlet creates custom credentials and temporary certificates for computers included in specific MongoDB replica sets."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrmongodbcustomcredentials.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Plug-Ins for Enterprise Applications, MongoDB Backup and Epic EHR System Protection > Working with Managed Veeam Plug-Ins, MongoDB Backup and Epic EHR System Protection > Application Backup Policy Settings for MongoDB > New-VBRMongoDBCustomCredentials"
dateModified: "2026-09-02"
---

# New-VBRMongoDBCustomCredentials

## Short Description
Creates custom credentials for computers within MongoDB replica sets to be selected for backup operations.

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

## Syntax

This cmdlet provides the following parameter sets:

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

```
New-VBRMongoDBCustomCredentials -Computer <VBRMongoDBComputer> [-Endpoint <String>] -Credentials <CCredentials> [<CommonParameters>]
```
  </li>
  <li>
    <p><code>TempCertificates</code></p>

```
New-VBRMongoDBCustomCredentials -Computer <VBRMongoDBComputer> [-Endpoint <String>] [-UseTemporaryCertificate] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>TempCredentials</code></p>

```
New-VBRMongoDBCustomCredentials -Computer <VBRMongoDBComputer> [-Endpoint <String>] [-SSHTempCredentials]
 -SSHUser <String> -SSHPassword <String> [-SSHPort <UInt16>] [-SSHElevateToRoot] [-SSHFailoverToSu]
 [-SSHRootPassword <String>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet creates custom credentials and temporary certificates for computers included in specific MongoDB replica sets.

## 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">Computer</span></p>
        </td>
        <td>
          <p>Specifies the computer whose credentials or temporary certificate you want to create.</p><p>Accepts the <a href="vbrmongodbcomputer.md"><code>VBRMongoDBComputer</code></a> object. To get this object, run the <a href="get-vbrmongodbcomputer.md"><code>Get-VBRMongoDBComputer</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrmongodbcomputer.md"><code>VBRMongoDBComputer</code></a></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 you want to set for individual computers.</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>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">Endpoint</span></p>
        </td>
        <td>
          <p>Specifies the DNS name or an IP address of the computer that is part of the MongoDB replica set.</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, ByValue)</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 the cmdlet will grant the non-root users with 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>True (ByPropertyName)</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 &amp; Replication will use the su command if the sudo command fails.</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>True (ByPropertyName)</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 to authenticate against individual computers in a protection group.</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>True (ByPropertyName)</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 port number over which Veeam Backup & Replication communicates with the MongoDB replica set. By default, Veeam Backup & Replication uses port <em>27017</em>.</p>
        </td>
        <td style="width:10%;">
          <p><code>UInt16</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">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>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">SSHTempCredentials</span></p>
        </td>
        <td>
          <p>Defines that the cmdlet will use single-use credentials to access Linux-based machines.</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">SSHUser</span></p>
        </td>
        <td>
          <p>Specifies the user name you want to use to authenticate against individual computers in a protection group.</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>True (ByPropertyName)</p>
        </td>
      </tr>
      <tr style="vertical-align:top">
        <td>
          <p class="Table_Text_Bold"><span class="Table_Text_Bold">UseTemporaryCertificate</span></p>
        </td>
        <td>
          <p>Specifies a temporary certificate you want to set for individual computers. Use this parameter to set a temporary certificate to use instead of custom credentials.</p><p><strong>Note:</strong> This parameter is required only if you do not use the <code>Credentials</code> parameter.</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>
    </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 [`VBRMongoDBCustomCredentials`](vbrmongodbcustomcredentials.md) object.

## Examples

::: example
### Configuring Custom Credentials and Temporary Certificate for Computers within Replica Sets

This command configures two individual computers within a replica set. The first is set up with custom credentials and the second is set up with a temporary certificate instead of custom credentials.

```
$computer0CustomCredentials = New-VBRMongoDBCustomCredentials -Computer $rs1Computers[0] -Credentials $computer0OsCredentials
$computer1CustomCredentials = New-VBRMongoDBCustomCredentials -Computer $rs2Computers[0] -UseTemporaryCertificate
```

Perform the following steps:

1. Run the `New-VBRMongoDBCustomCredentials` cmdlet. 

   - Specify the `Computer` parameter value with the name of a specific computer within the replica set.
   - Specify the `Credentials` parameter with the custom credentials you want to use.
   - Save the result to the `$computer0CustomCredentials` variable.

2. Run the `New-VBRMongoDBCustomCredentials` cmdlet. 

   - Specify the `Computer` parameter value with the name of a specific computer within the replica set. 
   - Use the `UseTemporaryCertificate` parameter to use a temporary certificate instead of custom credentials. 
   - Save the result to the `$computer1CustomCredentials` variable.

:::