PowerCLI Reference

Remove-VMHostAccount

Synopsis

This cmdlet removes the specified host accounts.

Syntax

Remove-VMHostAccount [-HostAccount] <HostAccount[]> [-Server <VIServer[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-VIAccount
New-VMHostAccount
Set-VMHostAccount

Detailed Description

This cmdlet removes the specified host accounts . These can be HostGroupAccount objects, HostUserAccount objects, or both.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
HostAccountHostAccount[]Specifies the host accounts 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
ServerVIServer[]Specifies the vCenter Server systems 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 Connect-VIServer.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

None

Notes

Examples

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

Get-VMHostAccount -Group -ID user | Remove-VMHostAccount -Confirm

Removes the group account with ID "user". Asks for confirmation before running the command.


Copyright © VMware, Inc. All rights reserved.