Stop-ClusterGroup
Stops one or more clustered roles on a failover cluster.
Syntax
Stop-ClusterGroup
[[-Name] <String>]
[-IgnoreLocked]
[-Wait <Int32>]
[-InputObject <PSObject>]
[-Cluster <String>]
[<CommonParameters>]
Description
The Stop-ClusterGroup
cmdlet stops one or more clustered roles, also known as resource groups,
on a failover cluster.
If maintenance on a clustered role is needed, the clustered role can be stopped in an orderly fashion by using this cmdlet.
Examples
Example 1: Stop a clustered role on the local cluster
Stop-ClusterGroup FileServer1
This example stops the clustered role, or resource group, called FileServer1
on the local cluster.
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 |
-IgnoreLocked
Specifies that locked groups are ignored when running the cmdlet.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifies the clustered role to stop.
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 stop.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Wait
Specifies the time in seconds to wait for the cmdlet. If the Wait parameter isn't specified,
then the cmdlet waits for completion. If -Wait 0
is specified, then the call is initiated and the
cmdlet returns without waiting.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.FailoverClusters.PowerShell.ClusterGroup
Outputs
Microsoft.FailoverClusters.PowerShell.ClusterGroup