Stop-Cau
Run
Syntax
Stop-CauRun
[[-ClusterName] <String>]
[-Credential <PSCredential>]
[-Wait]
[-Force]
[<CommonParameters>]
Description
The Stop-CauRun cmdlet stops an updating run that is in progress on a failover cluster.
Examples
Example 1: Stop an updating run on the specified cluster
PS C:\> Stop-CauRun -ClusterName "CONTOSO-FC1" -Wait -Force
This command 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 finished. Because the command specifies the Force parameter, the cmdlet runs without displaying confirmation prompts.
Optional Parameters
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: | 0 |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Specifies the administrative credentials for the target cluster.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Forces the command to run without asking for user confirmation.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Indicates that the cmdlet waits until after the canceled updating run has finished. Otherwise, returns as soon as the stop request has been acknowledged by the current Cluster-Aware Updating (CAU) Update Coordinator.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
None
Outputs
System.Boolean