Export (0) Print
Expand All

Stop-CauRun

Windows Server 2012 R2 and Windows 8.1

Updated: August 19, 2013

Applies To: Windows PowerShell 4.0, Windows Server 2012 R2 Preview

Stop-CauRun

Stops an Updating Run that is in progress on a cluster.

Syntax

Parameter Set: Default
Stop-CauRun [[-ClusterName] <String> ] [-Credential <PSCredential> ] [-Force] [-Wait] [ <CommonParameters>]




Detailed Description

The Stop-CauRun cmdlet stops an Updating Run that is in progress on a failover cluster.

Parameters

-ClusterName<String>

Specifies the name of the cluster on which to stop an Updating Run that is in progress. 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

-Force

Runs the cmdlet without prompting for confirmation. By default the cmdlet will ask for confirmation from the user before proceeding.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Wait

Returns after the canceled Updating Run has completely finished. Otherwise, returns as soon as the stop request has been acknowledged by the current CAU Update Coordinator.


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.

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.

  • System.Boolean

Examples

EXAMPLE 1

This example stops the Updating Run that is being performed by the CAU Update Coordinator that is configured on the cluster named CONTOSO-FC1. The cmdlet waits to return until the canceled Updating Run has completely finished. The cmdlet runs without displaying confirmation prompts.


PS C:\> Stop-CauRun -ClusterName CONTOSO-FC1 -Wait -Force

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft