Stop-CauRun

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

Syntax

Stop-CauRun
    [[-ClusterName] <String>]
    [-Credential <PSCredential>]
    [-Force]
    [-Wait]

Description

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

Examples

EXAMPLE 1

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

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.

Optional Parameters

-ClusterName

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.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies the administrative credentials for the target cluster.

Type:PSCredential
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.

Type:SwitchParameter
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.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

Outputs

System.Boolean