Cancel Option (Distributed Replay Administration Tool)

Applies to: SQL Server 2016 (13.x), SQL Server 2017 (14.x), and SQL Server 2019 (15.x)

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.

For more information about the syntax conventions that are used with the administration tool syntax, see Transact-SQL syntax conventions.

Syntax

dreplay cancel [-m controller] [-q]   

Parameters

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

Examples

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  

Permissions

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.

See also

• SQL Server Distributed Replay