Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Remove-ClusterGroup

Remove-ClusterGroup

microsoft.failoverclusters.powershell.dll

Synopsis

Removes a clustered role, also called a resource group, from a failover cluster.

Syntax

Remove-ClusterGroup [-Name] [-Cluster] [-Force] [-InputObject] [-RemoveResources] [<CommonParameters>]

Detailed Description

The Remove-ClusterGroup cmdlet removes a clustered role. also called a resource group, from a failover cluster.

Use this cmdlet to delete a group. If the group still has resources in it, then either remove the resources first, or specify the RemoveResources parameter.

Parameters

-Cluster <String>

Specifies the name of the cluster on which to run this cmdlet. If the input for this parameter is . or it is omitted, then the cmdlet runs on the local cluster.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-Force <SwitchParameter>

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-InputObject <PSObject>

Specifies the clustered role to remove.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

true (ByValue)

Accept wildcard characters?

false

-Name <StringCollection>

Specifies the name of the clustered role to remove.

Aliases

None

Required?

false

Position

1

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

-RemoveResources <SwitchParameter>

Causes the cmdlet to delete all resources in the clustered role before removing the clustered role.

Aliases

None

Required?

false

Position

named

Default value

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Return Type

None

Notes

None

Examples

EXAMPLE 1

This example prompts the user for confirmation and then removes the clustered role named MyFileServer, if the resources have first been removed from it.

PS C:\>Remove-ClusterGroup –Name MyFileServer

EXAMPLE 2

This example removes the clustered role named MyFileServer, if the resources have first been removed from it. The cmdlet does not prompt for confirmation.

PS C:\>Remove-ClusterGroup –Name MyFileServer -Force

EXAMPLE 3

This example removes the clustered role named MyFileServer, without prompting for confirmation. All cluster resources in MyFileServer will be deleted.

PS C:\>Remove-ClusterGroup –Name MyFileServer -Force -RemoveResources

Online Version
Add-ClusterGroup
Get-ClusterGroup
Move-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup