Table of contents
TLS
TOC
Collapse the table of content
Expand the table of content

Get-VMHostCluster

Brian Lich|Last Updated: 3/8/2017

SYNOPSIS

Gets virtual machine host clusters.

SYNTAX

ClusterName (Default)

Get-VMHostCluster [-ClusterName] <String[]> [[-Credential] <PSCredential[]>] [<CommonParameters>]

CimSession

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

DESCRIPTION

The Get-VMHostCluster cmdlet gets VMHostCluster objects.

EXAMPLES

Example 1: Get a virtual machine host cluster

PS C:\> Get-VMHostCluster -ClusterName "ContosoCluster"

This command gets the VMHostCluster object for the cluster named ContosoCluster.

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[]
Parameter Sets: CimSession
Aliases: 

Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-ClusterName

Specifies an array of names of the virtual machine host clusters that this cmdlet gets.

Type: String[]
Parameter Sets: ClusterName
Aliases: 

Required: True
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[]
Parameter Sets: ClusterName
Aliases: 

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

OUTPUTS

Microsoft.HyperV.PowerShell.VMHostCluster

This cmdlet returns a VMHostCluster object.

NOTES

Set-VMHostCluster

© 2017 Microsoft