Events
May 19, 6 PM - May 23, 12 AM
Calling all developers, creators, and AI innovators to join us in Seattle @Microsoft Build May 19-22.
Register todayThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
Tip
This article is shared for services and products that use the Remote Desktop Protocol (RDP) to provide remote access to Windows desktops and apps.
The Remote Desktop Protocol (RDP) has a number of properties you can set to customize the behavior of a remote session, such as for device redirection, display settings, session behavior, and more.
The following sections contain each RDP property available and lists its syntax, description, supported values, the default value, and connections to which services and products you can use them with.
How you use these RDP properties depends on the service or product you're using:
Product | Configuration point |
---|---|
Azure Virtual Desktop | Host pool RDP properties. To learn more, see Customize RDP properties for a host pool. |
Remote Desktop Services | Session collection RDP properties |
Remote PC connections | The .rdp file you use to connect to a remote PC. |
Note
For each RDP property, replace <value>
with an allowed value for that property.
Here are the RDP properties that you can use to configure connections.
alternate full address:s:<value>
alternate shell:s:<value>
C:\Program Files\MyApp\myapp.exe
.authentication level:i:<value>
0
: If server authentication fails, connect to the computer without warning.1
: If server authentication fails, don't establish a connection.2
: If server authentication fails, show a warning, and choose to connect or refuse the connection.3
: No authentication requirement specified.3
disableconnectionsharing:i:<value>
0
: Reconnect to any existing session.1
: Initiate new connection.0
domain:s:<value>
CONTOSO
.enablecredsspsupport:i:<value>
0
: RDP won't use CredSSP, even if the operating system supports CredSSP.1
: RDP will use CredSSP if the operating system supports CredSSP.1
enablerdsaadauth:i:<value>
targetisaadjoined
.0
: Connections won't use Microsoft Entra authentication, even if the remote PC supports it.1
: Connections will use Microsoft Entra authentication if the remote PC supports it.0
full address:s:<value>
.rdp
file.gatewaycredentialssource:i:<value>
0
: Ask for password (NTLM).1
: Use smart card.2
: Use the credentials for the currently signed in user.3
: Prompt the user for their credentials and use basic authentication.4
: Allow user to select later.5
: Use cookie-based authentication.0
gatewayhostname:s:<value>
gatewayprofileusagemethod:i:<value>
0
: Use the default profile mode, as specified by the administrator.1
: Use explicit settings, as specified by the user.0
gatewayusagemethod:i:<value>
0
: Don't use a Remote Desktop gateway.1
: Always use a Remote Desktop gateway.2
: Use a Remote Desktop gateway if a direct connection can't be made to the RD Session Host.3
: Use the default Remote Desktop gateway settings.4
: Don't use a Remote Desktop gateway, bypass gateway for local addresses.0
or 4
are effectively equivalent, but 4
enables the option to bypass local addresses.0
kdcproxyname:s:<value>
kdc.contoso.com
.promptcredentialonce:i:<value>
0
: Remote session doesn't use the same credentials.1
: Remote session does use the same credentials.1
targetisaadjoined:i:<value>
enablerdsaadauth
.0
: Connections to Microsoft Entra joined session hosts will succeed for Windows devices that meet the requirements, but other connections will fail.1
: Connections to Microsoft Entra joined hosts will succeed but are restricted to entering user name and password credentials when connecting to session hosts.0
username:s:<value>
Here are the RDP properties that you can use to configure session behavior.
autoreconnection enabled:i:<value>
0
: The local device doesn't automatically try to reconnect.1
: The local device automatically tries to reconnect.1
bandwidthautodetect:i:<value>
0
: Don't use automatic network bandwidth detection.1
: Use automatic network bandwidth detection.1
compression:i:<value>
0
: Disable bulk compression.1
: Enable RDP bulk compression.1
networkautodetect:i:<value>
0
: Disable automatic network type detection.1
: Enable automatic network type detection.1
videoplaybackmode:i:<value>
0
: Don't use RDP efficient multimedia streaming for video playback.1
: Use RDP-efficient multimedia streaming for video playback when possible.1
Here are the RDP properties that you can use to configure device redirection. To learn more, see Redirection over the Remote Desktop Protocol.
audiocapturemode:i:<value>
0
: Disable audio capture from a local device.1
: Enable audio capture from a local device and redirect it to a remote session.0
To learn how to use this property, see Configure audio and video redirection over the Remote Desktop Protocol.
audiomode:i:<value>
0
: Play sounds on the local device.1
: Play sounds in a remote session.2
: Don't play sounds.0
To learn how to use this property, see Configure audio and video redirection over the Remote Desktop Protocol.
camerastoredirect:s:<value>
KSCATEGORY_VIDEO_CAMERA
interfaces of cameras enabled for redirection.*
: Redirect all cameras.\\?\usb#vid_0bda&pid_58b0&mi
: Specifies a list of cameras by device instance path, such as this example.-
: Exclude a specific camera by prepending the symbolic link string.To learn how to use this property, see Configure camera, webcam, and video capture redirection over the Remote Desktop Protocol.
devicestoredirect:s:<value>
*
: Redirect all supported devices, including ones that are connected later.\\?\usb#vid_0bda&pid_58b0&mi
: Specifies a list of MTP or PTP peripherals by device instance path, such as this example.DynamicDevices
: Redirect all supported devices that are connected later.*
To learn how to use this property, see Configure Media Transfer Protocol and Picture Transfer Protocol redirection on Windows over the Remote Desktop Protocol.
drivestoredirect:s:<value>
*
: Redirect all drives, including drives that are connected later.DynamicDrives
: Redirect any drives that are connected later.drivestoredirect:s:C:\;E:\;
: Redirect the specified drive letters for one or more drives, such as this example.*
To learn how to use this property, see Configure fixed, removable, and network drive redirection over the Remote Desktop Protocol.
encode redirected video capture:i:<value>
0
: Disable encoding of redirected video.1
: Enable encoding of redirected video.1
To learn how to use this property, see Configure camera, webcam, and video capture redirection over the Remote Desktop Protocol.
keyboardhook:i:<value>
0
: Windows key combinations are applied on the local device.1
: (Desktop sessions only) Windows key combinations are applied on the remote computer when in focus.2
: (Desktop sessions only) Windows key combinations are applied on the remote computer in full screen mode only.3
: (RemoteApp sessions only) Windows key combinations are applied on the RemoteApp when in focus. We recommend you use this value only when publishing the Remote Desktop Connection app (mstsc.exe
) from the host pool on Azure Virtual Desktop. This value is only supported when using the Windows client.2
redirectclipboard:i:<value>
0
: Clipboard on local device isn't available in remote session.1
: Clipboard on local device is available in remote session.1
To learn how to use this property, see Configure clipboard redirection over the Remote Desktop Protocol.
redirectcomports:i:<value>
0
: Serial or COM ports on the local device aren't available in a remote session.1
: Serial or COM ports on the local device are available in a remote session.1
To learn how to use this property, see Configure serial or COM port redirection over the Remote Desktop Protocol.
redirected video capture encoding quality:i:<value>
0
: High compression video. Quality may suffer when there's a lot of motion.1
: Medium compression.2
: Low compression video with high picture quality.0
To learn how to use this property, see Configure camera, webcam, and video capture redirection over the Remote Desktop Protocol.
redirectlocation:i:<value>
0
: A remote session uses the location of the remote computer or virtual machine.1
: A remote session uses the location of the local device.0
To learn how to use this property, see Configure location redirection over the Remote Desktop Protocol.
redirectprinters:i:<value>
0
: The printers on the local device aren't redirected to a remote session.1
: The printers on the local device are redirected to a remote session.1
To learn how to use this property, see Configure printer redirection over the Remote Desktop Protocol.
redirectsmartcards:i:<value>
0
: Smart cards on the local device aren't redirected to a remote session.1
: Smart cards on the local device are redirected a remote session.1
To learn how to use this property, see Configure smart card redirection over the Remote Desktop Protocol.
redirectwebauthn:i:<value>
0
: WebAuthn requests from a remote session aren't sent to the local device for authentication and must be completed in the remote session.1
: WebAuthn requests from a remote session are sent to the local device for authentication.1
To learn how to use this property, see Configure WebAuthn redirection over the Remote Desktop Protocol.
usbdevicestoredirect:s:<value>
*
: Redirect all USB devices that aren't already redirected by high-level redirection.{*Device Setup Class GUID*}
: Redirect all devices that are members of the specified device setup class.*USBInstanceID*
: Redirect a specific USB device identified by the instance ID.*
To learn how to use this property, see Configure USB redirection on Windows over the Remote Desktop Protocol.
Here are the RDP properties that you can use to configure display settings.
desktop size id:i:<value>
desktopheight
and desktopwidth
are specified.0
: 640×4801
: 800×6002
: 1024×7683
: 1280×10244
: 1600×1200desktopheight:i:<value>
200
and 8192
.desktopscalefactor:i:*value*
100
, 125
, 150
, 175
, 200
, 250
, 300
, 400
, 500
Note
The desktopscalefactor
property is being deprecated and will soon be unavailable.
desktopwidth:i:<value>
200
and 8192
.dynamic resolution:i:<value>
0
: Session resolution remains static during the session.1
: Session resolution updates as the local window resizes.1
maximizetocurrentdisplays:i:<value>
use multimon
set to 1
. Only available on Windows App for Windows and the Remote Desktop app for Windows.0
: Session is full screen on the displays initially selected when maximizing.1
: Session dynamically is full screen on the displays the session window spans when maximizing.0
screen mode id:i:<value>
1
: A remote session appears in a window.2
: A remote session appears full screen.2
selectedmonitors:s:<value>
use multimon
set to 1
. Only available on Windows App for Windows, the Remote Desktop app for Windows, and the inbox Remote Desktop Connection app on Windows.mstsc.exe /l
from the command line. The first ID listed is set as the primary display in a remote session.singlemoninwindowedmode:i:<value>
use multimon
set to 1. Only available on Windows App for Windows and the Remote Desktop app for Windows.0
: A remote session retains all displays when exiting full screen.1
: A remote session switches to a single display when exiting full screen.0
smart sizing:i:<value>
0
: The local window content doesn't scale when resized.1
: The local window content does scale when resized.0
use multimon:i:<value>
0
: A remote session uses a single display.1
: A remote session uses multiple displays.1
Here are the RDP properties that you can use to configure RemoteApp behavior for Remote Desktop Services.
remoteapplicationcmdline:s:<value>
remoteapplicationexpandcmdline:i:<value>
0
: Environment variables should be expanded to the values of the local device.1
: Environment variables should be expanded to the values of the remote session.1
remoteapplicationexpandworkingdir:i:<value>
0
: Environment variables should be expanded to the values of the local device.1
: Environment variables should be expanded to the values of the remote session.1
remoteapplicationfile:s:<value>
remoteapplicationicon:s:<value>
.ico
files are supported..ico
file.remoteapplicationmode:i:<value>
0
: Don't launch a RemoteApp session.1
: Launch a RemoteApp session.1
remoteapplicationname:s:<value>
Microsoft Excel
.remoteapplicationprogram:s:<value>
EXCEL
.Events
May 19, 6 PM - May 23, 12 AM
Calling all developers, creators, and AI innovators to join us in Seattle @Microsoft Build May 19-22.
Register today