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

Set-VBRCloudSubUser

Short Description

Modifies settings of cloud subuser accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Set-VBRCloudSubUser -SubUser <IVBRCloudSubUser> [-Description <string>] [-Password <string>] [-Disabled] [-Resources <VBRCloudSubUserResource[]>] [-PassThru] [<CommonParameters>]

Detailed Description

This cmdlet modifies settings for the subuser tenant account. You can modify the cloud subuser accounts of the following types:

Simple cloud subtenant accounts
vCD cloud subtenant accounts

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

Set-VBRCloudSubUser 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: username and resources.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
SubUser	Specifies the cloud subuser you want to modify. Accepts the VBRCloudSubUser type.	True	Named	True (ByValue)	False
Description	Specifies the description of the cloud subuser account.	False	Named	False	False
Password	Specifies the password you want to set to the subuser account.	False	Named	False	False
Disabled	Indicates if the cloud subuser is disabled.	False	Named	False	False
Resources	Specifies the quota of the subuser backup resources you want to give to the subuser. Accepts the VBRCloudSubUserResource 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

IVBRCloudSubUser

Example 1

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

Run Get-VBRCloudSubUser to get the cloud subuser. Save the result to the $subuser variable.
Run Set-VBRCloudSubUser. Use the $subuser variable.

$subuser = Get-VBRCloudSubUser -Name "Subuser 1"

Set-VBRCloudSubUser -SubUser $subuser -Password "Pass12345"

Example 2

This example shows how to disable a selected cloud subuser.

Run Get-VBRCloudSubUser to get the cloud subuser.
Run Set-VBRCloudSubUser. Use the $subuser variable.

$subuser = Get-VBRCloudSubUser -Name "Subuser 1"

Set-VBRCloudSubUser -SubUser $subuser -Disabled

Example 3

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

Run Get-VBRCloudSubUser to get the cloud subuser. Save the result to the $subuser variable.
Get the existing quota of the subuser. Use the Resources property of the VBRCloudSubUserResource object saved to the $subuser variable. Save the result to the $subuserresources variable.
Modify the cloud subuser quota. Run Set-VBRCloudSubUserResource with the $subuserresources variable. Save the result to the $newresources.
Run Set-VBRCloudSubUser with the $subuser and the $subuserresources variables.

$subuser = Get-VBRCloudSubUser -Name "Subuser 1"

$subuserresources = $subuser.Resources[0]

$newresources = Set-VBRCloudSubUserResource -CloudSubUserResource $subuserresources -Quota 20

Set-VBRCloudSubUser -SubUser $subuser -Resources $newresources

Related Commands

Get-VBRCloudSubUser