Stop-ClusterResource
Stop-ClusterResource
Take a resource offline in a failover cluster.
Syntax
Stop-ClusterResource [-InputObject <psobject>] [[-Name] <string>] [-Cluster <string>] [-Wait <int>] [<CommonParameters>]
InputObject
Name
Cluster
Wait
Detailed Description
Before the resource is taken offline, any resources that depend on it are taken offline.
Parameters
Cluster
Specifies the name of the cluster to run this cmdlet on. If you type "-Cluster ." or omit the parameter, the cmdlet runs on the local cluster.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
InputObject
Specifies the cluster resource to offline.
Default Value: **
Data Type: psobject
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
true (ByValue) |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Name
Specifies the name of the cluster resource to stop. This can also be the name of a cluster shared volume.
Default Value: **
Data Type: string
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
1 |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Wait
Specifies the time in seconds to wait for the operation. If this parameter is not specified the operation waits for completion. If "-Wait 0" is specified the call is initiated and the cmdlet returns right away.
Default Value: **
Data Type: int
Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
false |
required |
Variable Length? |
false |
variableLength |
Accept wildcard characters? |
false |
globbing |
Accept Pipeline Input? |
false |
pipelineInput |
Position? |
named |
position |
Value Attributes
| Name | Value | PSMAML Attribute |
|---|---|---|
Required? |
true |
required |
Variable Length? |
false |
variableLength |
Input Type
Microsoft.FailoverClusters.PowerShell.ClusterResource, Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume
Return Type
Microsoft.FailoverClusters.PowerShell.ClusterResource, Microsoft.FailoverClusters.PowerShell.ClusterSharedVolume
Examples
-------------------------- EXAMPLE 1 --------------------------
Command Prompt: C:\PS>
Stop-ClusterResource "IP Address 172.24.11.0"
Name State Group ResourceType
---- ----- ----- ------------
IP Address 172.2... Offline cluster1FS12 IP Address
Description
-----------
This command 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.
See Also
Reference
Add-ClusterResource
Get-ClusterResource
Move-ClusterResource
Remove-ClusterResource
Resume-ClusterResource
Start-ClusterResource
Suspend-ClusterResource