powershellscripts.com

Tutorials  PowerShell Cmdlet Help for Set-DrsRule



NAME
Set-DrsRule

SYNOPSIS
Modifies an existing DRS rule.

SYNTAX
Set-DrsRule [[-Enabled] []] [-Rule] [-Name ] [-VM ] [-RunA
sync] [-Server ] [-WhatIf] [-Confirm] []


DESCRIPTION
Modifies an existing 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).


PARAMETERS
-Enabled []
Indicate that the DRS rule is enabled.

Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Rule
Specifies the DRS rule you want to modify.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false

-Name
Specify a new name for the DRS rule.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-VM
Specify the virtual machines that can be referenced by the new DRS rule.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-RunAsync
Indicate that the command returns immediately without waiting for the task to complete. In this mode, the outpu
t of the cmdlet is a Task object. For more information about the -RunAsync parameter run " help About_RunAsync"
in the vSphere PowerCLI console.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Server
Specify the vSphere servers on which you want to run the cmdlet. If no value is given to this parameter, the co
mmand runs on the default servers. For more information about default servers, see the description of Connect-V
IServer.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? true

-WhatIf
Indicate that the cmdlet is run only to display the changes that would be made and actually no objects are modi
fied.

Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm
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 $true
Accept pipeline input? false
Accept wildcard characters? false


This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DrsVMAffinityRule


NOTES




-------------- Example 1 --------------

C:\PS>$vm = Get-VM DrsRuleVM1*

Set-DrsRule -Rule $affinityRule -VM $vm -Enabled $true;


Updates the list of virtual machines that might be referenced by the DRS rule stored in the $affinityRule variable
and enables the rule.






RELATED LINKS
Online version: http://www.vmware.com/support/developer/PowerCLI/PowerCLI501/html/Set-DrsRule.html
Get-DrsRule
New-DrsRule
Remove-DrsRule