Stop-CauRun
Stops an updating run that is in progress on a cluster.
Syntax
Default (Default)
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
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.
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 isn't run on a failover cluster node, or this cmdlet is used to reference a failover cluster different from where the cmdlet is run.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Credential
Specifies the administrative credentials for the target cluster.
Parameter properties
| Type: | PSCredential |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Forces the command to run without asking for user confirmation.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Wait
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.