Set-Cluster

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

Syntax

-Cluster  <Cluster[]>
[[-Name]  <String>]
[-BaseImage  <BaseImage>]
[-Component  <Component[]>]
[-CryptoMode  <CryptoMode>]
[-DrsAutomationLevel  <DrsAutomationLevel>]
[-DrsEnabled  <Boolean>]
[-DrsMode  <DrsMode>]
[-EVCMode  <String>]
[-HAAdmissionControlEnabled  <Boolean>]
[-HAEnabled  <Boolean>]
[-HAFailoverLevel  <Int32>]
[-HAIsolationResponse  <HAIsolationResponse>]
[-HARestartPriority  <HARestartPriority>]
[-Profile  <VMHostProfile>]
[-RunAsync]
[-Server  <VIServer[]>]
[-VMSwapfilePolicy  <VMSwapfilePolicy>]
[-VendorAddOn  <AddOn>]
[-VsanDiskClaimMode  <VsanDiskClaimMode>]
[-VsanEnabled  <Boolean>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Cluster
Cluster[] named
  • wildcards
  • pipeline
  • Specifies the name of the cluster you want to configure.
    optional
    Name
    String 1 Specifies a new name for the cluster.
    optional
    BaseImage
    BaseImage named Specifies the ESXi base image that the cluster's hosts should comply with.
    optional
    Component
    Component[] named Specifies the ESXi components that the cluster's hosts should comply with.
    optional
    CryptoMode
    CryptoMode named Specifies the cluster encryption mode you want to configure. When set to OnDemand, hosts in the cluster are not required to be in a cryptographically "Safe" state. When set to ForceEnable, all hosts in the cluster are forced to be cryptographically "Safe", that is, vCenter Server has installed a host key on the host.
    optional
    DrsAutomationLevel
    DrsAutomationLevel named Specifies a DRS automation level. The valid values are FullyAutomated, Manual, and PartiallyAutomated.
    optional
    DrsEnabled
    Boolean named If specified, enables VMware DRS.
    optional
    DrsMode
    DrsMode named This parameter is deprecated and scheduled for removal. Use the DrsAutomationLevel parameter instead.
    optional
    EVCMode
    String named Specifies the EVC mode of the newly created cluster. If not specified or set to $null, EVC is disabled.
    optional
    HAAdmissionControlEnabled
    Boolean named Indicates that the virtual machines in the cluster will not start if they violate availability constraints.
    optional
    HAEnabled
    Boolean named If specified, enables VMware High Availability.
    optional
    HAFailoverLevel
    Int32 named Specifies 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 are in the range of 1 to 4.
    optional
    HAIsolationResponse
    HAIsolationResponse named Specifies 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.
    optional
    HARestartPriority
    HARestartPriority named Specifies 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/ESXi hosts. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release.
    optional
    Profile
    VMHostProfile named
  • wildcards
  • Specifies a host profile you want to associate with the cluster. If the value of this parameter is $null, the current profile association is removed.
    optional
    RunAsync
    SwitchParameter named Indicates 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 VMware PowerCLI console.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.
    optional
    VMSwapfilePolicy
    VMSwapfilePolicy named Specifies the swapfile placement policy. The following values are valid:
    optional
    VendorAddOn
    AddOn named Specifies the ESXi vendor add-on that the cluster's hosts should comply with.
    optional
    VsanDiskClaimMode
    VsanDiskClaimMode named Specifies the mode by which disks are claimed by vSAN.
    optional
    VsanEnabled
    Boolean named Specifies whether the vSAN feature is enabled on this cluster.

    -Cluster  <Cluster[]>
    -Remediate
    [-AcceptEULA]
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    Cluster
    Cluster[] named
  • wildcards
  • pipeline
  • Specifies the name of the cluster you want to configure.
    required
    Remediate
    SwitchParameter named Indicates that you want to remediate the cluster's hosts to the target state.
    optional
    AcceptEULA
    SwitchParameter named Indicates that the End User License Agreement (EULA) is accepted for the images that you want to install on the cluster's hosts in order to comply with the target state.
    optional
    RunAsync
    SwitchParameter named Indicates 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 VMware PowerCLI console.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of the Connect-VIServer cmdlet.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Inventory.Cluster

    Examples


    Example 1

    Get-Cluster -Name "MyClusterName" | Set-Cluster -Name "NewClusterName" -HAEnabled:$true -HAAdmissionControlEnabled:$true -HAFailoverLevel 2 -VMSwapfilePolicy "InHostDatastore" -HARestartPriority "Low" -HAIsolationResponse "PowerOff"

    Renames the "MyClusterName" cluster to "NewClusterName" and changes its VMware High Availability (HA) settings.

    Example 2

    Set-Cluster -Cluster "MyClusterName" -DRSEnabled:$true -DRSAutomationLevel "Manual"

    Changes the VMware Distributed Resource Scheduler (DRS) settings of the "MyClusterName" cluster.

    Example 3

    Set-Cluster -Cluster "MyClusterName" -EVCMode "intel-nehalem"

    Changes the VMware Enhanced vMotion Compatibility (EVC) settings of the "MyClusterName" cluster.

    Example 4

    Set-Cluster -Cluster "MyClusterName" -CryptoMode "ForceEnable"

    Changes the encryption mode settings of the "MyClusterName" cluster.

    Related Commands

    Feedback

    Was this page helpful?