Add-VBRCloudTenant

In this article

    Short Description

    Creates simple cloud tenant accounts.

    Applies to

    Platform: VMware, Hyper-V

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

    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>] [-EnableBackupProtection][-BackupProtectionPeriod <int>] [-GatewaySelectionType <VBRCloudGatewaySelectionType> {StandaloneGateways |GatewayPool}] [-GatewayPool <VBRCloudGatewayPool[]>] [-EnableGatewayFailover]  [<CommonParameters>]

    Detailed Description

    This cmdlet creates new simple cloud tenant accounts.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Name

    Specifies the name that you want to assign to the simple 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 that you want to set to the simple tenant account.

    True

    Named

    False

    False

    Description

    Specifies the description of the simple tenant account.

    False

    Named

    False

    False

    EnableLeaseExpiration

    Indicates that the simple tenant account must use lease expiration settings.

    Use the LeaseExpirationDate parameter to set the lease expiration date.

    False

    Named

    False

    False

    LeaseExpirationDate

    For the EnableLeaseExpiration option.

    Specifies the lease expiration date.

    Accepts the 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 simple tenant account.

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

    Accepts the 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

    HashedPassword

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

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

    False

    Named

    False

    False

    EnableThrottling

    Enables the network throttling to set the bandwidth limitations.

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

    False

    Named

    False

    False

    ThrottlingValue

    For the EnableThrottling option.

    Specifies the maximum bandwidth value in Mbps for transferring the tenant data to the SP side.

    False

    Named

    False

    False

    ThrottlingUnit

    For the EnableThrottling option.

    Specifies the measure units for the bandwidth value. You can select either of the following:

    • 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

    ReplicationResources

    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 the VBRCloudTenantReplicationResources type.

    False

    Named

    False

    False

    EnableBackupProtection

    Prevents the tenant's backups from complete removal.

    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.

    To specify the protection period, use the BackupProtectionPeriod parameter.

    False

    Named

    False

    False

    BackupProtectionPeriod

    For the EnableBackupProtection parameter.

    Specifies the number of days to keep the tenant`s deleted backups on the service provider side.

    Can be set to 1-99.

    False

    Named

    False

    False

    GatewaySelectionType

    Specifies the type of gateway, you want to assign to the vCD cloud tenant accounts.

    • StandaloneGateways - use this option to route the data through the gateway that is not added to the gateway pool.
    • GatewayPool - use this option to route the data through the gateway pool.

    False

    Named

    False

    False

    GatewayPool

    Specifies the gateway pool. Veeam Backup & Replication will route the data through the specified gateway pool.

    Accepts the VBRCloudGatewayPool type.

    False

    Named

    False

    False

    EnableGatewayFailover

    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.

    False

    Named

    False

    False

    <CommonParameters>

    This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

    Return Type

    VBRCloudTenant

    Example 1

    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

    You must perform the following steps:

    1. Run Get-VBRBackupRepository to specify the backup repository. Save the result to the $repository variable.
    2. Run New-VBRCloudTenantResource with the $repository variable, to specify cloud backup resources. Save the result to the $backupresources variable.
    3. Run Add-VBRCloudTenant with the $backupresources variable. Use the EnableLeaseExpiration and LeaseExpirationDate parameters to specify lease period settings.

    $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/2017" -Password "Pass123" -Resources $backupresources

    Example 2

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

    1. Run Get-VBRBackupRepository to specify the backup repository. Save the result to the $repository variable.
    2. Run New-VBRCloudTenantResource with the $repository variable, to specify backup resources. Save the result to the $backupresources variable.
    3. Run New-VBRCloudTenantReplicationResources with the $backupresources variable, to specify replication resources. Save the result to the $replicationresources variable.
    4. Run Add-VBRCloudTenant with the '$backupresources and $replicationresources variables.

    $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

    Related Commands

    Get-VBRBackupRepository

    New-VBRCloudTenantResource

    New-VBRCloudTenantReplicationResources