< Back
Set-DrsClusterGroup
Post
NAME 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] [-RunAsync]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DrsClusterGroup [-DrsClusterGroup] <DrsClusterGroup> [-VMHost] <VMHost[]> [-Add] [-Remove] [-RunAsync]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-Add [<SwitchParameter>]
Specifies that you want to add virtual machines or VM hosts to the DRS cluster group.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DrsClusterGroup <DrsClusterGroup>
Specifies the DRS cluster group you want to modify.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Remove [<SwitchParameter>]
Specifies that you want to remove virtual machines or VM hosts from the DRS cluster group.
Required? false
Position? named
Default value False
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
-VM <VirtualMachine[]>
Specifies the virtual machines which you want to add or remove to or from the specified DRS cluster group.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMHost <VMHost[]>
Specifies the VM hosts which you want to add or remove to or from the specified DRS cluster group.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
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 DrsClusterGroup objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Group.html
Get-DrsClusterGroup
New-DrsClusterGroup
Remove-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] [-RunAsync]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
Set-DrsClusterGroup [-DrsClusterGroup] <DrsClusterGroup> [-VMHost] <VMHost[]> [-Add] [-Remove] [-RunAsync]
[-Server <VIServer[]>] [-Confirm] [-WhatIf] [<CommonParameters>]
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
-Add [<SwitchParameter>]
Specifies that you want to add virtual machines or VM hosts to the DRS cluster group.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
-DrsClusterGroup <DrsClusterGroup>
Specifies the DRS cluster group you want to modify.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByValue)
Accept wildcard characters? false
-Remove [<SwitchParameter>]
Specifies that you want to remove virtual machines or VM hosts from the DRS cluster group.
Required? false
Position? named
Default value False
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
-VM <VirtualMachine[]>
Specifies the virtual machines which you want to add or remove to or from the specified DRS cluster group.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-VMHost <VMHost[]>
Specifies the VM hosts which you want to add or remove to or from the specified DRS cluster group.
Required? true
Position? 2
Default value None
Accept pipeline input? False
Accept wildcard characters? 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.
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 DrsClusterGroup objects
NOTES
-------------------------- 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 LINKS
Online Version: https://code.vmware.com/doc/preview?id= ... Group.html
Get-DrsClusterGroup
New-DrsClusterGroup
Remove-DrsClusterGroup