vSphere PowerCLI Reference

Set-Cluster

Synopsis

Changes the configuration of a cluster.

Syntax

Set-Cluster [-HARestartPriority <HARestartPriority>] [-HAIsolationResponse <HAIsolationResponse>] [-VMSwapfilePolicy <VMSwapfilePolicy>] [-Cluster] <Cluster[]> [[-Name] <String>] [-HAEnabled [<Boolean>]] [-HAAdmissionControlEnabled [<Boolean>]] [-HAFailoverLevel <Int32>] [-DrsEnabled [<Boolean>]] [-DrsMode <DrsMode>] [-DrsAutomationLevel <DrsAutomationLevel>] [-Profile <VMHostProfile>] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-Cluster
New-Cluster
Move-Cluster
Remove-Cluster

Detailed Description

Changes the configuration of a cluster.
HAEnabled is automatically set to $true if some of the HA settings, HAAdmissionControlEnabled, HAFailoverLevel, HARestartPriority, HAIsolationResponse, are specified.
DrsEnabled is automatically set to $true if some of the DRS settings, DrsAutomationLevel, DrsMode, are specified.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
ClusterCluster[]Specify the name of the cluster you want to configure.truetrue (ByValue)
NameStringSpecify a new name for the cluster.falsefalse
ConfirmSwitchParameterIf the value is $true, indicates that the cmdlet asks for confirmation before running. If the value is $false, the cmdlet runs without asking for user confirmation.falsefalse$true
DrsAutomationLevelDrsAutomationLevelSpecify a DRS (Distributed Resource Scheduler) automation level. The valid values are FullyAutomated, Manual, and PartiallyAutomated.falsefalse
DrsEnabledBooleanIndicate that VMware DRS (Distributed Resource Scheduler) is enabled.falsefalse
DrsModeDrsModeThis parameter is deprecated and scheduled for removal. Use the DrsAutomationLevel parameter instead. Specify a DRS (Distributed Resource Scheduler) mode. MuThe valid values are FullyAutomated, Manual, and PartiallyAutomated.falsefalse
HAAdmissionControlEnabledBooleanIndicate that the virtual machines in the cluster will not start if they violate availability constraints.falsefalse
HAEnabledBooleanIndicate that VMware High Availability is enabled.falsefalse
HAFailoverLevelInt32Specify a failover level. This is the number of physical host failures that can be tolerated without impacting the ability to meet minimum thresholds for all running virtual machines. The valid values range from one to four.falsefalse
HAIsolationResponseHAIsolationResponseSpecify whether the virtual machine should be powered off if a host determines that it is isolated from the rest of the compute resource. The valid values are PowerOff and DoNothing. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release.falsefalse
HARestartPriorityHARestartPrioritySpecify the cluster HA restart priority. The valid values are Disabled, Low, Medium, and High. VMware HA is a feature that detects failed virtual machines and automatically restarts them on alternative ESX hosts. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release.falsefalse
ProfileVMHostProfileSpecify a host profile you want to associate with the cluster. If the value of this parameter is $null, the current profile association is removed.falsefalse
RunAsyncSwitchParameterIndicate that the command returns immediately without waiting for the task to complete. In this mode, the output of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync" in the vSphere PowerCLI console.falsefalse
ServerVIServer[]Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer.falsefalse
VMSwapfilePolicyVMSwapfilePolicySpecify the swapfile placement policy. The following values are valid:

InHostDataStore - Store the swapfile in the datastore specified by the VMSwapfileDatastoreID property of the virtual machine host. If the VMSwapfileDatastoreID property is not set or indicates a datastore with insufficient free space, the swapfile is stored in the same directory as the virtual machine. This setting might degrade the VMotion performance.


WithVM - Store the swapfile in the same directory as the virtual machine.
falsefalse
WhatIfSwitchParameterIndicate that the cmdlet is run only to display the changes that would be made and actually no objects are modified.falsefalse

Return Type

Cluster

Notes

Examples

-------------- Example 1 --------------

$cluster1 =  New-Cluster -Name Cluster1 -Location Datacenter

$cluster2 = Set-Cluster -Cluster $cluster1 -Name Cluster2

Creates a new cluster named Cluster1 on the Datacenter. Then renames the cluster to Cluster2.


Copyright © 1998 - 2012 VMware, Inc. All rights reserved.