| title | Cancel Option Admin Tool | |
|---|---|---|
| titleSuffix | SQL Server Distributed Replay | |
| description | This article describes the cancel command-line option and syntax of the SQL Server Distributed Replay administration tool. | |
| author | rwestMSFT | |
| ms.author | randolphwest | |
| ms.reviewer | mikeray | |
| ms.date | 06/20/2022 | |
| ms.service | sql | |
| ms.subservice | distributed-replay | |
| ms.topic | how-to | |
| ms.collection |
|
|
| monikerRange | >=sql-server-2016 || >=sql-server-linux-2017 |
[!INCLUDE sqlserver2016-2019-only]
[!INCLUDE distributed-replay-sql-server-2022]
The Microsoft SQL Server Distributed Replay administration tool, DReplay.exe, is a command-line tool that you can use to communicate with the distributed replay controller. This topic describes the cancel command-line option and corresponding syntax.
The cancel option cancels the current operation that is running on the controller.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: For more information about the syntax conventions that are used with the administration tool syntax, see Transact-SQL syntax conventions.
dreplay cancel [-m controller] [-q]
-m controller
The computer name of the controller. You can use "localhost" or "." to refer to the local computer.
If the -m parameter isn't specified, the local computer is used.
-q
Quiet mode. Doesn't prompt for confirmation.
The -q parameter is optional.
In the following example, a cancel request is submitted in quiet mode. The value localhost indicates that the controller service is running on the same computer as the administration tool.
dreplay cancel -m localhost -q
You must run the administration tool as an interactive user, as either a local user or a domain user account. To use a local user account, the administration tool and controller must be running on the same computer.
For more information, see Distributed Replay Security.