New-DrsRule

This cmdlet creates a new DRS rule. Each rule defines the virtual machines that can run on the same host (affinity rule) or must run on different hosts (anti-affinity rule).

Syntax

[-Cluster]  <Cluster>
-KeepTogether  <Boolean>
-Name  <String>
-VM  <VirtualMachine[]>
[-Enabled  <Boolean>]
[-RunAsync]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Cluster
Cluster 1
  • wildcards
  • pipeline
  • Specifies the cluster for which the new DRS rule applies. Passing multiple values to this parameter is obsolete.
    required
    KeepTogether
    Boolean named If the value of this parameter is $true, the new DRS rule is an affinity rule. If the value is $false, the DRS rule is an anti-affinity rule.
    required
    Name
    String named Specifies a name for the new DRS rule.
    required
    VM
    VirtualMachine[] named
  • wildcards
  • Specifies the virtual machines that are referenced by the new DRS rule.
    optional
    Enabled
    Boolean named If the value of this parameter is $true, the new DRS rule is enabled for the specified clusters. If the value is $false, it is disabled.
    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
  • pipeline
  • 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 Connect-VIServer.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsVMAffinityRule

    Examples


    Example 1

    New-DrsRule -Cluster $cluster -Name antiAffinityRule1 -KeepTogether $false -VM $antiAffinityVMs

    Creates a new DRS rule for the cluster saved in the $cluster variable with the specified parameters.

    Related Commands

    Feedback

    Was this page helpful?