Set-DrsClusterGroup

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.

Syntax

[-VM]  <VirtualMachine[]>
-DrsClusterGroup  <DrsClusterGroup>
[-Add]
[-Remove]
[-RunAsync]
[-Server  <VIServer[]>]
[CommonParameters]

Parameters

Required Parameter Name Type Position Features Description
required
VM
VirtualMachine[] 1 Specifies the virtual machines which you want to add or remove to or from the specified DRS cluster group.
required
DrsClusterGroup
DrsClusterGroup named
  • pipeline
  • Specifies the DRS cluster group you want to modify.
    optional
    Add
    SwitchParameter named Specifies that you want to add virtual machines or VM hosts to the DRS cluster group.
    optional
    Remove
    SwitchParameter named Specifies that you want to remove virtual machines or VM hosts from the DRS cluster group.
    optional
    RunAsync
    SwitchParameter named 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.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

    [-VMHost]  <VMHost[]>
    -DrsClusterGroup  <DrsClusterGroup>
    [-Add]
    [-Remove]
    [-RunAsync]
    [-Server  <VIServer[]>]
    [CommonParameters]

    Parameters

    Required Parameter Name Type Position Features Description
    required
    VMHost
    VMHost[] 1 Specifies the VM hosts which you want to add or remove to or from the specified DRS cluster group.
    required
    DrsClusterGroup
    DrsClusterGroup named
  • pipeline
  • Specifies the DRS cluster group you want to modify.
    optional
    Add
    SwitchParameter named Specifies that you want to add virtual machines or VM hosts to the DRS cluster group.
    optional
    Remove
    SwitchParameter named Specifies that you want to remove virtual machines or VM hosts from the DRS cluster group.
    optional
    RunAsync
    SwitchParameter named 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.
    optional
    Server
    VIServer[] named
  • wildcards
  • Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null 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.

    Output

    VMware.VimAutomation.ViCore.Types.V1.Cluster.DrsClusterGroup

    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.

    Related Commands

    Feedback

    Was this page helpful?