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

# Add-VBRCloudTenant

## Short Description
Creates standalone tenant accounts.

**Platform**: VMware, Hyper-V

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

Requires a cloud provider license.

## Syntax
```
Add-VBRCloudTenant -Name <String> [-Description <String>] [-EnableLeaseExpiration]
 [-LeaseExpirationDate <DateTime>] -Password <String> [-Resources <VBRCloudTenantResource[]>] [-HashedPassword]
 [-EnableThrottling] [-ThrottlingValue <Decimal>] [-ThrottlingUnit <VBRSpeedUnit>] [-MaxConcurrentTask <Int32>]
 [-ReplicationResources <VBRCloudTenantReplicationResources>] [-EnableBackupProtection]
 [-BackupProtectionPeriod <Int32>] [-GatewaySelectionType <VBRCloudGatewaySelectionType>]
 [-GatewayPool <VBRCloudGatewayPool[]>] [-EnableGatewayFailover] [<CommonParameters>]
```

## Detailed Description
This cmdlet creates new simple cloud 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 <code>1-99</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">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">EnableBackupProtection</span></p>
        </td>
        <td>
          <p>Enables protection for the tenant's backups from complete removal.</p><p>If you provide this parameter, 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, use 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>Enables lease expiration settings for the simple tenant account.</p><p>Use 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>Use 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">HashedPassword</span></p>
        </td>
        <td>
          <p>Defines that you submit the hashed password. The hashed passwords are stored in the Veeam backup database.</p><p>Use this parameter, for example, to restore tenant accounts.</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">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</code>, <code>31.12.9999</code>.</p><p>Accepts the <code>DateTime</code> object.</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 the name that you want to assign to the simple tenant account.</p><p>The tenant name must meet the following requirements:</p><ul><li>The maximum length of the tenant name is 128 characters. It is recommended that you create short tenant names to avoid problems with long paths to backup files on the cloud repository.</li><li>The tenant name may contain space characters.</li><li>The tenant name must not contain the following characters: \\/:*?\\"&lt;&gt;|=; as well as Unicode characters.</li><li>The tenant name must not end with the period character [.].</li></ul>
        </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">Password</span></p>
        </td>
        <td>
          <p>Specifies the password that you want to set to the simple tenant account.</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">ReplicationResources</span></p>
        </td>
        <td>
          <p>Allocates replication resources to the tenant.</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>Accepts the <a href="vbrcloudtenantreplicationresources.md"><code>VBRCloudTenantReplicationResources</code></a> object. To get this object, run the <a href="new-vbrcloudtenantreplicationresources.md"><code>New-VBRCloudTenantReplicationResources</code></a> cmdlet.</p>
        </td>
        <td style="width:10%;">
          <p><a href="vbrcloudtenantreplicationresources.md"><code>VBRCloudTenantReplicationResources</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">Resources</span></p>
        </td>
        <td>
          <p>Specifies the 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 get 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>
    </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
[`VBRCloudTenant`](vbrcloudtenant.md)

## Examples

::: example
### Example 1. Creating Cloud Tenant Account

This example shows how to create a simple cloud tenant account. The cmdlet will create the tenant with the following settings:

- Backup resources option enabled
- Lease expiration settings enabled

```
$repository = Get-VBRBackupRepository -Name "SilverRepository"
$backupresources = New-VBRCloudTenantResource -Repository $repository -RepositoryFriendlyName "Standard Tier Repository" -Quota 10
Add-VBRCloudTenant -Name "ABC Company" -Description "User account for ABC company" -EnableLeaseExpiration -LeaseExpirationDate "12/30/2024" -Password "Pass123" -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. Set the `$repository` variable as the `Repository` parameter value. Specify the `RepositoryFriendlyName` and `Quota` parameter values. Save the result to the `$backupresources` variable.
3. Run the `Add-VBRCloudTenant` cmdlet. Specify the following settings:

   - Specify the `Name` parameter value.
   - Specify the `Description` parameter value.
   - Provide the `EnableLeaseExpiration` parameter.
   - Specify the `LeaseExpirationDate` parameter value.
   - Specify the `Password` parameter value.
   - Set the `$backupresources` variable as the `Resources` parameter value.

:::

::: example
### Example 2. Creating Cloud Tenant Account with Backup and Replication Resources

This example shows how to create a simple cloud tenant account with backup and replication resources.

```
$repository = Get-VBRBackupRepository -Name "SilverRepository"
$backupresources = New-VBRCloudTenantResource -Repository $repository -RepositoryFriendlyName "Standard Tier Repository" -Quota 10
$replicationresources = New-VBRCloudTenantReplicationResources -EnableNetworkFailoverResources
Add-VBRCloudTenant -Name "ABC Company" -Description "User account for ABC company" -Password "Pass123" -Resources $backupresources -ReplicationResources $replicationresources
```

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. Set the `$repository` variable as the `Repository` parameter value. Specify the `RepositoryFriendlyName` and the `Quota` parameter values. Save the result to the `$backupresources` variable.
3. Run the [`New-VBRCloudTenantReplicationResources`](new-vbrcloudtenantreplicationresources.md) cmdlet. Provide the `EnableNetworkFailoverResources` parameter. Save the result to the `$replicationresources` variable.
4. Run the `Add-VBRCloudTenant` cmdlet. Specify the following settings:

   - Specify the `Name` and the `Description` parameter values.
   - Specify the `Password` parameter value.
   - Set the `$backupresources` variable as `Resources` parameter value.
   - Set the `$replicationresources` variable as `ReplicationResources` parameter value.

:::

## Related Commands

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