Share via


Remote Windows Development listening endpoint (wdEndpoint.exe)

Important

The Xbox PC Toolbox app is in preview. To learn more, contact your Microsoft representative.

Remote Windows Development listening endpoint (wdEndpoint.exe) runs on a remote Windows device and accepts commands from the wdRemote command-line tool on a development PC. Together, these tools support two key workflows for building games on remote Windows devices:

  • Establish a trusted, secure connection between a development PC and a remote device using PIN pairing.
  • Deploy, launch and terminate games on a remote Windows device.

For an overview of how wdRemote and wdEndpoint work in the Windows remote development toolset, see Overview of Remote Windows Development tools.

Install wdEndpoint.exe

You can install wdEndpoint.exe with either the Xbox PC Toolbox or WinGet:

winget install Microsoft.Gaming.RemoteIterationEndpoint

When you install wdEndpoint with Xbox PC Toolbox, it starts automatically when a user signs in to the target device. If you install it using WinGet, start it manually. Run wdEndpoint as a non-administrator to accept commands from wdRemote.

wdEndpoint Commands

wdRemote provides the following commands.

Command Description
wdEndpoint /createKeys Creates the security keys required to enable encryption and device pairing.
wdEndpoint /purgeKeys Removes all security keys and device pairings from the target device.
wdEndpoint /createPin Creates a PIN used for pairing.
wdEndpoint /pair Pairs a remote Windows device with a development PC.

wdEndpoint /createKeys

Communication between wdRemote and wdEndpoint is encrypted. Use the wdEndpoint /createkeys command to generate the security keys needed for encryption and pairing.

Note

wdEndpoint /createkeys requires administrator permissions on the target device.

wdEndpoint /createkeys

Return to the top of this topic.

wdEndpoint /purgekeys

Removes all security keys and device pairings from a target device.

Note

wdEndpoint /purgekeys requires administrator permissions on the target device.

wdEndpoint /purgekeys

Return to the top of this topic.

wdEndpoint /createPin

Creates a PIN used for pairing. Use this PIN as an argument with the /pair command.

wdEndpoint /createPin

Return to the top of this topic.

wdEndpoint /pair

Pairs a remote Windows device with a development PC. You can pair in two ways:

  1. Run wdEndpoint /pair without a PIN. The command generates and displays a PIN, then waits for the PIN to be returned from the development PC. If the PIN isn't returned within two minutes, wdEndpoint ends the pairing process.
  2. Run wdEndpoint /pair with a PIN. This mode doesn’t block or wait— it starts pairing immediately. Create the PIN for the /pair command by using the /createPin option.

Note

wdEndpoint /pair requires administrator permissions on the target device.

wdEndpoint /pair[PIN]

Option Description
/pair:[PIN] The PIN to use when pairing in non-blocking mode.

Return to the top of this topic.

See also

wdRemote
Remote Windows development tools