Help Center
Choose product document...
Veeam Backup & Replication 9.5
PowerShell Reference

Add-VBRCloudTenant

Short Description

Creates cloud tenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

Add-VBRCloudTenant -Name <string> -Password <string> [-Description <string>] [-EnableLeaseExpiration] [-LeaseExpirationDate <datetime>] [-Resources <VBRCloudTenantResource[]>] [-HashedPassword] [-EnableThrottling] [-ThrottlingValue <decimal>] [-ThrottlingUnit <VBRSpeedUnit> {MbitPerSec | MbytePerSec | KbytePerSec}] [-MaxConcurrentTask <int>] [-ReplicationResources <VBRCloudTenantReplicationResources>]  [<CommonParameters>]

Detailed Description

This cmdlet creates a new cloud tenant account.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

Name

Specifies the name you want to assign to the tenant account.

The tenant name must meet the following requirements:

  • 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.
  • The tenant name may contain space characters.
  • The tenant name must not contain the following characters: \/:*?\"<>|=; as well as Unicode characters.
  • The tenant name must not end with the period character [.].

True

Named

False

False

Password

Specifies the password you want to set to the tenant account.

True

Named

False

False

Description

Specifies the description of the tenant account.

False

Named

False

False

Enable
Lease
Expiration

Indicates that the tenant account must use lease expiration settings.

Use LeaseExpirationDate parameter to set the lease expiration date.

False

Named

False

False

Lease
Expiration
Date

Used to specify the lease expiration date for the EnableLeaseExpiration parameter.

Accepts DateTime type.

Default: 23:59:59.9999999, 31.12.9999.

False

Named

False

False

Resources

Specifies the array of backup resource quotas you want to allocate to the tenant.

You must set the Resources or the ReplicationResources parameter, or a combination of both, to create a tenant.

Accepts VBRCloudTenantResource type.

NOTE: 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.

False

Named

False

False

Hashed
Password

Indicates that you submit the hashed password. The hashed passwords are stored in Veeam backup database.

Use this parameter, for example, to restore tenant accounts.

False

Named

False

False

Enable
Throttling

Indicates that the network throttling must be enabled  to limit the maximum throughput of traffic.

Use the ThrottlingValue and ThrottlingUnit parameters to set the maximum value.

False

Named

False

False

Throttling
Value

Used to set the value for the EnableThrottling parameter.

Indicates the maximum throughput value.

False

Named

False

False

Throttling
Unit

Used to set the value for the EnableThrottling parameter.

Specifies the measure units for the ThrottlingValue parameter: MbitPerSec, MbytePerSec, KbytePerSec.

Default: MbytePerSec.

False

Named

False

False

MaxConcurrentTask

Specifies the maximum number of tasks the tenant can process in parallel.

The number of tasks is the number of VM disks processed by one job targeted at the cloud repository or cloud host.

False

Named

False

False

Replication
Resources

Allocates replication resources to the tenant.

You must set the Resources or the ReplicationResources parameter, or a combination of both, to create a tenant.

Accepts VBRCloudTenantReplicationResources type.

False

Named

False

False

<CommonParameters>

This cmdlet supports Microsoft PowerShell common parameters. For more information about common parameters, see http://go.microsoft.com/fwlink/p/?LinkID=113216.

Return Type

VBRCloudTenant

Example 1

This command adds a tenant with backup resources and lease expiration settings enabled.

  1. Pre-configure backup resources. For details, see New-VBRCloudTenantResource. Save the result to the '$backupresources' variable.
  2. Run Add-VBRCloudTenant and set the tenant name, password, description and lease period. Use the '$backupresources' variable to assign backup resources to the tenant.

PS C:\PS> Add-VBRCloudTenant -Name "ABC Company" -Description "User account for ABC company" -EnableLeaseExpiration -LeaseExpirationDate "12/30/2017" -Password "Pass123" -Resources $backupresources

Example 2

This command adds a tenant with backup and replication resources.

  1. Pre-configure backup resources. For details, see New-VBRCloudTenantResource. Save the result to the '$backupresources' variable.
  2. Pre-configure replication resources. For details, see New-VBRCloudTenantReplicationResources. Save the result to the '$replicationresources' variable.
  3. Run Add-VBRCloudTenant and set the tenant name, password and description. Use the '$backupresources' variable and the '$replicationresources' variable to assign resources to the tenant.

PS C:\PS> Add-VBRCloudTenant -Name "ABC Company" -Description "User account for ABC company" -Password "Pass123" -Resources $backupresources -ReplicationResources $replicationresources

Related Commands

New-VBRCloudTenantResource

Veeam Large Logo

User Guide for VMware vSphere

User Guide for Microsoft Hyper-V

Enterprise Manager User Guide

Veeam Cloud Connect Guide

Veeam Backup Explorers User Guide

PowerShell Reference

RESTful API Reference

Veeam Backup FREE Edition User Guide

Veeam Backup for Microsoft Office 365

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation