.png)
Get-VM
Published: August 15, 2012
Updated: February 6, 2013
Applies To: Windows Server 2012
Get-VM
Syntax
Parameter Set: Name Get-VM [[-Name] <String[]> ] [-ComputerName <String[]> ] [ <CommonParameters>] Parameter Set: ClusterObject Get-VM [-ClusterObject] <PSObject> [ <CommonParameters>] Parameter Set: Id Get-VM [[-Id] <Guid> ] [-ComputerName <String[]> ] [ <CommonParameters>]
Detailed Description
The Get-VM cmdlet gets the virtual machines from one or more Hyper-V hosts.
Parameters
-ClusterObject<PSObject>
Specifies the cluster resource or cluster group of the virtual machine to be retrieved.
|
Aliases |
none |
|
Required? |
true |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
false |
-ComputerName<String[]>
Specifies one or more Hyper-V hosts from which virtual machines are to be retrieved. NetBIOS names, IP addresses, and fully-qualified domain names are allowable. The default is the local computer — use “localhost” or a dot (“.”) to specify the local computer explicitly.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
named |
|
Default Value |
. |
|
Accept Pipeline Input? |
false |
|
Accept Wildcard Characters? |
false |
-Id<Guid>
Specifies the identifier of the virtual machine to be retrieved.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByPropertyName, ByValue) |
|
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies the name of the virtual machine to be retrieved.
|
Aliases |
none |
|
Required? |
false |
|
Position? |
1 |
|
Default Value |
none |
|
Accept Pipeline Input? |
true (ByValue) |
|
Accept Wildcard Characters? |
true |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Virtualization.Powershell.VirtualMachine
Examples
Example 1
Example 2
This example gets all virtual machines on Hyper-V host Server1 that are running.
PS C:\> Get-VM –ComputerName Server1 | Where-Object {$_.State –eq ‘Running’}
Example 3
This example gets all virtual machines in the cluster to which the local Hyper-V host is joined.
PS C:\> Get-ClusterGroup | ? {$_.GroupType –eq ‘VirtualMachine’ } | Get-VM
