## PowerCLI Reference

# Set-DrsClusterGroup

## Synopsis

This cmdlet adds or removes either virtual machines or VM hosts to or from the specified DRS cluster group, depending on the used parameter set.

Syntax

Set-DrsClusterGroup [-DrsClusterGroup] <DrsClusterGroup> [-VM] <VirtualMachine[]> [-Add] [-Remove] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]
Set-DrsClusterGroup [-DrsClusterGroup] <DrsClusterGroup> [-VMHost] <VMHost[]> [-Add] [-Remove] [-Server <VIServer[]>] [-RunAsync] [-WhatIf] [-Confirm] [<CommonParameters>]

Related Commands

Online version
Get-DrsClusterGroup
New-DrsClusterGroup
Remove-DrsClusterGroup

Detailed Description

This cmdlet adds or removes either virtual machines or VM hosts to or from the specified DRS cluster group, depending on the used parameter set. You must either specify the Add or Remove parameter for both parameter sets. If not specified, you receive a terminating error.

Parameters

Name | Type | Description | Required? | Pipeline Input | Default Value
--- | --- | --- | --- | --- | ---
DrsClusterGroup | DrsClusterGroup | Specifies the DRS cluster group you want to modify. | true | true (ByValue)
VM | VirtualMachine[] | Specifies the virtual machines which you want to add or remove to or from the specified DRS cluster group. | true | false
VMHost | VMHost[] | Specifies the VM hosts which you want to add or remove to or from the specified DRS cluster group. | true | false
Add | SwitchParameter | Specifies that you want to add virtual machines or VM hosts to the DRS cluster group. | 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
Remove | SwitchParameter | Specifies that you want to remove virtual machines or VM hosts from the DRS cluster group. | 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
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

Zero or more modified DrsClusterGroup objects

Notes

Examples

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

    $vm = Get-VM "MyVM"
    Get-DrsClusterGroup "MyClusterGroup" | Set-DrsClusterGroup -VM $vm -Add

Adds the "MyVM" virtual machine to the "MyClusterGroup" DRS cluster group by using a pipeline.

-------------- Example 2 --------------

    $vmhost = Get-VMHost "MyVMHost"
    Get-DrsClusterGroup "MyClusterGroup" | Set-DrsClusterGroup -VMHost $vmhost -Remove

Removes the "MyVMHost" VM host from the "MyClusterGroup" DRS cluster group by using a pipeline.

Copyright © VMware, Inc. All rights reserved.