Syntax
New-DrsVMHostRule [-Name] <String> [-Enabled <Boolean>] [-Cluster <Cluster>] -VMGroup <DrsClusterVMGroup> -VMHostGroup <DrsClusterVMHostGroup> -Type <DrsVMHostRuleType> [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]Related Commands
Online versionDetailed Description
This cmdlet creates a new VM to VMHost DRS rule.Parameters
| Name | Type | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|---|
| Name | String | Specifies the name for the new rule. | true | false | |
| Cluster | Cluster | Specifies the clusters on which you want to create the new rule. | false | false | |
| Confirm | SwitchParameter | If 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. | false | false | |
| Enabled | Boolean | Specifies whether to enable the new rule. | false | false | |
| RunAsync | SwitchParameter | 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. | false | false | |
| Server | VIServer[] | Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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. | false | false | |
| Type | DrsVMHostRuleType | Specifies the type of the rule you want to create. This parameter accepts MustRunOn, ShouldRunOn, MustNotRunOn, and ShouldNotRunOn values. | true | false | |
| VMGroup | DrsClusterVMGroup | Specifies the VMGroup you want to use for the new rule. | true | false | |
| VMHostGroup | DrsClusterVMHostGroup | Specifies the VMHostGroup you want to use for the new rule. | true | false | |
| WhatIf | SwitchParameter | Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are modified. | false | false |
Return Type
The newly created DrsVMHostRule objectNotes
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.