Set-VBRCloudTenantResource

In this article

    Short Description

    Modifies tenants backup resources settings.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Set-VBRCloudTenantResource -CloudTenantResource <VBRCloudTenantResource> [-Repository <CBackupRepository>] [-RepositoryFriendlyName <string>] [-Quota <int>] [-EnableWanAccelerator] [-WanAccelerator <CWanAccelerator>] [<CommonParameters>]

    Detailed Description

    This cmdlet modifies the VBRCloudTenantResource object containing the backup resources for a tenant. 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

    CloudTenantResource

    Specifies the cloud account tenant quota settings you want to modify.

    Accepts VBRCloudTenantResource type.

    True

    Named

    False

    False

    Repository

    Specifies the backup repository in your backup infrastructure you want to expose to the tenant.

    You can specify simple or scale-out backup repositories.

    You cannot specify cloud repositories or individual scale-out repositories extents.

    True

    Named

    False

    False

    RepositoryFriendlyName

    Specifies a name for the cloud repository you want to present to the tenant. The name you enter will be displayed in the list of backup repositories at tenant’s side.

    True

    Named

    False

    False

    Quota

    Specifies the amount of space you want to allocate to the tenant on the selected backup repository.

    Permitted value: 1 to 2097151  (GB).

    True

    Named

    False

    False

    EnableWanAccelerator

    Indicates that the backup jobs can use WAN accelerators for transferring data to cloud repositories.

    Use the WanAccelerator parameter to set the WAN accelerator.

    False

    Named

    False

    False

    WanAccelerator

    Specifies the WAN accelerator for the EnableWanAccelerator parameter.

    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

    VBRCloudTenantResource

    Example 1

    This example shows how to change the backup repository quota of a tenant.

    1. Run Get-VBRCloudTenant to get the tenant you want to modify. Save it to the $tenant variable.
    2. Get the array of quotas assigned to the tenant. Select the first quota from the list. Save the result to the $resources variable.
    3. Run Set-VBRCloudTenant with the $resources variable. Set the new quota value. Save the new resources to the $newquota variable.
    4. Run Set-VBRCloudTenant to apply the new resources to the tenant. Use the $tenant and $newquota variables.

    $tenant = Get-VBRCloudTenant -Name "ABC Company"

    $resources = $tenant.resources[0]

    $newquota = Set-VBRCloudTenantResource -CloudTenantResource $resources -Quota 20

    Set-VBRCloudTenant -CloudTenant $tenant -Resource $newquota

    Example 2

    This example shows how to enable WAN acceleration for a tenant.

    1. Run Get-VBRCloudTenant to get the tenant you want to modify. Save it to the $tenant variable.
    2. Get the array of resources assigned to the tenant. Select the first item from the list. Save the result to the $resources variable.
    3. Run Get-VBRWANAccelerator to get the WAN accelerator. Save it to the $wan variable.
    4. Run Set-VBRCloudTenantResource with the $resources variable. Enable the WAN acceleration and specify the WAN accelerator. Save the new resources to the $newresources variable.
    5. Run Set-VBRCloudTenant to apply the new resources to the tenant. Use the $tenant and $newresources variables.

    $tenant = Get-VBRCloudTenant -Name "ABC Company"

    $resources = $tenant.resources[0]

    $wan = Get-VBRWANAccelerator -Name "Columbus WAN"

    $newresources = Set-VBRCloudTenantResource -CloudTenantResource $resources -EnableWanAccelerator -WanAccelerator $wan

    Set-VBRCloudTenant -CloudTenant $tenant -Resource $newresources

    Related Commands

    Get-VBRBackupRepository

    Get-VBRWANAccelerator

    Set-VBRCloudTenant