Get-VMHost

Module:: hyper-v

Gets a Hyper-V host.

Syntax

Get-VMHost
   [[-ComputerName] <String[]>]
   [[-Credential] <PSCredential[]>]
   [<CommonParameters>]

Get-VMHost
   [-CimSession] <CimSession[]>
   [<CommonParameters>]

Description

The Get-VMHost cmdlet gets a Hyper-V host.

Examples

Example 1

PS C:\> Get-VMHost

Gets the local Hyper-V host.

Required Parameters

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

Type:	CimSession[]
Position:	0
Default value:	None
Accept pipeline input:	True (ByPropertyName)
Accept wildcard characters:	False

Optional Parameters

-ComputerName

Specifies one or more Hyper-V hosts that run this cmdlet. 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:	0
Default value:	None
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

-Credential

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

Type:	PSCredential[]
Position:	1
Default value:	None
Accept pipeline input:	True (ByValue)
Accept wildcard characters:	False

Outputs

Microsoft.HyperV.PowerShell.Host