Set-VBRvCDCloudTenant

In this article

    Short Description

    Modifies vCD cloud tenant accounts.

    Applies to

    Platform: VMware

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

    Syntax

    Set-VBRvCDCloudTenant -vCDCloudTenant <VBRvCDCloudTenant> [-GatewaySelectionType <VBRCloudGatewaySelectionType>] [-vCDReplicationResource <VBRvCDReplicationResource>] [-EnablevCDReplicationResources [<SwitchParameter>]] [-BackupProtectionPeriod <Int32>] [-EnableBackupProtection [<SwitchParameter>]] [-PassThru [<SwitchParameter>]] [-MaxConcurrentTask <Int32>] [-GatewayPool <VBRCloudGatewayPool[]>] [-ThrottlingUnit <VBRSpeedUnit>] [-EnableThrottling [<SwitchParameter>]] [-Force [<SwitchParameter>]] [-EnableResources [<SwitchParameter>]] [-Resources <VBRCloudTenantResource[]>] [-LeaseExpirationDate <DateTime>] [-EnableLeaseExpiration [<SwitchParameter>]] [-Description <String>] [-ThrottlingValue <Decimal>] [-EnableGatewayFailover [<SwitchParameter>]] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies vCD cloud tenant account settings. To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    vCDCloudTenant

    Specifies the vCD cloud tenant account that you want to modify.

    Accepts the VBRvCDCloudTenant type.

    True

    Named

    True (ByValue,
    ByPropertyName)

    False

    Description

    Specifies the description of the vCD cloud tenant account.

    False

    Named

    False

    False

    EnableLeaseExpiration

    Indicates that the 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 parameter.

    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 account.

    Accepts the VBRCloudTenantResource type.

    Note: When you assign multiple backup 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

    EnableResources

    Enables the backup resources option for the vCD cloud tenant account.

    False

    Named

    False

    False

    Force

    Indicates that the cmdlet will modify vCD cloud tenant accounts even if the geographical location of the repositories where VM backups reside and the target repository location do not match.

    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 the measure units for the bandwidth value. You can select either of the following:

    • MbitPerSec
    • MbytePerSec
    • KbytePerSec

    False

    Named

    False

    False

    MaxConcurrentTask

    Specifies the maximum number of tasks that the vCD cloud tenant accounts 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

    PassThru

    Indicates that the command returns the output object to the Windows PowerShell console.

    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 vCD cloud 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 gateway that 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 a gateway pool. Veeam Backup & Replication will route the 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 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

    VBRvCDCloudTenant

    Example

    This example shows how to modify a vCD cloud tenant account. The cmdlet enables the following options:

    • Route the data through a cloud gateway pool
    • Enable network throttling
    • The maximum bandwidth value is set to 50 Mbps

    You must perform the following steps:

    1. Run Get-VBRCloudTenant to get the tenant. Save the result to the $tenant variable.
    2. Run Get-VBRCloudGatewayPool to get the gateway pool. Save the result to the $pool variable.
    3. Run Set-VBRvCDCloudTenant with the $tenant and $pool variables. Use the ThrottlingValue to specify the value and the ThrottlingUnit to specify the measure unit for the bandwidth settings.

    $tenant = Get-VBRCloudTenant -Name vCDTenant

    $pool= Get-VBRCloudGatewayPool

    Set-VBRvCDCloudTenant -vCDCloudTenant $tenant -GatewaySelectionType GatewayPool -GatewayPool $pool -EnableThrottling -ThrottlingValue 90 -ThrottlingUnit MbitPerSec

    Related Commands

    Get-VBRCloudTenant

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.