Share via

Get-SCVMHostCluster

  • Reference
Module:
VirtualMachineManager

Gets a host cluster object.

Syntax

Get-SCVMHostCluster
   [-VMMServer <ServerConnection>]
   [-VMHostGroup <HostGroup>]
   [[-Name] <String>]
   [-ID <Guid>]
   [<CommonParameters>]
Get-SCVMHostCluster
   -VMHostGroup <HostGroup>
   [[-Name] <String>]
   [<CommonParameters>]
Get-SCVMHostCluster
   [-VMHostGroup <HostGroup>]
   [-Name] <String>
   [<CommonParameters>]
Get-SCVMHostCluster
   -ID <Guid>
   [<CommonParameters>]
Get-SCVMHostCluster
   -HyperConvergedStorageArray <StorageArray>
   [<CommonParameters>]

Description

The Get-SCVMHostCluster cmdlet gets one or more host cluster objects from the Virtual Machine Manager (VMM) database.

Examples

Example 1: Get all host clusters managed by a VMM server

PS C:\> Get-SCVMHostCluster -VMMServer "VMMServer01.Contoso.com"

This command gets all host cluster objects on VMMServer01 and displays information about each host cluster to the user.

Example 2: Get all host clusters managed by a VMM server and display the host cluster name and virtualization platform for each cluster

PS C:\> Get-SCVMHostCluster -VMMServer "VMMServer01.Contoso.com" | Select-Object -Property Name, VirtualizationPlatform

This command gets all host cluster objects on VMMServer01 and passes each object to the Select-Object cmdlet, which displays the name and virtualization platform for each host cluster.

Example 3: Get a host cluster by name

PS C:\> Get-SCVMHostCluster -Name "VMHostCluster03.Contoso.com"

This command gets the host cluster object named VMHostCluster03 and displays information about the cluster.

Example 4: Display the object type, methods, and properties for a host cluster managed by VMM

PS C:\> Get-SCVMHostCluster -VMMServer "VMMServer01.Contoso.com" | Get-Member

This command gets the host cluster objects on VMMServer01 and then passes a host cluster object to the Get-Member cmdlet, which displays the .NET type for a host cluster object and the list of events, methods, and properties associated with a host cluster object.

Parameters

-HyperConvergedStorageArray

Type:StorageArray
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ID

Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.

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

-Name

Specifies the name of a VMM object.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VMHostGroup

Specifies a virtual machine host group object.

Type:HostGroup
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-VMMServer

Specifies a VMM server object.

Type:ServerConnection
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

Outputs

VMHostCluster

This cmdlet returns a VMHostCluster object.