Get-VMHostCluster
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.
Parameter properties
| Type: | CimSession[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
CimSession
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | True |
| Value from remaining arguments: | False |
-ClusterName
Specifies an array of names of the virtual machine host clusters that this cmdlet gets.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ClusterName
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies one or more user accounts that have permission to perform this action. The default is the current user.
Parameter properties
| Type: | PSCredential[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ClusterName
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Outputs
Microsoft.HyperV.PowerShell.VMHostCluster
This cmdlet returns a VMHostCluster object.