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

Disable-VBRCloudSubUser

Short Description

Disables cloud subuser accounts.

Applies to

Platform: VMware, Hyper-V

Product Edition: Standard, Enterprise, Enterprise Plus

Syntax

Disable-VBRCloudSubUser -SubUser <IVBRCloudSubUser[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Detailed Description

This cmdlet disables a cloud subuser account. When you disable a subuser account, the subuser cannot use their account resources.

You can disable the cloud subtenant accounts of the following types:

Simple cloud tenant accounts
vCD Cloud tenant accounts

Run Enable-VBRCloudSubUser to enable a disabled account.

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input	Accept Wildcard Characters
SubUser	Specifies the array of cloud subusers you want to disable. The subusers can have different parents. Accepts the IVBRCloudSubUser type.	True	Named	True (ByValue, ByProperty Name)	False
WhatIf	Specifies whether the cmdlet writes a message that describes the effects of running the cmdlet without actually performing any action.	False	Named	False	False
Confirm	Specifies whether the cmdlet displays a prompt that asks if the user is sure that they want to continue.	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

None

Example

This example shows how to disable a cloud subuser.

Run Get-VBRCloudSubUser to get the subuser. Save the result to the $subuser variable.
Run Disable-VBRCloudSubUser with the saved variable.

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

Disable-VBRCloudSubUser -SubUser $subuser

Related Commands

Get-VBRCloudSubUser