Get-CauRun

Get-CauRun

Gets 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 gets 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 this cmdlet gets 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

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

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

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: Get status information about the updating run in progress from the specified cluster

This command gets status information about the updating run currently in progress on the cluster named CONTOSO-FC1.


PS C:\> Get-CauRun -ClusterName "CONTOSO-FC1"

Related topics

Community Additions

ADD
Show: