Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

Get-VM

Get-VM

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

Syntax

Parameter Set: Name
Get-VM [[-Name] <String[]> ] [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [ <CommonParameters>]

Parameter Set: ClusterObject
Get-VM [-ClusterObject] <PSObject> [ <CommonParameters>]

Parameter Set: Id
Get-VM [[-Id] <Guid]> ] [-CimSession <Microsoft.Management.Infrastructure.CimSession[]> ] [-ComputerName <String[]> ] [-Credential <System.Management.Automation.PSCredential[]> ] [ <CommonParameters>]




Detailed Description

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

Parameters

-CimSession<Microsoft.Management.Infrastructure.CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Credential<System.Management.Automation.PSCredential[]>

Specifies one or more user accounts that have permission to perform this action. The default is the current user.


Aliases

none

Required?

false

Position?

named

Default Value

none

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(ByValue,ByPropertyName)

Accept Wildcard Characters?

false

-Name<String[]>

Specifies the name of the virtual machine to be retrieved.


Aliases

VMName

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

True (ByValue)

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. 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.HyperV.PowerShell.VirtualMachine

Examples

Example 1

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


PS C:\> Get-VM

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

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2015 Microsoft