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
Cloud Director tenant accounts

Set-VBRCloudSubTenant Note:

To modify settings, specify new values for the necessary parameters. The cmdlet will overwrite the previous parameters values with new values. The parameters that you omit will remain unchanged.

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	Type	Required	Position	Accept Pipeline Input
SubTenant	Specifies the cloud subtenant you want to modify.	Accepts the IVBRCloudSubTenant object. To get this object, run the Get-VBRCloudSubtenant cmdlet.	True	Named	True (ByValue, ByProperty Name)
Description	Specifies the description of the cloud subtenant account.	String	False	Named	False
Password	Specifies the password you want to set to the subtenant account. Note: This parameter is available for the Cloud Director tenant accounts.	String	False	Named	False
HashedPassword	Defines 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.	SwitchParameter	False	Named	False
Disabled	Defines if the cloud subtenant is disabled.	SwitchParameter	False	Named	False
Resources	Specifies the quota of the subtenant backup resources you want to give to the subtenant.	Accepts the VBRCloudSubTenantResource[] object. To get this object, run the Set-VBRCloudSubTenantResource cmdlet.	False	Named	False
PassThru	Defines that the command returns the output object to the Windows PowerShell console.	SwitchParameter	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRCloudSubTenant

Examples

Set-VBRCloudSubTenant Example 1. Changing Password for Selected Cloud Subtenant

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

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

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

Perform the following steps:

Run the Get-VBRCloudSubtenant cmdlet. Specify the Name parameter value. Save the result to the $subtenant variable.
Run the Set-VBRCloudSubTenant cmdlet. Set the $subtenant variable as the SubTenant parameter value. Specify the Password parameter value.

Set-VBRCloudSubTenant Example 2. Disabling Selected Cloud Subtenant

This example shows how to disable a selected cloud subtenant.

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

Set-VBRCloudSubTenant -SubTenant $subtenant -Disabled

Perform the following steps:

Run the Get-VBRCloudSubtenant cmdlet. Specify the Name parameter value. Save the result to the $subtenant variable.
Run the Set-VBRCloudSubTenant cmdlet. Set the $subtenant variable as the SubTenant parameter value. Provide the Disabled parameter.

Set-VBRCloudSubTenant Example 3. Modifying Resource Quota for Selected Cloud Subtenant

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

$subtenant = Get-VBRCloudSubTenant -Name "Alpha"

$subtenantresources = $subtenant.Resources[0]

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

Set-VBRCloudSubTenant -SubTenant $subtenant -Resources $newresources

Perform the following steps:

Run the Get-VBRCloudSubtenant cmdlet. Specify the Name parameter value. 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.
Run the Set-VBRCloudSubTenantResource cmdlet. Set the $subtenantresources variable as the CloudSubTenantResource parameter value. Specify the Quota parameter value. Save the result to the $newresources variable.
Run the Set-VBRCloudSubTenant cmdlet to apply changes. Set the $subtenant variable as the SubTenant parameter value. Set the $newresources variable as the Resources parameter value.

Related Commands