| title | Status Option in Admin Tool | |
|---|---|---|
| titleSuffix | SQL Server Distributed Replay | |
| description | This article describes the status command-line option and syntax of the SQL Server Distributed Replay administration tool, which displays the current status. | |
| author | rwestMSFT | |
| ms.author | randolphwest | |
| ms.reviewer | mikeray | |
| ms.date | 06/20/2022 | |
| ms.service | sql | |
| ms.subservice | distributed-replay | |
| ms.topic | conceptual | |
| ms.collection |
|
|
| monikerRange | >=sql-server-2016 || >=sql-server-linux-2017 |
[!INCLUDE sqlserver2016-2019-only]
[!INCLUDE distributed-replay-sql-server-2022]
The Microsoft [!INCLUDEssNoVersion] 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 status command-line option and corresponding syntax.
The status option queries the controller and displays the current status.
:::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 status [-m controller] [-f status_interval]
-m controller
Specifies 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.
-f status_interval
Specifies the frequency (in seconds) at which to display the status.
If the -f parameter isn't specified, the default interval is 30 seconds.
In the following example, the current status is displayed every 60 seconds. The value localhost indicates that the controller service is running on the same computer as the administration tool.
dreplay status -m localhost -f 60
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.