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

Set-VBRCloudSubTenant

Short Description

Modifies settings of cloud subtenant accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRCloudSubTenant -SubTenant <VBRCloudSubTenant> [-Description <string>] [-Password <string>] [-HashedPassword] [-Disabled] [-Resources <VBRCloudSubTenantResource[]>] [-PassThru] [<CommonParameters>]

Detailed Description

This cmdlet modifies the settings of a cloud subtenant account.

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

Set-VBRCloudSubTenant Note:

You cannot modify the subtenant name. After the subtenant account is created, the name becomes a part of system information and cannot be changed.

Parameters

Parameter

Description

Required

Position

Accept
Pipeline
Input

Accept
Wildcard
Characters

SubTenant

Specifies the cloud subtenant you want to modify.

Accepts VBRCloudSubTenant type.

True

Named

True (ByValue,
ByProperty
Name)

False

Description

Specifies the description of the cloud subtenant account.

False

Named

False

False

Password

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

False

Named

False

False

HashedPassword

Indicates that you submit the hashed password. The hashed passwords are stored in Veeam backup database.

Use this parameter, for example, to restore subtenant accounts.

False

Named

False

False

Disabled

Indicates if the cloud subtenant is disabled.

False

Named

False

False

Resources

Specifies the quota of the subtenant backup resources you want to give to the subtenant.

Accepts VBRCloudSubTenantResource type.

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

VBRCloudSubTenant

Example 1

This example shows how to modify the password for a selected cloud subtenant.

  1. Run Get-VBRCloudSubtenant to get the cloud subtenant. Save the result to the $subtenant variable.
  2. Run Set-VBRCloudSubTenant. Use the $SubTenant variable.

PS C:\PS> $subtenant = Get-VBRCloudSubTenant -Name "Alpha"

PS C:\PS> Set-VBRCloudSubTenant -SubTenant $subtenant -Password "Pass12345"

Example 2

This example shows how to disable a selected cloud subtenant.

  1. Run  Get-VBRCloudSubtenant to get the cloud subtenant.
  2. Run Set-VBRCloudSubTenant. Use the $subtenant variable.

PS C:\PS> $subtenant = Get-VBRCloudSubTenant -Name "Alpha"

PS C:\PS> Set-VBRCloudSubTenant -SubTenant $subtenant -Disabled

Example 3

This example shows how to modify the quota of resources for a selected cloud subtenant.

  1. Run Get-VBRCloudSubtenant to get the cloud subtenant. Save the result to the $subtenant variable.
  2. Get the existing quota of the subtenant. Use the Resources property of the VBRCloudSubTenantResource object saved to the $subtenant variable. Save the result to the $subtenantresources variable.
  3. Modify the cloud subtenant quota. Run Set-VBRCloudSubTenantResource with the $subtenantresources variable. Save the result to the $newresources.
  4. Run Set-VBRCloudSubTenant to apply changes. Use the $subtenant and the $newresources variables.

PS C:\PS> $subtenant = Get-VBRCloudSubTenant -Name "Alpha"

PS C:\PS> $subtenantresources = $subtenant.Resources[0]

PS C:\PS> $newresources = Set-VBRCloudSubTenantResource -CloudSubTenantResource $subtenantresources -Quota 20

PS C:\PS> Set-VBRCloudSubTenant -SubTenant $subtenant -Resources $newresources

Related Commands

Get-VBRCloudSubTenant

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