vSphere PowerCLI Reference

Get-VMHostAccount

Synopsis

Retrieves the host accounts available on a vCenter Server system.

Syntax

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

Related Commands

Online version
Remove-VMHostAccount
New-VMHostAccount
Set-VMHostAccount

Detailed Description

Retrieves the host accounts available on a vCenter Server system. If both User and Group parameters are set to $true, in the list returned by the command, group accounts come out on top. If none of the User and Group switch parameters are provided, the cmdlet retrieves only the user accounts.
If the ID parameter is set, the cmdlet filters the host accounts by their IDs. To specify a server different from the default one, use the Server parameter.
Note: The specified server must be an ESX/ESXi host.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
IdString[]Specify the IDs of the host accounts you want to retrieve.falsefalse
GroupSwitchParameterIndicate that you want to retrieve only group host accounts. Starting with ESXi 5.1, this parameter is not supported.falsefalse
ServerVIServer[]Specifies a vCenter Server system to search for the specified vSphere .NET object. If no value is given to this parameter, the command runs on the server currently specified in the $DefaultVIServer variable.falsetrue (ByValue)
UserSwitchParameterIndicate that you want to retrieve only user host accounts.falsefalse

Return Type

HostAccount

Notes

Depending on what the user specified, the returned object can be of one of the child types: HostGroupAccount, HostUserAccount. Starting with ESXi 5.1, you cannot retrieve group host accounts.

Examples

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

Get-VMHostAccount -Group

Retrieves the group accounts for the default ESX/ESXi host. Starting with ESXi 5.1, you cannot retrieve group accounts.

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

$myServer1 = Connect-VIServer -Server 10.23.112.235
$myUserAccount1 = New-VMHostAccount -ID MyUser1 -Password MyPass1 -UserAccount
Get-VMHostAccount -Server $myServer1 -ID $myUserAccount1.Id -User

Retrieves a host account specified by an ID and an ESX/ESXi host.

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

$myServer1 = Connect-VIServer -Server 10.23.112.235
$myGroupAccount1 = New-VMHostAccount -ID MyGroup1 -Password MyPassword1 -GroupAccount
Get-VMHostAccount -Server $myServer1 -Id $myGroupAccount.Id -Group

Retrieves a group host account specified by an ID and an ESX/ESXi host. Starting with ESXi 5.1, you cannot retrieve group host accounts.

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

$myServer1 = Connect-VIServer 10.23.112.235
Get-VMHostAccount -Server $myServer1 -User -Group

Retrieves all user and group accounts on a specified ESX/ESXi host. Starting with ESXi 5.1, you cannot retrieve group host accounts.


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.