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

Get-VMHostAccount

[-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. 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.
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

VMHost

Get-VMHost

This cmdlet retrieves the hosts on a vCenter Server system.

Add-VMHost

This cmdlet adds a host to be managed by a vCenter Server system.

Move-VMHost

This cmdlet moves hosts to another location.

Restart-VMHost

This cmdlet restarts the specified hosts.

Set-VMHost

This cmdlet modifies the configuration of the host.

Start-VMHost

This cmdlet starts the specified hosts.

Stop-VMHost

This cmdlet powers off the specified hosts.

Suspend-VMHost

This cmdlet suspends hosts.

Remove-VMHost

This cmdlet removes the specified hosts from the inventory.

VMHostAccount

Get-VMHostAccount

This cmdlet retrieves the host accounts available on a vCenter Server system.

Set-VMHostAccount

This cmdlet configures a host account.

Remove-VMHostAccount

This cmdlet removes the specified host accounts.

New-VMHostAccount

This cmdlet creates a new host user or group account.

VMHostAdvancedConfiguration

Get-VMHostAdvancedConfiguration

This cmdlet retrieves the advanced configuration of the hosts.

Set-VMHostAdvancedConfiguration

This cmdlet modifies the advanced configuration settings of a host.

VMHostAuthentication

Get-VMHostAuthentication

This cmdlet retrieves authentication information for the specified hosts.

Set-VMHostAuthentication

This cmdlet modifies the host authentication information.

VMHostAvailableTimeZone

Get-VMHostAvailableTimeZone

This cmdlet retrieves the time zones available on the specified host.

VMHostDiagnosticPartition

Get-VMHostDiagnosticPartition

This cmdlet retrieves a list of the diagnostic partitions on the specified hosts.

Set-VMHostDiagnosticPartition

This cmdlet activates or deactivates the diagnostic partitions of hosts.

VMHostDisk

Get-VMHostDisk

This cmdlet retrieves information about the specified SCSI LUN disk.

VMHostDiskPartition

Get-VMHostDiskPartition

This cmdlet retrieves the partitions of a host disk (LUN).

Format-VMHostDiskPartition

This cmdlet formats a new VMFS (Virtual Machine File System) on each of the specified host disk partitions.

VMHostFirewallDefaultPolicy

Get-VMHostFirewallDefaultPolicy

This cmdlet retrieves the firewall default policy of the specified hosts.

Set-VMHostFirewallDefaultPolicy

This cmdlet sets the default policy for the specified host firewall.

VMHostFirewallException

Get-VMHostFirewallException

This cmdlet retrieves the exceptions from the firewall policy on the specified hosts.

Set-VMHostFirewallException

This cmdlet activates or deactivates host firewall exceptions.

VMHostFirmware

Get-VMHostFirmware

This cmdlet retrieves hosts firmware information.

Set-VMHostFirmware

This cmdlet configures hosts firmware settings.

VMHostHardware

Get-VMHostHardware

This cmdlet retrieves ESXi host hardware and firmware information.

VMHostHba

Get-VMHostHba

This cmdlet retrieves information about the available HBAs (Host Bus Adapter).

Set-VMHostHba

This cmdlet configures the CHAP properties of the specified iSCSI HBAs.

VMHostModule

Get-VMHostModule

This cmdlet retrieves the option strings of the specified host modules.

Set-VMHostModule

This cmdlet overrides the host module options with the given ones.

VMHostNetwork

Get-VMHostNetwork

THis cmdlet retrieves the host networks on a vCenter Server system.

Set-VMHostNetwork

This cmdlet updates the specified virtual network.

VMHostNetworkAdapter

Get-VMHostNetworkAdapter

This cmdlet retrieves the host network adapters on a vCenter Server system.

Set-VMHostNetworkAdapter

This cmdlet configures the specified host network adapter.

Remove-VMHostNetworkAdapter

This cmdlet removes the specified host network adapters.

New-VMHostNetworkAdapter

This cmdlet creates a new HostVirtualNIC (Service Console or VMKernel) on the specified host.

VMHostNetworkStack

Get-VMHostNetworkStack

This cmdlet retrieves the host network stacks on a vCenter Server system.

Set-VMHostNetworkStack

This cmdlet modifies the specified host network stack.

VMHostNtpServer

Get-VMHostNtpServer

This cmdlet retrieves the NTP servers on the specified hosts.

Add-VMHostNtpServer

This cmdlet adds the specified NTP servers to the NTP server list of the specified hosts.

Remove-VMHostNtpServer

This cmdlet removes the specified NTP servers from the NTP server list of the specified hosts.

VMHostPatch

Get-VMHostPatch

This cmdlet retrieves information about the host patches installed on the specified hosts. This cmdlet is deprecated and will not return any results for ESX hosts version 5.0 and later. Use (Get-ESXCli).software.vib.list() as an alternative.

Install-VMHostPatch

This cmdlet updates the specified hosts.

VMHostPciDevice

Get-VMHostPciDevice

This cmdlet retrieves the PCI devices on the specified hosts.

VMHostProfile

Get-VMHostProfile

This cmdlet retrieves the available host profiles.

Export-VMHostProfile

This cmdlet exports the specified host profile to a file.

Import-VMHostProfile

This cmdlet imports a host profile from a file. The file path must be accessible from the VMware PowerCLI client side.

Invoke-VMHostProfile

This cmdlet applies a host profile to the specified host or cluster.

Set-VMHostProfile

This cmdlet modifies the specified host profile.

Remove-VMHostProfile

This cmdlet removes the specified host profiles.

New-VMHostProfile

This cmdlet creates a new host profile based on a reference host.

VMHostProfileCompliance

Test-VMHostProfileCompliance

This cmdlet tests hosts for profile compliance.

VMHostProfileImageCacheConfiguration

Get-VMHostProfileImageCacheConfiguration

Retrieves an image cache configuration for the given host profile.

Set-VMHostProfileImageCacheConfiguration

This cmdlet modifies image cache configuration for given host profile.

VMHostProfileRequiredInput

Get-VMHostProfileRequiredInput

This cmdlet performs a check whether the available information is sufficient to apply a host profile.

VMHostProfileStorageDeviceConfiguration

Get-VMHostProfileStorageDeviceConfiguration

Retrieves the storage device configuration for the given host profile.

Set-VMHostProfileStorageDeviceConfiguration

This cmdlet modifies the storage device configuration for the given host profile.

VMHostProfileUserConfiguration

Get-VMHostProfileUserConfiguration

This cmdlet retrieves the user password configuration for the given host profile.

Set-VMHostProfileUserConfiguration

This cmdlet modifies the user password configuration for the specified account within a host profile.

VMHostProfileVmPortGroupConfiguration

Get-VMHostProfileVmPortGroupConfiguration

Retrieves the virtual machine port group configuration for the given host profile.

Set-VMHostProfileVmPortGroupConfiguration

This cmdlet modifies the virtual machine port group configuration for the given host profile.

Remove-VMHostProfileVmPortGroupConfiguration

Removes the given virtual machine port group configuration from the host profile.

New-VMHostProfileVmPortGroupConfiguration

This cmdlet creates a new virtual machine port group configuration.

VMHostRoute

Get-VMHostRoute

This cmdlet retrieves the routes from the routing table of the specified hosts.

Set-VMHostRoute

This cmdlet modifies a route in the host routing table.

Remove-VMHostRoute

This cmdlet removes host routes.

New-VMHostRoute

This cmdlet creates a new route in the routing table of a host.

VMHostService

Get-VMHostService

This cmdlet retrieves information about a host service.

Restart-VMHostService

This cmdlet restarts the specified host services.

Set-VMHostService

This cmdlet modifies a host service.

Start-VMHostService

This cmdlet starts the specified host services.

Stop-VMHostService

This cmdlet stops the specified host services.

VMHostSnmp

Get-VMHostSnmp

This cmdlet retrieves hosts SNMP configuration.

Set-VMHostSnmp

This cmdlet modifies the host SNMP configuration.

Test-VMHostSnmp

This cmdlet tests the host SNMP.

VMHostStartPolicy

Get-VMHostStartPolicy

This cmdlet retrieves the start policy of hosts.

Set-VMHostStartPolicy

This cmdlet modifies the host default start policy.

VMHostStorage

Get-VMHostStorage

This cmdlet retrieves the host storages on a vCenter Server system.

Set-VMHostStorage

This cmdlet configures a host storage.

VMHostSysLogServer

Get-VMHostSysLogServer

This cmdlet displays the remote syslog servers of the specified hosts.

Set-VMHostSysLogServer

This cmdlet configures the remote syslog server of the specified hosts.

Get-VMHostAccount

Syntax

Parameters

Output

Examples

Example 1

Example 2

Example 3

Example 4

Related Commands

VMHost

VMHostAccount

VMHostAdvancedConfiguration

VMHostAuthentication

VMHostAvailableTimeZone

VMHostDiagnosticPartition

VMHostDisk

VMHostDiskPartition

VMHostFirewallDefaultPolicy

VMHostFirewallException

VMHostFirmware

VMHostHardware

VMHostHba

VMHostModule

VMHostNetwork

VMHostNetworkAdapter

VMHostNetworkStack

VMHostNtpServer

VMHostPatch

VMHostPciDevice

VMHostProfile

VMHostProfileCompliance

VMHostProfileImageCacheConfiguration

VMHostProfileRequiredInput

VMHostProfileStorageDeviceConfiguration

VMHostProfileUserConfiguration

VMHostProfileVmPortGroupConfiguration

VMHostRoute

VMHostService

VMHostSnmp

VMHostStartPolicy

VMHostStorage

VMHostSysLogServer

Was this page helpful?