Get-VM

Module:

Hyper-V

Gets the virtual machines from one or more Hyper-V hosts.

Syntax

PowerShell

Get-VM
   [[-Name] <String[]>]
   [-ComputerName <String[]>]

PowerShell

Get-VM
   [-ClusterObject] <PSObject>

PowerShell

Get-VM
   [[-Id] <Guid>]
   [-ComputerName <String[]>]

Description

The Get-VM cmdlet gets the virtual machines from one or more Hyper-V hosts.

Examples

Example 1

PowerShell

PS C:\>Get-VM

This example gets all virtual machines on the local virtual machine host.

Example 2

PowerShell

PS C:\>Get-VM -ComputerName Server1 | Where-Object {$_.State -eq 'Running'}

This example gets all virtual machines on Hyper-V host Server1 that are running.

Example 3

PowerShell

PS C:\>Get-ClusterGroup | ? {$_.GroupType -eq 'VirtualMachine' } | Get-VM

This example gets all virtual machines in the cluster to which the local Hyper-V host is joined.

Parameters

-ClusterObject

Specifies the cluster resource or cluster group of the virtual machine to be retrieved.

Type:	PSObject
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ComputerName

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.

Type:	String[]
Position:	Named
Default value:	.
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Id

Specifies the identifier of the virtual machine to be retrieved.

Type:	Guid
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-Name

Specifies the name of the virtual machine to be retrieved.

Type:	String[]
Position:	1
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	True

Outputs

Microsoft.Virtualization.Powershell.VirtualMachine