Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Stop-ClusterResource

Stop-ClusterResource

microsoft.failoverclusters.powershell.dll

Synopsis

Takes a resource offline in a failover cluster.

Syntax

Stop-ClusterResource [-Name] [-Cluster] [-IgnoreLocked] [-InputObject] [-Wait] [<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

Accept pipeline input?

false

Accept wildcard characters?

false

-IgnoreLocked <SwitchParameter>

Specifies that locked groups are ignored when running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

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

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

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

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type

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

Return Type

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

Notes

None

Examples

Example 1

This example takes the resource called IP Address 172.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 172.24.11.0"
Name                State               Group               ResourceType 
----                -----               -----               ------------ 
IP Address 172.2... Offline             cluster1FS12        IP Address 

Online Version
Add-ClusterResource
Get-ClusterResource
Move-ClusterResource
Remove-ClusterResource
Resume-ClusterResource
Start-ClusterResource
Suspend-ClusterResource