Stop-ClusterResource

  • Reference
Module:
FailoverClusters

Takes a resource offline in a failover cluster.

Syntax

Stop-ClusterResource
    [[-Name] <String>]
    [-IgnoreLocked]
    [-Wait <Int32>]
    [-InputObject <PSObject>]
    [-Cluster <String>]
    [<CommonParameters>]

Description

The Stop-ClusterResource cmdlet takes a resource offline in a failover cluster. Before the resource is taken offline, any resources that depend on it are taken offline.

Examples

Example 1: Take a resource offline

PS C:\> Stop-ClusterResource "IP Address 10.24.11.0"
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
IP Address 10.2...  Offline             cluster1FS12        IP Address

This example takes the resource called IP Address 10.24.11.0 offline on the local cluster. Before taking the resource offline, it takes offline any dependent resources.

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 cluster resource to take offline.

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

-Name

Specifies the name of the cluster resource to take offline. This can also be the name of a Cluster Shared Volume.

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 is not 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.ClusterResource

Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

Outputs

Microsoft.FailoverClusters.PowerShell.ClusterResource

Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume