< Back
Set-DrsVMHostRule
Post
NAME Set-DrsVMHostRule
SYNOPSIS
This cmdlet modifies the specified VM to VMHost DRS rule.
SYNTAX
Set-DrsVMHostRule [-Rule] <DrsVMHostRule[]> [-Enabled <Boolean>] [-Name <String>] [-RunAsync] [-Server
<VIServer[]>] [-Type <DrsVMHostRuleType>] [-VMGroup <DrsClusterVMGroup>] [-VMHostGroup <DrsClusterVMHostGroup>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet modifies the specified VM to VMHost DRS rule.
PARAMETERS
-Enabled <Boolean>
Specifies whether to enable or disable the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the new name for the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Rule <DrsVMHostRule[]>
Specifies the rules you want to modify.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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 new type for the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMGroup <DrsClusterVMGroup>
Specifies the VMGroup you want to use for the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHostGroup <DrsClusterVMHostGroup>
Specifies the VMHostGroup you want to use for the modified rule.
Required? false
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
Zero or more modified DrsVMHostRule objects
NOTES
-------------------------- Example 1 --------------------------
Get-DRSVMHostRule "MyVMHostRule" | Set-DRSVMHostRule -Name "NewRuleName" -Enabled:$false
Renames and disables the "MyVMHostRule" VM to VMHost DRS rule.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Group.html
Get-DrsVMHostRule
New-DrsVMHostRule
Remove-DrsVMHostRule
SYNOPSIS
This cmdlet modifies the specified VM to VMHost DRS rule.
SYNTAX
Set-DrsVMHostRule [-Rule] <DrsVMHostRule[]> [-Enabled <Boolean>] [-Name <String>] [-RunAsync] [-Server
<VIServer[]>] [-Type <DrsVMHostRuleType>] [-VMGroup <DrsClusterVMGroup>] [-VMHostGroup <DrsClusterVMHostGroup>]
[-Confirm] [-WhatIf] [<CommonParameters>]
DESCRIPTION
This cmdlet modifies the specified VM to VMHost DRS rule.
PARAMETERS
-Enabled <Boolean>
Specifies whether to enable or disable the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Name <String>
Specifies the new name for the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Rule <DrsVMHostRule[]>
Specifies the rules you want to modify.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? true
-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 new type for the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMGroup <DrsClusterVMGroup>
Specifies the VMGroup you want to use for the modified rule.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? true
-VMHostGroup <DrsClusterVMHostGroup>
Specifies the VMHostGroup you want to use for the modified rule.
Required? false
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
Zero or more modified DrsVMHostRule objects
NOTES
-------------------------- Example 1 --------------------------
Get-DRSVMHostRule "MyVMHostRule" | Set-DRSVMHostRule -Name "NewRuleName" -Enabled:$false
Renames and disables the "MyVMHostRule" VM to VMHost DRS rule.
RELATED LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Group.html
Get-DrsVMHostRule
New-DrsVMHostRule
Remove-DrsVMHostRule