< Back
New-DrsVMHostRule
Post
NAME New-DrsVMHostRule
SYNOPSIS
This cmdlet creates a new VM to VMHost DRS rule.
SYNTAX
New-DrsVMHostRule [-Name] <String> [-Cluster <Cluster>] [-Enabled <Boolean>] [-RunAsync] [-Server <VIServer[]>]
-Type <DrsVMHostRuleType> -VMGroup <DrsClusterVMGroup> -VMHostGroup <DrsClusterVMHostGroup> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet creates a new VM to VMHost DRS rule.
PARAMETERS
-Cluster <Cluster>
Specifies the clusters on which you want to create the new rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Enabled <Boolean>
Specifies whether to enable the new rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name for the new rule.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Type <DrsVMHostRuleType>
Specifies the type of the rule you want to create. This parameter accepts MustRunOn, ShouldRunOn,
MustNotRunOn, and ShouldNotRunOn values.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMGroup <DrsClusterVMGroup>
Specifies the VMGroup you want to use for the new rule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHostGroup <DrsClusterVMHostGroup>
Specifies the VMHostGroup you want to use for the new rule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created DrsVMHostRule object
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... tRule.html
Get-DrsVMHostRule
Remove-DrsVMHostRule
Set-DrsVMHostRule
SYNOPSIS
This cmdlet creates a new VM to VMHost DRS rule.
SYNTAX
New-DrsVMHostRule [-Name] <String> [-Cluster <Cluster>] [-Enabled <Boolean>] [-RunAsync] [-Server <VIServer[]>]
-Type <DrsVMHostRuleType> -VMGroup <DrsClusterVMGroup> -VMHostGroup <DrsClusterVMHostGroup> [-Confirm] [-WhatIf]
[<CommonParameters>]
DESCRIPTION
This cmdlet creates a new VM to VMHost DRS rule.
PARAMETERS
-Cluster <Cluster>
Specifies the clusters on which you want to create the new rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Enabled <Boolean>
Specifies whether to enable the new rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the name for the new rule.
Required? true
Position? 1
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? 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.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-Type <DrsVMHostRuleType>
Specifies the type of the rule you want to create. This parameter accepts MustRunOn, ShouldRunOn,
MustNotRunOn, and ShouldNotRunOn values.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMGroup <DrsClusterVMGroup>
Specifies the VMGroup you want to use for the new rule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHostGroup <DrsClusterVMHostGroup>
Specifies the VMHostGroup you want to use for the new rule.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-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.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Indicates that the cmdlet is run only to display the changes that would be made and actually no objects are
modified.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
The newly created DrsVMHostRule object
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... tRule.html
Get-DrsVMHostRule
Remove-DrsVMHostRule
Set-DrsVMHostRule