PowerCLI Reference

Remove-VcsUser

Synopsis

This cmdlet removes a user from the VMware Cloud Services Platform.

Syntax

Remove-VcsUser [-User] <IVcsUser[]> [-Confirm] [-Server <CisServer[]>] [-WhatIf] [<CommonParameters>]

Related Commands

Detailed Description

This cmdlet removes a user from the VMware Cloud Services Platform.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
UserIVcsUser[]Specifies the user that you want to remove.trueTrue (ByValue)
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falseFalse
ServerCisServer[]Specifies the VMware Cloud Services Platform servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-Vcs cmdlet.falseFalse
WhatIfSwitchParameterIndicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falseFalse

Return Type

System.Object

Notes

Examples

-------------------------- Example 1 --------------------------

Remove-VcsUser -User $USER

Removes the specified $USER user from the VMware Cloud Services Platform.


Copyright © VMware, Inc. All rights reserved.