Add-VBRvCDCloudTenant

In this article

    Short Description

    Creates vCD cloud tenant accounts.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Add-VBRvCDCloudTenant -vCDOrganization <CVcdOrganizationItem> [-Description <String>] [-EnableLeaseExpiration [<SwitchParameter>]] [-LeaseExpirationDate <DateTime>] [-Resources <VBRCloudTenantResource[]>] [-EnableThrottling [<SwitchParameter>]] [-ThrottlingValue <Decimal>] [-ThrottlingUnit <VBRSpeedUnit>] [-MaxConcurrentTask <Int32>][-EnableBackupProtection [<SwitchParameter>]] [-BackupProtectionPeriod <Int32>] [-vCDReplicationResource <VBRvCDReplicationResource>] [-GatewaySelectionType <VBRCloudGatewaySelectionType>] [-GatewayPool <VBRCloudGatewayPool[]>] [-EnableGatewayFailover [<SwitchParameter>]] [<CommonParameters>]

    Detailed Description

    This cmdlet creates vCD cloud tenant accounts.

    You cannot specify the name and the password for vCD cloud tenant accounts.

    To set up replica resources for vCD cloud tenant accounts, you must perform the following steps:

    1. Create the Organization vDC in your VMware vCloud Director.
    2. Allocate the required Organization vDC for the vCD cloud tenant account.

    Run New-VBRvCDOrganizationvDCOptions to specify the Organization vDC that you want to allocate to the vCD cloud tenant.

    Run New-VBRvCDReplicationResource to specify the replication resource settings.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    vCDOrganization

    Specifies a vCD organization.

    NOTE: you must configure the vCD Cloud organization in vCloud Director beforehand.

    Accepts the CVcdOrganizationItem type.

    True

    Named

    False

    False

    Description

    Specifies a description of the vCD cloud tenant account.

    False

    Named

    False

    False

    EnableLeaseExpiration

    Indicates that a vCD cloud 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 an array of backup resource quotas that you want to allocate to the vCD cloud tenant accounts.

    NOTE: You must set the Resources or the vCDReplicationResource parameter, or a combination of both, to create a vCD cloud tenant account.

    NOTE: When you assign multiple resource quotas to one vCD cloud tenant account, the resource quotas must have unique Repository Friendly Names and they must use different repositories.

    Accepts the VBRCloudTenantResource type.

    False

    Named

    False

    False

    EnableThrottling

    Enables 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 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 that the vCD cloud tenant account 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

    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

    vCDReplicationResource

    Specifies vCD replication resources, that you want to allocate to the vCD cloud tenant accounts.

    Accepts the VBRvCDReplicationResource type.

    False

    Named

    False

    False

    GatewaySelectionType

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

    • StandaloneGateways - use this option to transfer data through a cloud gateway that is not added to a cloud gateway pool.
    • GatewayPool - use this option to transfer data through a cloud gateway pool.

    False

    Named

    False

    False

    GatewayPool

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

    Accepts the VBRCloudGatewayPool type.

    False

    Named

    False

    False

    EnableGatewayFailover

    Indicates that the gateway pool failover option is enabled. In case the gateway pool is down, Veeam Backup & Replication will transfer data through a 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

    Example

    This example shows how to create a vCD cloud tenant account with the replication resources.

    1. Run Find-VBRvCloudEntity with the Organization parameter to get the Organization vDC to which you want to connect the cloud tenant. Save the result to the $orgvcd variable.
    2. Run New-VBRvCDOrganizationvDCOptions with the $orgvcd variable to specify the Organization vDC that you want to allocate to the vCD cloud tenant. Save the result to the $dco variable.
    3. Run New-VBRvCDReplicationResource with the $dco variable to specify the replication resource settings. Save the result to the $replicares variable.
    4. Run Add-VBRvCDCloudTenant with the $org and the $replicas variables.

    $orgvcd = Find-VBRvCloudEntity -OrganizationVdc -Name "Organization 05"

    $dco = New-VBRvCDOrganizationvDCOptions -OrganizationvDC $orgvcd

    $replicas = New-VBRvCDReplicationResource -OrganizationvDCOptions $dco

    Add-VBRvCDCloudTenant -vCDOrganization $org -vCDReplicationResource  $replicas

    Related Commands

    Find-VBRvCloudEntity

    New-VBRvCDOrganizationvDCOptions

    New-VBRvCDReplicationResource