Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Stop-CauRun

Stop-CauRun

clusterawareupdating.dll

Synopsis

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

Syntax

Stop-CauRun [-ClusterName] [-Credential] [-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 <SwitchParameter>

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 <SwitchParameter>

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

Input Type

None

Return Type

System.Boolean

Notes

None

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

Online Version
Get-CauRun
Invoke-CauRun