Remove-ClusterGroup

  • Reference
Module:
FailoverClusters

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

Syntax

Remove-ClusterGroup
      [-VMId <Guid>]
      [[-Name] <StringCollection>]
      [-Force]
      [-RemoveResources]
      [-InputObject <PSObject>]
      [-Cluster <String>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

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.

Examples

Example 1

PS C:\> Remove-ClusterGroup -Name MyFileServer

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

Example 2

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

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

Example 3

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

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

Parameters

-Cluster

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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies the clustered role to remove.

Type:PSObject
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies the name of the clustered role to remove.

Type:StringCollection
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveResources

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VMId

Specifies the virtual machine identifier (ID).

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.FailoverClusters.PowerShell.ClusterGroup

Outputs

None