PowerCLI Reference



This cmdlet retrieves the accounts from the ESX/ESXi or vCenter Server.


Get-VIAccount [[-Id] <String[]>] [-Domain <String>] [-Group] [-Server <VIServer[]>] [-User] [<CommonParameters>]

Get-VIAccount [[-Name] <String[]>] [-Group] [-Server <VIServer[]>] [-User] [<CommonParameters>]

Related Commands

Online Version

Detailed Description

This cmdlet retrieves the accounts from the ESX/ESXi or vCenter Server. The Group and User switch parameters let you retrieve group and user accounts. By default, the cmdlet lists only user accounts. If the Domain parameter is specified, the cmdlet retrieves only the accounts on the specified AD domain. Otherwise, only local accounts are listed.


NameTypeDescriptionRequired?Pipeline InputDefault Value
IdString[]Specifies the IDs of the accounts you want to retrieve.

Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list.
NameString[]Specifies the names of the accounts you want to retrieve.falseFalse
DomainStringSpecifies AD domains to search for accounts.falseFalse
GroupSwitchParameterSpecifies that you want to retrieve only group accounts.falseFalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falseTrue (ByValue)
UserSwitchParameterSpecifies that you want to retrieve only user accounts.falseFalse

Return Type

Zero or more VIAccount objects



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

Get-VIAccount -Id Administrator

Retrieve accounts by Id.

-------------------------- Example 2 --------------------------

Get-VIAccount -Group

Retrieve all group accounts.

-------------------------- Example 3 --------------------------

Get-VIAccount -Id Administrator -Domain "MSDomain"

Get all VIAccounts for specified ID and Domain.

-------------------------- Example 4 --------------------------

Get-VIAccount -Domain "MSDomain"

Retrieve all accounts for the specified domain.

Copyright © VMware, Inc. All rights reserved.