Edit

Administration Tool Command-line Options (Distributed Replay Utility)

  • Article

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

Important

SQL Server Distributed Replay is not available with SQL Server 2022 (16.x).

The Microsoft SQL Server Distributed Replay administration tool, DReplay.exe, is a command-line tool to communicate with the distributed replay controller. Use the administration tool to initiate, monitor, and cancel operations 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 {preprocess|replay|status|cancel} [options] [-?]}

Usage:

  dreplay preprocess [-m controller] -i input_trace_file  
    -d controller_working_dir [-c config_file] [-f status_interval]

  dreplay replay [-m controller] -d controller_working_dir [-o]  
    [-s target_server] -w clients [-c config_file]  
    [-f status_interval]

  dreplay status [-m controller] [-f status_interval]

  dreplay cancel [-m controller] [-q]

Remarks

You can issue the following command-line options with DReplay.exe:

preprocess
Initiates the preprocess stage. The controller prepares the input trace data, which you captured from the production environment, for replay against the target server.

replay
Initiates the event replay stage. The controller dispatches replay data to the specified clients, launches the distributed replay, and synchronizes the clients. Optionally, each client that was selected records the replay activity and saves result trace files locally.

status
Queries the controller and displays the current status.

cancel
Cancels the current operation that is running on the controller.

For detailed syntax information that includes the command arguments and examples, see the following topics:

RPCs are replayed as RPCs and not as language events.

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