Set-SCVMHostCluster
Set-SCVMHostCluster
Modifies the properties of a virtual machine host cluster managed by VMM.
Syntax
Parameter Set: Default
Set-SCVMHostCluster [-VMHostCluster] <HostCluster> [-ClusterReserve <UInt32]> ] [-Description <String> ] [-JobGroup <Guid]> ] [-JobVariable <String> ] [-PROTipID <Guid]> ] [-RunAsynchronously] [-SetQuorumDisk <ClientObject> ] [-SetQuorumNodeMajority] [-VMHostManagementCredential <VMMCredential> ] [ <CommonParameters>]
Detailed Description
The Set-SCVMHostCluster cmdlet modifies the properties of a host cluster managed by Virtual Machine Manager (VMM). Properties that you can modify include changing the cluster reserve setting.
The cluster reserve setting specifies the number of host failures that a host cluster can sustain before VMM considers the cluster to be over-committed. An over-committed host cluster is one that cannot withstand the specified number of host failures and still keep all of the virtual machines in the cluster running.
Virtual Machine Manager uses the following processes to determine over-commitment:
-- Host Placement. The placement process calculates whether adding a new virtual machine to the host cluster over-commits the host cluster and, if so, placement stops recommending the deployment of additional virtual machines on hosts in that cluster.
-- Cluster Refresher. The host cluster refresher calculates, at periodic intervals, whether a host cluster is over-committed or not based on the following events:
---- A change in the value specified for the ClusterReserve parameter.
---- The failure or removal of nodes from the host cluster.
---- The addition of nodes to the host cluster.
---- The discovery of new virtual machines on nodes in the host cluster.
The following examples illustrate how over-commitment works:
-- Example of over-commitment when all nodes are functioning:
If you specify a cluster reserve of 2 for an 8-node host cluster, and all 8 nodes are functioning, the host cluster is over-committed if any combination of 6 (8 minus 2) nodes lacks the capacity to accommodate existing virtual machines.
-- Example of over-commitment when some nodes are not functioning:
If you specify a cluster reserve of 2 for an 8-node host cluster, but only 5 nodes are functioning, the host cluster is over-committed if any combination of 3 (5 minus 2) nodes lacks the capacity to accommodate existing virtual machines.
Parameters
-ClusterReserve<UInt32]>
Specifies the number of host failures that a host cluster can sustain before VMM designates the cluster as over-committed. The default value is 1.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies a description of the host cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobGroup<Guid]>
Specifies an identifier for a series of commands that runs as a set just before the final command that includes the same job group identifier runs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-JobVariable<String>
Specifies that job progress is tracked and stored in the variable named by this parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-PROTipID<Guid]>
Specifies the ID of the Performance and Resource Optimization tip (PRO tip) that triggered this action. This parameter lets you audit PRO tips.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-RunAsynchronously
Indicates that the job runs asynchronously so that control returns to the command shell immediately.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SetQuorumDisk<ClientObject>
Specifies a disk to use as the quorum disk for the cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-SetQuorumNodeMajority
Sets the quorum mode to Node Majority for the cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-VMHostCluster<HostCluster>
Specifies a VMM host cluster object.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-VMHostManagementCredential<VMMCredential>
This parameter is obsolete.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
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: Change the setting for the cluster reserve for a host cluster
The first command gets the host cluster object named VMHostCluster01.Contoso.com, and then stores the object in the $VMHostCluster variable.
The second command changes value for the cluster reserve for host cluster VMHostCluster01 to 2.
PS C:\> $VMHostCluster = Get-SCVMHostCluster -Name "VMHostCluster01.Contoso.com"
PS C:\> Set-SCVMHostCluster -VMHostCluster $VMHostCluster -ClusterReserve 2