Syntax
Get-VMHost [[-Name] <String[]>] [-Datastore <StorageResource[]>] [-Location <VIContainer[]>] [-NoRecursion] [-Server <VIServer[]>] [-State <VMHostState[]>] [-Tag <Tag[]>] [<CommonParameters>]Related Commands
Online VersionDetailed Description
This cmdlet retrieves the hosts on a vCenter Server system. Returns a set of hosts that correspond to the filter criteria provided by the cmdlet parameters. To specify a server different from the default one, use the Server parameter. When working directly on an ESX host, the Name property of the returned VMHost object contains either the DNS name or the IP of the ESX host, depending on which of them was specified when connecting with Connect-VIServer.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String[] | Specifies the names of the hosts you want to retrieve. | false | False | |
| RelatedObject | VMHostRelatedObjectBase[] | Specifies objects to retrieve one or more VMHost objects that are related to them. This parameter accepts OMResource objects. | true | True (ByValue) | |
| Datastore | StorageResource[] | Specifies the datastores or datastore clusters to which the hosts that you want to retrieve are associated. Passing values to this parameter through a pipeline is deprecated and will be removed in a future release. | false | True (ByValue) | |
| DistributedSwitch | DistributedSwitch[] | Filters the available hosts by the virtual switches they are connected to. | false | True (ByValue) | |
| Id | String[] | Specifies the IDs of the hosts 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. | true | False | |
| Location | VIContainer[] | Specifies the vSphere container objects (such as folders, datacenters, and clusters) you want to search for hosts. | false | True (ByValue) | |
| NoRecursion | SwitchParameter | Indicates that you want to disable the recursive behavior of the command. | false | False | |
| ResourcePool | ResourcePool[] | Specifies resource pools associated with the hosts you want to retrieve. | false | False | |
| Server | VIServer[] | 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. | false | False | |
| State | VMHostState[] | Specifies the state of the hosts you want to retrieve. The valid values are Connected, Disconnected, NotResponding, and Maintenance. | false | False | |
| Tag | Tag[] | Returns only the virtual machine hosts that are associated with any of the specified tags. | false | False | |
| VM | VirtualMachine[] | Specifies virtual machines whose hosts you want to retrieve. | false | True (ByValue) |
Return Type
Zero or more VMHost objectsNotes
When working directly on an ESX host, the Name property of the returned VMHost object contains either the DNS name or the IP of the ESX host, depending on which of them was specified when connecting with Connect-VIServer.Examples
-------------------------- Example 1 --------------------------
Get-VMHost -Location MyDatacenter
Retrieves all hosts in the specified datacenter.
-------------------------- Example 2 --------------------------
$MyVM = Get-VM -Name MyVM Get-VMHost -VM $MyVM
Retrieves the host on which the specified virtual machine runs.
-------------------------- Example 3 --------------------------
$myVDSwitch = Get-VDSwitch -Name "MyVDSwitch" Get-VMHost -DistributedSwitch $myVDSwitch
Retrieves all hosts associated with the specified vSphere distributed switch.