---
title: "New-VBRMongoDBDeployment"
description: "This cmdlet discovers replica sets using a single MongoDB daemon within the deployed MongoDB application. Keep in mind the following requirements: You must input a host name, TCP port and valid credentials for the MongoDB application admin database."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/new-vbrmongodbdeployment.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-VBRMongoDBDeployment"
dateModified: "2026-09-02"
---

# New-VBRMongoDBDeployment

## Short Description
Connects to and adds MongoDB replica sets to protection groups.

**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 (Default)</code></p>

```
New-VBRMongoDBDeployment -HostName <String> -Port <Int32> -Credentials <CInternalCredentials> [<CommonParameters>]
```
  </li>
  <li>
    <p><code>SecureCredentials</code></p>

```
New-VBRMongoDBDeployment -HostName <String> -Port <Int32> -Credentials <CInternalCredentials> [-UseTls]
 [-ClientCertificatePath <String>] [-ClientCertificatePassword <String>] [-CACertificatePath <String>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>ClientCertificateSetName</code></p>

```
New-VBRMongoDBDeployment -HostName <String> -Port <Int32> [-UseTls] -ClientCertificatePath <String>
 [-ClientCertificatePassword <String>] [-CACertificatePath <String>] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet discovers replica sets using a single MongoDB daemon within the deployed MongoDB application.

Keep in mind the following requirements:

- You must input a host name, TCP port and valid credentials for the MongoDB application admin database.
- The MongoDB application user must have the `backup` role.

## 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">CACertificatePath</span></p>
        </td>
        <td>
          <p>Specifies the folder path to the CA certificate. Use this parameter to verify MongoDB server certificates.</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">ClientCertificatePassword</span></p>
        </td>
        <td>
          <p>Specifies the password for a client certificate.</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">ClientCertificatePath</span></p>
        </td>
        <td>
          <p>Specifies the folder path to a client certificate. Use this parameter for mTLS and x509 authentication methods.</p><p>This parameter is required when using the <code>ClientCertificateSetName</code> parameter set.</p><p>This parameter is not required when using the <code>SecureCredentials</code> parameter 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)</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 use for authenticating with the MongoDB replica set.</p><p>Accepts the <code>CCredentials</code> object. To create this object, run the <a href="get-vbrcredentials.md"><code>Get-VBRCredentials</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><code>CInternalCredentials</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">HostName</span></p>
        </td>
        <td>
          <p>Specifies the DNS name or an IP address of the computer that you want to use within the MongoDB application protection group.</p><p><strong>Note:</strong> Keep in mind that the MongoDB application host list becomes a template for the MongoHosts list for the UI. You can manually select which hosts should be included in the pool group. After that, you can use Linux root access credentials to automatically deploy Veeam Agent for Linux on the selected hosts.</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">Port</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>Int32</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">UseTls</span></p>
        </td>
        <td>
          <p>Specifies the use of the TLS certificate to secure the TLS connection between the Veeam infrastructure and MongoDB deployment.</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>
    </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
[`VBRMongoDBDeployment`](vbrmongodbdeployment.md)

## Examples

::: example
### Replica Set Connection and Data Loading

This example shows how to connect to a replica set and load the data from it.

```
$mongoCredentials1 = Get-VBRCredentials -Name "admin"
$replicaSet1 = New-VBRMongoDBDeployment -HostName host01 -Credentials $mongoCredentials1 -Port 27017
```

Perform the following steps:

1. Run the [`Get-VBRCredentials`](get-vbrcredentials.md) cmdlet. Specify the `Name` parameter with the user account you want to connect with. Save the result to the `$mongoCredentials1` variable.
2. Run the `New-VBRMongoDBDeployment` cmdlet. 

   - Specify the `HostName` parameter with the DNS name or IP address of the computer within the replica set.
   - Specify the `Credentials` parameter with the `$mongoCredentials1` variable. 
   - Specify the `Port` parameter with the port number `27017`.

:::