Get-SCVMHostCluster
Get-SCVMHostCluster
Gets a host cluster object.
Syntax
Parameter Set: Connection
Get-SCVMHostCluster [-ID <Guid]> ] [-Name <String> ] [-VMHostGroup <HostGroup> ] [-VMMServer <ServerConnection> ] [ <CommonParameters>]
Parameter Set: ID
Get-SCVMHostCluster -ID <Guid]> [ <CommonParameters>]
Parameter Set: Name
Get-SCVMHostCluster [-Name] <String> [-VMHostGroup <HostGroup> ] [ <CommonParameters>]
Parameter Set: VMHostGroup
Get-SCVMHostCluster -VMHostGroup <HostGroup> [-Name <String> ] [ <CommonParameters>]
Detailed Description
The Get-SCVMHostCluster cmdlet gets one or more host cluster objects from the Virtual Machine Manager (VMM) database.
Parameters
-ID<Guid]>
Specifies the numerical identifier as a globally unique identifier (GUID) for a specific object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a VMM object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHostGroup<HostGroup>
Specifies a virtual machine host group object.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMMServer<ServerConnection>
Specifies a VMM server object.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
- VMHostCluster
Examples
Example 1: Get all host clusters managed by a VMM server
This command gets all host cluster objects on VMMServer01, and then displays information about each host cluster to the user.
PS C:\> Get-SCVMHostCluster -VMMServer "VMMServer01.Contoso.com"
Example 2: Get all host clusters managed by a VMM server and display host cluster name and virtualization platform
This command gets all host cluster objects on VMMServer01, and passes each object to the Select-Object cmdlet. That cmdlet displays the name and virtualization platform for each host cluster.
PS C:\> Get-SCVMHostCluster -VMMServer "VMMServer01.Contoso.com" | select -Property Name, VirtualizationPlatform
Example 3: Get a host cluster by name
This command gets the host cluster object named VMHostCluster03, and displays information about the cluster to the user.
PS C:\> Get-SCVMHostCluster -Name "VMHostCluster03.Contoso.com"
Example 4: Display the object type, methods, and properties for a host cluster managed by VMM
This command gets the host cluster objects on VMMServer01, and then passes a host cluster object to the Get-Member cmdlet. That cmdlet displays the .NET type for a host cluster object and the list of events, methods, and properties associated with a host cluster object.
PS C:\> Get-SCVMHostCluster -VMMServer "VMMServer01.Contoso.com" | Get-Member