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

Set-VBRCloudTenant

Short Description

Modifies settings for simple cloud tenant accounts.

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] [-Force]
[-ReplicationResources<VBRCloudTenantReplicationResources>] [-EnableThrottling] [-ThrottlingValue <decimal>] [-ThrottlingUnit <VBRSpeedUnit> {MbitPerSec | MbytePerSec | KbytePerSec}] [-MaxConcurrentTask <int>] [-PassThru][-EnableBackupProtection] [-BackupProtectionPeriod <int>] [-GatewaySelectionType <VBRCloudGatewaySelectionType> {StandaloneGateways | GatewayPool}] [-GatewayPool <VBRCloudGatewayPool[]>] [-EnableGatewayFailover] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings for simple cloud tenant accounts. 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

Cloud
Tenant

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

Accepts the VBRCloudTenant type.

True

Named

True (ByValue,
ByProperty
Name)

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

Note: this parameter does not work for vCD cloud tenant accounts.

False

Named

False

False

Description

Specifies the description of the simple cloud tenant account.

False

Named

False

False

Enable
Lease
Expiration

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

Lease
Expiration
Date

For EnableLeaseExpiration parameter.

Specifies the lease expiration date.

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

Hashed
Password

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

False

Named

False

False

Enable
Resources

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

False

Named

False

False

Enable
Replication
Resorces

Enables the replication resources options for the simple cloud tenant account.

False

Named

False

False

Force

Indicates that the cmdlet will modify 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

Enable
Throttling

Enables the network throttling to set the bandwidth limitations.

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

False

Named

False

False

Throttling
Value

For the EnableThrottling option.

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

False

Named

False

False

Throttling
Unit

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

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

Enable
BackupProtection

Indicates that tenant's backups must be protected 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 time period specified by the BackupProtectionPeriod parameter. When this period ends, the backups are removed from the cloud repository.

False

Named

False

False

BackupProtection
Period

Used to set the time period for the EnableBackupProtection parameter.

Can be set to 1-99 days.

False

Named

False

False

PassThru

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

False

Named

False

False

GatewaySelectionType

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

  • 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 gateways, added to one 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 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.

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

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.

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

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.

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

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.

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

$resources = $tenant.resources[0]

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

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 Agent Management Guide

Veeam Explorers User Guide

Backup and Restore of SQL Server Databases

Veeam Plug-ins for Enterprise Applications

PowerShell Reference

Veeam Explorers PowerShell Reference

RESTful API Reference

Required Permissions

Veeam Availability for Nutanix AHV

Veeam Backup for Microsoft Office 365 Documentation

Veeam ONE Documentation

Veeam Agent for Windows Documentation

Veeam Agent for Linux Documentation

Veeam Management Pack Documentation