New-Cluster

This cmdlet creates a new cluster with the provided inputs in the location that is specified by the Location parameter. 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

-Location  <VIContainer>
-Name  <String>
[-BaseImage  <BaseImage>]
[-CryptoMode  <CryptoMode>]
[-DrsAutomationLevel  <DrsAutomationLevel>]
[-DrsEnabled]
[-DrsMode  <DrsMode>]
[-EVCMode  <String>]
[-HAAdmissionControlEnabled]
[-HAEnabled]
[-HAFailoverLevel  <Int32>]
[-HAIsolationResponse  <HAIsolationResponse>]
[-HARestartPriority  <HARestartPriority>]
[-Server  <VIServer[]>]
[-VMSwapfilePolicy  <VMSwapfilePolicy>]
[-VendorAddOn  <AddOn>]
[-VsanDiskClaimMode  <VsanDiskClaimMode>]
[-VsanEnabled]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Location
VIContainer named
  • wildcards
  • pipeline
  • Specifies the location where you want to place the new cluster. If a data center is specified for the Location parameter, the cluster is created in its "hostFolder" folder. The "hostFolder" is a system folder and is guaranteed to exist.
    required
    Name
    String named Specifies the name of the new cluster.
    optional
    BaseImage
    BaseImage named Specifies the ESXi base image that the cluster's hosts should comply with.
    optional
    CryptoMode
    CryptoMode named Specifies the cluster encryption mode. 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 in a 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
    SwitchParameter 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 VMware EVC mode of the newly created cluster. If not specified or set to $null, EVC is disabled.
    optional
    HAAdmissionControlEnabled
    SwitchParameter named Indicates that virtual machines cannot be powered on if they violate availability constraints.
    optional
    HAEnabled
    SwitchParameter named If specified, enables VMware HA.
    optional
    HAFailoverLevel
    Int32 named Specifies a configured 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 Indicates that 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 hosts. Passing values to this parameter through a pipeline is deprecated and will be disabled in a future release.
    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. If not specified and VsanEnabled is specified, the assumed value is Manual.
    optional
    VsanEnabled
    SwitchParameter named Indicates that the vSAN feature is enabled on this cluster.

    Output

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

    Examples


    Example 1

    New-Cluster -Name "MyCluster" -Location "MyDatacenter"

    Creates a new cluster named "MyCluster" in the "MyDatacenter" data center.

    Example 2

    New-Cluster -Name "MyCluster" -Location "MyDatacenter" -HAEnabled -HAAdmissionControlEnabled -HAFailoverLevel 2 -VMSwapfilePolicy "InHostDatastore" -HARestartPriority "Low" -HAIsolationResponse "PowerOff"

    Creates a new cluster named "MyCluster" in the "MyDatacenter" data center with specified VMware Hgh Availability (HA) settings.

    Example 3

    New-Cluster -Name "MyCluster" -Location "MyDatacenter" -DRSEnabled -DRSAutomationLevel 'Manual'

    Creates a new cluster named "MyCluster" in the "MyDatacenter" data center with specified VMware Distributed Resource Scheduler (DRS) settings.

    Example 4

    New-Cluster -Name "MyCluster" -Location "MyDatacenter" -EVCMode 'intel-nehalem'

    Creates a new cluster named "MyCluster" in the "MyDatacenter" data center with specified VMware Enhanced vMotion Compatibility (EVC) settings.

    Example 5

    New-Cluster -Name "MyCluster" -Location "MyDatacenter" -CryptoMode 'ForceEnable'

    Creates a new cluster named "MyCluster" in the "MyDatacenter" data center with the specified cluster encryption mode.

    Related Commands

    Feedback

    Was this page helpful?