Get-CauRun
Retrieves status information about an Updating Run currently in progress.
Syntax
Get-CauRun
[[-ClusterName] <String>]
[-Credential <PSCredential>]
Get-CauRun
[[-ClusterName] <String>]
[-Credential <PSCredential>]
[-WaitForCompletion]
Get-CauRun
[[-ClusterName] <String>]
[-Credential <PSCredential>]
[-ShowClusterNodeState]
Get-CauRun
[[-ClusterName] <String>]
[-Credential <PSCredential>]
[-WaitForStart]
Description
The Get-CauRun cmdlet retrieves status information about an Updating Run currently in progress. Use this cmdlet to monitor current Updating Runs.
Examples
EXAMPLE 1
PS C:\> Get-CauRun -ClusterName CONTOSO-FC1
RunId : 834dd11e-584b-41f2-8d22-4c9c0471dbad
RunStartTime : 10/13/2011 1:35:39 PM
CurrentOrchestrator : NODE1
NodeStatusNotifications : {
Node : NODE1
Status : Waiting
Timestamp : 10/13/2011 1:35:49 PM
}
NodeResults : {
Node : NODE2
Status : Succeeded
ErrorRecordData :
NumberOfSucceededUpdates : 0
NumberOfFailedUpdates : 0
InstallResults : Microsoft.ClusterAwareUpdating.UpdateInstallResult[]
}
This example gets status information about the Updating Run currently in progress on the cluster called CONTOSO-FC1.
Parameters
-ClusterName
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.
Type: | String |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
Specifies the administrative credentials for the target cluster.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
Microsoft.ClusterAwareUpdating.CauRun
Microsoft.ClusterAwareUpdating.RunState
Related Links
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for