Remote Server Syntax

To start the server side of the Remote tool, use the following syntax at the command line.

remote /s Command SessionName [/f Color] [/b] [/u User [/u User...]] [/ud User [/ud User...]] [/v | /-v]

Parameters

/s
Starts a server session.

Command
Specifies the command that starts the console-based program. The command can include parameters. If the command includes spaces, enclose it in quotation marks.

SessionName
Assigns a name to the remote session. If the name includes spaces, enclose it in quotation marks. This parameter is not case-sensitive.

/f
Specifies the color of the text in the server command window.

/b
Specifies the background color of the server command window.

Color
Specifies a color. Valid values are black, blue, green, cyan, red, purple, yellow, white, lblack, lblue, lgreen, lred, lpurple, lyellow, and lwhite.

/u
Specifies users or groups that are permitted to connect to the remote session; by default, everyone is permitted. When you use this parameter, everyone is denied permission, except for the users and groups specified by the User subparameter.

/ud
Specifies users or groups that are denied permission to connect to the remote session; by default, no one is denied permission.

User
Specifies the name of a user or group in [domain | computer]\{user | group} format. When specifying users or groups on the local computer, omit the computer name.

/v
Makes a session visible. For more information, see Visible Session.

By default, only debugger sessions are visible, that is, sessions in which the value of the Command parameter include the words kd, dbg, remoteds, ntsd, or cdb; otherwise, the session is not visible.

-v
Makes a remote debugger session invisible. For more information, see Visible Session.

Comments

The Command and SessionName parameters must appear in the order shown on the syntax line.

To end a remote session, type @k. For more information, see Remote Session Commands.

The Remote tool will not create a session that the current user does not have permission to join.

When starting more than one remote session on a single computer, open a new command window for each session. Also, use a different session name for each session. Because the session names are used to label the named pipes, they must be unique on the computer.

Sample Usage

remote /s "i386kd -v" TestSession
remote /s "cmd" "My Remote Session" /f white /b black /u Server01\Administrators
remote /s "ntsd -d -g -x" DebugIt /-v
remote /q Server01

Send comments about this topic to Microsoft