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

Set-VBRCloudTenant

Short Description

Modifies cloud tenant account settings.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Requires a cloud provider license.

Syntax

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

Detailed Description

This cmdlet modifies tenant account settings.

To modify settings, you need to enter the corresponding parameters with new values. The parameters that you omit will remain unchanged.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

CloudTenant

Specifies the tenant account you want to modify.

Accepts VBRCloudTenant type.

True

Named

True (by Value
FromPipeline, ValueFromPipeline
ByPropertyName)

False

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 [.].

False

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

Password

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

False

Named

False

False

Resources

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

Accepts 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

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 or to edit objects returned by Get-VBRCloudTenant.

False

Named

False

False

Enable
Resources

If set to TRUE, the pre-configured tenant backup resources will be enabled.

False

Named

False

False

Enable
Replication
Resorces

If set to TRUE, the pre-configured tenant account replication resources will be enabled.

False

Named

False

False

Enable
Throttling

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

Use the ThrottlingValue parameter 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 (Mbps).

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

Replication
Resources

Specifies the replication resources settings for the created tenant account.

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

Accepts VBRCloudTenantReplicationResources type.

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

PassThru

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

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 example shows how to add the replication resources to a tenant.

  1. Pre-configure replication resources. For details, see New-VBRCloudTenantReplicationResources. Save the result to the '$replicationresources' variable.
  2. Run Get-VBRCloudTenant to get the tenant you want to modify. Save it to the $tenant variable.
  3. Run Set-VBRCloudTenant with the $tenant variable. Use the '$replicationresources' variable to assign the replication resources to the tenant.

PS C:\PS> $tenant = Get-VBRCloudTenant -Name "ABC Company"

PS C:\PS> Set-VBRCloudTenant -CloudTenant $tenant -ReplicationResources $replicationresources

Example 2

This example shows how to set a new password to a tenant.

  1. Run Get-VBRCloudTenant to get the tenant you want to modify. Save it to the $tenant variable.
  2. Run Set-VBRCloudTenant with the $tenant variable. Specify the new password.

PS C:\PS> $tenant = Get-VBRCloudTenant -Name "ABC Company"

PS C:\PS> Set-VBRCloudTenant -CloudTenant $tenant -Password "Pass456"

Example 3

This example shows how to disable lease expiration settings for the ABC company.

  1. Run Get-VBRCloudTenant to get the tenant you want to modify. Save it to the $tenant variable.
  2. Run Set-VBRCloudTenant with the $tenant variable. Disable the lease expiration period.

PS C:\PS> $tenant = Get-VBRCloudTenant -Name "ABC Company"

PS C:\PS> Set-VBRCloudTenant -CloudTenant $tenant -EnableLeaseExpiration: $false

Example 4

This example shows how to change the backup repository quota 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 quotas assigned to the tenant. Select the first quota from the list. Save the result to the $resources variable.
  3. Run Set-VBRCloudTenantResource with the $resources variable. Set the new quota value. Save the new resources to the $newquota variable.
  4. Run Set-VBRCloudTenant with the $tenant variable. Use the $newquota to set the new quota.

PS C:\PS> $tenant = Get-VBRCloudTenant -Name "ABC Company"

PS C:\PS> $resources = $tenant.resources[0]

PS C:\PS> $newquota = Set-VBRCloudTenantResource -CloudTenantResource $resources -Quota 20

PS C:\PS> Set-VBRCloudTenant -CloudTenant $tenant -Resources $newquota

Related Commands

Get-VBRCloudTenant

New-VBRCloudTenantResource

New-VBRCloudTenantReplicationResources

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