This is an archive version of the document. To get the most up-to-date information, see the current version.

Set-VBRCloudSubTenant

Short Description

Modifies settings of cloud subtenant accounts.

Applies to

Platform: VMware, Hyper-V

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

Syntax

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

Detailed Description

This cmdlet modifies settings for the cloud subtenant accounts of the following types:

Simple cloud tenant accounts
vCD cloud tenant accounts

To modify settings, you need to specify new values for the necessary parameters. The parameters that you omit will remain unchanged.

Set-VBRCloudSubTenant Note:

You cannot modify the following settings:

The cloud subuser name. After the subuser account is created, the name becomes a part of system information and cannot be changed.

For Agent Management subusers: user name and resources.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
SubTenant	Specifies the cloud subtenant you want to modify. Accepts the IVBRCloudSubTenant 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. NOTE: This parameter is available for the vCD cloud tenant accounts.	False	Named	False	False
HashedPassword	Indicates that you submit the hashed password. The hashed passwords are stored in the 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 the VBRCloudSubTenantResource type.	False	Named	False	False
PassThru	Indicates that the command returns the output object to the Windows PowerShell console.	False	Named	False	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

VBRCloudSubTenant

Example 1

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

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

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

Set-VBRCloudSubTenant -SubTenant $subtenant -Password "Pass12345"

Example 2

This example shows how to disable a selected cloud subtenant.

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

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

Set-VBRCloudSubTenant -SubTenant $subtenant -Disabled

Example 3

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

Run Get-VBRCloudSubtenant to get the cloud subtenant. Save the result to the $subtenant variable.
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.
Modify the cloud subtenant quota. Run Set-VBRCloudSubTenantResource with the $subtenantresources variable. Save the result to the $newresources.
Run Set-VBRCloudSubTenant to apply changes. Use the $subtenant and the $newresources variables.

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

$subtenantresources = $subtenant.Resources[0]

$newresources = Set-VBRCloudSubTenantResource -CloudSubTenantResource $subtenantresources -Quota 20

Set-VBRCloudSubTenant -SubTenant $subtenant -Resources $newresources

Related Commands

Get-VBRCloudSubTenant

Set-VBRCloudSubTenantResource