Stop-ClusterResource

Stop-ClusterResource

Takes a resource offline in a failover cluster.

Syntax

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




Detailed 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.

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

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-IgnoreLocked

Specifies that locked groups are ignored when running the cmdlet.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-InputObject<PSObject>

Specifies the cluster resource to take offline.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

true (ByValue)

Accept Wildcard Characters?

false

-Name<String>

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


Aliases

none

Required?

false

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Wait<Int32>

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • Microsoft.FailoverClusters.PowerShell.ClusterResource
  • Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

Outputs

The output type is the type of the objects that the cmdlet emits.

  • Microsoft.FailoverClusters.PowerShell.ClusterResource
  • Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

Examples

Example 1: Take a resource offline

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.


PS C:\> Stop-ClusterResource "IP Address 10.24.11.0"

Related topics

Community Additions

ADD
Show: