Start-ClusterResource
Start-ClusterResource
Brings a resource online in a failover cluster.
Syntax
Parameter Set: InputObject
Start-ClusterResource [[-Name] <String> ] [-Cluster <String> ] [-IgnoreLocked] [-InputObject <PSObject> ] [-Wait <Int32> ] [ <CommonParameters>]
Detailed Description
The Start-ClusterResource cmdlet brings a resource online in a failover cluster. Before the resource is brought online, any resources that it depends are brought online.
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 bring online.
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 bring online. This can also be the name of a Cluster Shared Volume (CSV).
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: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
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
This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before bringing the resource online, this cmdlet brings online any resources on which the resource depends.
PS C:\> Start-ClusterResource –Name "IP Address 172.24.11.0"
EXAMPLE 2
This example brings the resource called IP Address 172.24.11.0 online on the local cluster. Before bringing the resource online, this cmdlet brings online any resources on which the resource depends. The Windows PowerShell® prompt returns as soon as the action has been initiated.
PS C:\> Start-ClusterResource –Name "IP Address 172.24.11.0" -Wait 0