Remove-ClusterGroup
Remove-ClusterGroup
Remove a clustered service or application (also called a resource group) from a failover cluster.
Syntax
Remove-ClusterGroup [-InputObject <psobject>] [[-Name] <StringCollection>] [-Cluster <string>] [-Force] [-RemoveResources] [<CommonParameters>]
InputObject
Name
Cluster
Force
RemoveResources
Detailed Description
You can use this cmdlet to delete a group. If the group still has resources in it, you must either remove the resources first, or specify the -RemoveResources parameter.
Parameters
Cluster
Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Force
Performs the operation without prompting for confirmation. By default this operation will ask for confirmation from the user before proceeding.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
InputObject
Specifies the cluster group to remove.
Default Value: **
Data Type: psobject
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Name
Specifies the name of the cluster group to remove.
Default Value: **
Data Type: StringCollection
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
RemoveResources
Causes the cmdlet to delete all resource in the cluster group before removing the cluster group.
Default Value: **
Data Type: SwitchParameter
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.FailoverClusters.PowerShell.ClusterGroup
Return Type
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Remove-ClusterGroup MyPrintServer
Description
-----------
After prompting for confirmation, this command removes the clustered service MyPrintServer, if the resources have first been removed from it.
-------------------------- EXAMPLE 2 --------------------------
Command Prompt: C:\PS>
Remove-ClusterGroup MyPrintServer -Force
Description
-----------
This command removes the clustered service MyPrintServer, if the resources have first been removed from it. The command does not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
Command Prompt: C:\PS>
Remove-ClusterGroup MyPrintServer -Force -RemoveResources
Description
-----------
This command removes the clustered service MyPrintServer, without prompting for confirmation. Cluster resources in MyPrintServer will be deleted.
See Also
Reference
Add-ClusterGroup
Get-ClusterGroup
Move-ClusterGroup
Start-ClusterGroup
Stop-ClusterGroup