Get-VMHostAccount

This cmdlet 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.

Syntax

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

Parameters

Required Parameter Name Type Position Features Description
optional
Group
SwitchParameter named Indicates that you want to retrieve only group host accounts. Starting with ESXi 5.1, this parameter is not supported.
optional
Id
String[] named
  • wildcards
  • Specifies the IDs of the host accounts you want to retrieve.
    optional
    Server
    VIServer[] named
  • wildcards
  • pipeline
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.
    optional
    User
    SwitchParameter named Indicates that you want to retrieve only user host accounts.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Host.Account.HostAccount

    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.

    Related Commands

    Feedback

    Was this page helpful?