Get-CauRun
Get-CauRun
Retrieves status information about an Updating Run currently in progress.
Syntax
Parameter Set: DefaultParamSet
Get-CauRun [[-ClusterName] <String> ] [-Credential <PSCredential> ] [ <CommonParameters>]
Parameter Set: ShowClusterNodeState
Get-CauRun [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-ShowClusterNodeState] [ <CommonParameters>]
Parameter Set: WaitForCompletion
Get-CauRun [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-WaitForCompletion] [ <CommonParameters>]
Parameter Set: WaitForStart
Get-CauRun [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-WaitForStart] [ <CommonParameters>]
Detailed Description
The Get-CauRun cmdlet retrieves status information about an Updating Run currently in progress. Use this cmdlet to monitor current Updating Runs.
Parameters
-ClusterName<String>
Specifies the name of the cluster for which to get the Updating Run status. This parameter is only required when this cmdlet is not run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
Aliases |
none |
Required? |
false |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Credential<PSCredential>
Specifies the administrative credentials for the target cluster.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ShowClusterNodeState
If this parameter is specified, the cmdlet retrieves the status of the WMI object that is created on each cluster node. This can be used to debug the status of leftover objects.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WaitForCompletion
Returns after the Updating Run has finished, and writes the updated CAU run objects to the output stream as progress is recorded by the current CAU Update Coordinator.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WaitForStart
Returns only if there is an Updating Run in progress on the specified cluster, otherwise waits for an Updating Run to begin.
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.
- None
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.ClusterAwareUpdating.CauRun
- Microsoft.ClusterAwareUpdating.RunState
Examples
EXAMPLE 1
This example gets status information about the Updating Run currently in progress on the cluster called CONTOSO-FC1.
PS C:\> Get-CauRun -ClusterName CONTOSO-FC1