---
title: "Add-VBRAdCloudTenant"
description: "This cmdlet creates Active Directory tenant accounts."
canonical: "https://helpcenter.veeam.com/docs/vbr/powershell/add-vbradcloudtenant.html"
breadcrumb: "Veeam PowerShell Reference > Veeam PowerShell Reference > Veeam Cloud Connect > Veeam Cloud Connect Tenant Accounts > Add-VBRAdCloudTenant"
dateModified: "2026-08-20"
---

# Add-VBRAdCloudTenant

## Short Description
Creates Active Directory tenant accounts.

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

```
Add-VBRAdCloudTenant -Name <String> -Domain <String> [-Description <String>] [-EnableLeaseExpiration]
 [-LeaseExpirationDate <DateTime>] [-Resources <VBRCloudTenantResource[]>] [-EnableThrottling]
 [-ThrottlingValue <Decimal>] [-ThrottlingUnit <VBRSpeedUnit>] [-MaxConcurrentTask <Int32>]
 [-EnableBackupProtection] [-BackupProtectionPeriod <Int32>]
 [-GatewaySelectionType <VBRCloudGatewaySelectionType>] [-GatewayPool <VBRCloudGatewayPool[]>]
 [-EnableGatewayFailover] -DomainUrl <String> [-DomainPort <Int32>] [-DomainUsername <String>]
 [-DomainUserPassword <String>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>DomainCredentials</code></p>

```
Add-VBRAdCloudTenant -Name <String> -Domain <String> [-Description <String>] [-EnableLeaseExpiration]
 [-LeaseExpirationDate <DateTime>] [-Resources <VBRCloudTenantResource[]>] [-EnableThrottling]
 [-ThrottlingValue <Decimal>] [-ThrottlingUnit <VBRSpeedUnit>] [-MaxConcurrentTask <Int32>]
 [-EnableBackupProtection] [-BackupProtectionPeriod <Int32>]
 [-GatewaySelectionType <VBRCloudGatewaySelectionType>] [-GatewayPool <VBRCloudGatewayPool[]>]
 [-EnableGatewayFailover] -DomainUrl <String> [-DomainPort <Int32>] [-DomainCredentials <CCredentials>] [<CommonParameters>]
```
  </li>
  <li>
    <p><code>ServiceAccount</code></p>

```
Add-VBRAdCloudTenant -Name <String> -Domain <String> [-Description <String>] [-EnableLeaseExpiration]
 [-LeaseExpirationDate <DateTime>] [-Resources <VBRCloudTenantResource[]>] [-EnableThrottling]
 [-ThrottlingValue <Decimal>] [-ThrottlingUnit <VBRSpeedUnit>] [-MaxConcurrentTask <Int32>]
 [-EnableBackupProtection] [-BackupProtectionPeriod <Int32>]
 [-GatewaySelectionType <VBRCloudGatewaySelectionType>] [-GatewayPool <VBRCloudGatewayPool[]>]
 [-EnableGatewayFailover] -DomainUrl <String> [-DomainPort <Int32>] [-UseServiceAccount] [<CommonParameters>]
```
  </li>
</ul>

## Detailed Description
This cmdlet creates Active Directory tenant accounts.

## 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">BackupProtectionPeriod</span></p>
        </td>
        <td>
          <p>For the <code>EnableBackupProtection</code> parameter.</p><p>Specifies the number of days to keep the tenant's deleted backups on the service provider side.</p><p>Can be set to 1–99.</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">Description</span></p>
        </td>
        <td>
          <p>Specifies the description of the simple tenant account.</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">Domain</span></p>
        </td>
        <td>
          <p>Specifies a domain name where an Active Directory user is located.</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">DomainCredentials</span></p>
        </td>
        <td>
          <p>Specifies the credentials that the cmdlet will use to connect to the domain controller.</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">DomainPort</span></p>
        </td>
        <td>
          <p>Specifies a port number which will be used to connect to the domain.</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">DomainUrl</span></p>
        </td>
        <td>
          <p>Specifies a URL of the domain controller. The cmdlet will connect to this domain controller to verify that the user, for whom you want to create a tenant account, exists in Active Directory and this user is available.</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">DomainUsername</span></p>
        </td>
        <td>
          <p>Specifies a name of a user who has permissions to get a list of the users from the domain controller.</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">DomainUserPassword</span></p>
        </td>
        <td>
          <p>Specifies a password of a user who has permissions to get a list of the users from the domain controller.</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">EnableBackupProtection</span></p>
        </td>
        <td>
          <p>Prevents the tenant's backups from complete removal.</p><p>With this option, the tenant's deleted backups will be placed to the recycle bin on the service provider's side. The backups will be kept in the bin for the specified protection period. When this period ends, the backups are removed permanently.</p><p>To specify the protection period, provide the <code>BackupProtectionPeriod</code> parameter.</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">EnableGatewayFailover</span></p>
        </td>
        <td>
          <p>Enables gateway pool failover option. In case the gateway pool is down, Veeam Backup & Replication will route the data through the gateway that is not added to any gateway pool.</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">EnableLeaseExpiration</span></p>
        </td>
        <td>
          <p>Defines that an Active Directory tenant account must use lease expiration settings.</p><p>Provide the <code>LeaseExpirationDate</code> parameter to set the lease expiration date.</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">EnableThrottling</span></p>
        </td>
        <td>
          <p>Enables the network throttling to set the bandwidth limitations.</p><p>Provide the <code>ThrottlingValue</code> and <code>ThrottlingUnit</code> parameters to set the maximum value.</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">GatewayPool</span></p>
        </td>
        <td>
          <p>Specifies the gateway pool. Veeam Backup & Replication will route the data through the specified gateway pool.</p><p>Accepts the <a href="vbrcloudgatewaypool.md"><code>VBRCloudGatewayPool</code></a>[] object. To get this object, run the <a href="get-vbrcloudgatewaypool.md"><code>Get-VBRCloudGatewayPool</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrcloudgatewaypool.md"><code>VBRCloudGatewayPool[]</code></a></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">GatewaySelectionType</span></p>
        </td>
        <td>
          <p>Specifies the type of gateway, you want to assign to the Cloud Director tenant accounts.</p><ul><li><code>StandaloneGateways</code> — use this option to route the data through the gateway that is not added to the gateway pool.</li><li><code>GatewayPool</code> — use this option to route the data through the gateway pool.</li></ul>
        </td>
        <td style="width:10%;">
          <p><code>VBRCloudGatewaySelectionType</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">LeaseExpirationDate</span></p>
        </td>
        <td>
          <p>For the <code>EnableLeaseExpiration</code> option.</p><p>Specifies the lease expiration date.</p><p>Default: <code>23:59:59.9999999, 31.12.9999</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>DateTime</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">MaxConcurrentTask</span></p>
        </td>
        <td>
          <p>Specifies the maximum number of tasks the tenant can process in parallel.</p><p>The number of tasks is the number of VM disks processed by one job targeted at the cloud repository or cloud host.</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">Name</span></p>
        </td>
        <td>
          <p>Specifies an Active Directory user for which you want to create a tenant account. The cmdlet will create a tenant account with this user.</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">Resources</span></p>
        </td>
        <td>
          <p>Specifies an array of backup resource quotas you want to allocate to the simple tenant account.</p><p>You must set the <code>Resources</code> or the <code>ReplicationResources</code> parameter, or a combination of both, to create a tenant.</p><p><strong>Note</strong>: When you assign multiple resource quotas to one tenant account, the resource quotas must have unique Repository Friendly Names and they must use different repositories.</p><p>Accepts the <a href="vbrcloudtenantresource.md"><code>VBRCloudTenantResource</code></a>[] object. To create this object, run the <a href="new-vbrcloudtenantresource.md"><code>New-VBRCloudTenantResource</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrcloudtenantresource.md"><code>VBRCloudTenantResource[]</code></a></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">ThrottlingUnit</span></p>
        </td>
        <td>
          <p>For the <code>EnableThrottling</code> option.</p><p>Specifies the measure units for the bandwidth value. You can select either of the following:</p><ul><li><code>MbitPerSec</code></li><li><code>MbytePerSec</code></li><li><code>KbytePerSec</code></li></ul><p>Default: <code>MbytePerSec</code>.</p>
        </td>
        <td style="width:10%;">
          <p><code>VBRSpeedUnit</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">ThrottlingValue</span></p>
        </td>
        <td>
          <p>For the <code>EnableThrottling</code> option.</p><p>Specifies the maximum bandwidth value in Mbps for transferring the tenant data to the SP side.</p>
        </td>
        <td style="width:10%;">
          <p><code>Decimal</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">UseServiceAccount</span></p>
        </td>
        <td>
          <p>Defines that to create a tenant account, the cmdlet will use the account under which the Veeam Backup Service runs to connect to the domain controller.</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 [ Microsoft Docs](https://docs.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_commonparameters?view=powershell-7).

## Output Object
[`VBRAdCloudTenant`](vbradcloudtenant.md)

## Examples

::: example
### Adding Active Directory Tenant Account

This example shows how to create the `jane.doe` Active Directory tenant account with the following settings:

- The backup resources option is enabled.
- The user is located on the `tech.local` domain controller.
- The URL of the domain controller is `dc01.tech.local`.
- Veeam Backup & Replication uses the `Administrator` user and the `SecurePa$$` password to verify that the `jane.doe` user is added to the `dc01.tech.local` domain.

```
$repository = Get-VBRBackupRepository -Name "SilverRepository"
$backupresources = New-VBRCloudTenantResource -Repository $repository -RepositoryFriendlyName "Standard Tier Repository" -Quota 10
Add-VBRaDCloudTenant -Name "jane.doe" -Domain "tech.local" -DomainUrl "dc01.tech.local" -DomainUsername "Administrator" -DomainUserPassword "SecurePa$$" -Resources $backupresources
```

Perform the following steps:

1. Run the [`Get-VBRBackupRepository`](get-vbrbackuprepository.md) cmdlet. Specify the `Name` parameter value. Save the result to the `$repository` variable.
2. Run the [`New-VBRCloudTenantResource`](new-vbrcloudtenantresource.md) cmdlet. Specify the `Repository`, `RepositoryFriendlyName` and the `Quota` parameter values. Save the result to the `$backupresources` variable.
3. Run the `Add-VBRaDCloudTenant` cmdlet. Specify the following settings:

   - Specify the `Name` parameter value. 
   - Specify the `Domain` parameter value.  
   - Specify the `DomainUrl` parameter value.
   - Specify the `DomainUsername` parameter value.
   - Specify the `DomainUserPassword` parameter value.
   - Set the `$backupresources` variable as the `Resources` parameter value.

:::

## Related Commands

- [`Get-VBRBackupRepository`](get-vbrbackuprepository.md)
- [`New-VBRCloudTenantResource`](new-vbrcloudtenantresource.md)