New-DrsVMHostRule

This cmdlet creates a new VM to VMHost DRS rule.

Syntax

-Name  <String>
-Type  <DrsVMHostRuleType>
-VMGroup  <DrsClusterVMGroup>
-VMHostGroup  <DrsClusterVMHostGroup>
[-Cluster  <Cluster>]
[-Enabled  <Boolean>]
[-RunAsync]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
Name
String named Specifies the name for the new rule.
required
Type
DrsVMHostRuleType named Specifies the type of the rule you want to create. This parameter accepts MustRunOn, ShouldRunOn, MustNotRunOn, and ShouldNotRunOn values.
required
VMGroup
DrsClusterVMGroup named
  • wildcards
  • Specifies the VMGroup you want to use for the new rule.
    required
    VMHostGroup
    DrsClusterVMHostGroup named
  • wildcards
  • Specifies the VMHostGroup you want to use for the new rule.
    optional
    Cluster
    Cluster named
  • wildcards
  • Specifies the clusters on which you want to create the new rule.
    optional
    Enabled
    Boolean named Specifies whether to enable the new rule.
    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 Connect-VIServer.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsVMHostRule

    Examples


    Example 1

    New-DrsVMHostRule -Name "MyDrsRule" -Cluster "MyCluster" -VMGroup "MyVMGroup" -VMHostGroup "MyVMHostGroup" -Type "MustRunOn"

    Creates a new VM to VMHost DRS rule within the "MyCluster" cluster.

    Related Commands

    Feedback

    Was this page helpful?