Get-SCVMHostCluster
Gets a host cluster object.
Syntax
Connection (Default)
Get-SCVMHostCluster
[[-Name] <String>]
[-VMMServer <ServerConnection>]
[-VMHostGroup <HostGroup>]
[-ID <Guid>]
[<CommonParameters>]
VMHostGroup
Get-SCVMHostCluster
[[-Name] <String>]
-VMHostGroup <HostGroup>
[<CommonParameters>]
Name
Get-SCVMHostCluster
[-Name] <String>
[-VMHostGroup <HostGroup>]
[<CommonParameters>]
ID
Get-SCVMHostCluster
-ID <Guid>
[<CommonParameters>]
AssociatedWithStorageArray
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
The Get-SCVMHostCluster cmdlet gets one or more host cluster objects from the Virtual Machine Manager (VMM) database.
Parameter properties
| Type: | StorageArray |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
AssociatedWithStorageArray
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ID
Specifies the numerical identifier as a globally unique identifier, or GUID, for a specific object.
Parameter properties
| Type: | Guid |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Connection
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Name
Specifies the name of a VMM object.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Connection
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
VMHostGroup
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMHostGroup
Specifies a virtual machine host group object.
Parameter properties
| Type: | HostGroup |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Connection
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
Name
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-VMMServer
Specifies a VMM server object.
Parameter properties
| Type: | ServerConnection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Connection
| Position: | Named |
| 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
VMHostCluster
This cmdlet returns a VMHostCluster object.