Skip to content

Latest commit

 

History

History
160 lines (112 loc) · 3.66 KB

File metadata and controls

160 lines (112 loc) · 3.66 KB
description external help file Module Name ms.date online version schema title
Use this topic to help manage Windows and Windows Server technologies with Windows PowerShell.
Microsoft.FailoverClusters.PowerShell.dll-Help.xml
FailoverClusters
11/23/2022
2.0.0
Stop-ClusterResource

Stop-ClusterResource

SYNOPSIS

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

Stop-ClusterResource "IP Address 10.24.11.0"

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
Parameter Sets: (All)
Aliases:

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.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-InputObject

Specifies the cluster resource to take offline.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
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
Parameter Sets: (All)
Aliases:

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

Microsoft.FailoverClusters.PowerShell.ClusterResource

Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

OUTPUTS

Microsoft.FailoverClusters.PowerShell.ClusterResource

Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume

NOTES

RELATED LINKS

Add-ClusterResource

Get-ClusterResource

Move-ClusterResource

Remove-ClusterResource

Resume-ClusterResource

Start-ClusterResource

Suspend-ClusterResource