Edit

Share via

Get-CauRun

Module:
ClusterAwareUpdating Module

Gets status information about an updating run currently in progress.

Syntax

DefaultParamSet (Default) 

Get-CauRun
    [[-ClusterName] <String>]
    [-Credential <PSCredential>]
    [<CommonParameters>]

WaitForStart 

Get-CauRun
    [[-ClusterName] <String>]
    [-Credential <PSCredential>]
    [-WaitForStart]
    [<CommonParameters>]

WaitForCompletion 

Get-CauRun
    [[-ClusterName] <String>]
    [-Credential <PSCredential>]
    [-WaitForCompletion]
    [<CommonParameters>]

ShowClusterNodeState 

Get-CauRun
    [[-ClusterName] <String>]
    [-Credential <PSCredential>]
    [-ShowClusterNodeState]
    [<CommonParameters>]

Description

The Get-CauRun cmdlet gets status information about an updating run currently in progress. Use this cmdlet to monitor current updating runs.

Examples

Example 1: Get status information about the updating run in progress from the specified cluster

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 command gets status information about the updating run currently in progress on the cluster named CONTOSO-FC1.

Parameters

-ClusterName

Specifies the name of the cluster for which this cmdlet gets the updating run status. This parameter is only required when this cmdlet isn't run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Credential

Specifies the administrative credentials for the target cluster.

Parameter properties

Type:PSCredential
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ShowClusterNodeState

Indicates that this cmdlet gets the status of the Windows Management Instrumentation (WMI) object that is created on each cluster node. This can be used to debug the status of leftover objects.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ShowClusterNodeState
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WaitForCompletion

Indicates that this cmdlet waits for the updating run to finish. If this parameter is specified, the cmdlet also writes the updated CAU run objects to the output stream as progress is recorded by the current CAU Update Coordinator.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

WaitForCompletion
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WaitForStart

Indicates that this cmdlet waits for an updating run that is in progress on the specified cluster. Otherwise the cmdlet waits for an updating run to begin.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

WaitForStart
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.ClusterAwareUpdating.CauRun

Microsoft.ClusterAwareUpdating.RunState