Website/docs/application/remote-desktop.md
With Remote Desktop you can connect to a remote computer using the Remote Desktop Protocol (RDP).
:::info
Remote Desktop Protocol (RDP) is a proprietary protocol developed by Microsoft that allows users to remotely access and control a computer or virtual machine (VM) over a network connection. It provides a secure communication channel by encrypting the data transmitted between the client and the remote computer, protecting it from unauthorized access.
:::
:::note
Right-click on the tab will open the context menu with the following options:
Adjust screen automatically or Use the current view size as screen size) (if connected).:::
Host to connect to via Remote Desktop.
Type: String
Default: Empty
Example:
server-01.borntoberoot.net10.0.0.10server-01.borntoberoot.net:338910.0.0.10:9999:::note
You can specify a custom port as follows: 10.0.0.10:9999
:::
Use credentials to authenticate with the remote computer.
Type: Boolean
Default: Disabled
Username to authenticate with the remote computer.
Type: String
Default: Empty
Example: Administrator
:::note
Only available if Use credentials is enabled.
:::
Domain to authenticate with the remote computer. This is optional.
Type: String
Default: Empty
Example: BORNTOBEROOT
:::note
Only available if Use credentials is enabled.
:::
Password to authenticate with the remote computer.
Type: String
Default: Empty
Example: P@ssw0rd
:::note
Only available if Use credentials is enabled.
:::
Connect to the admin (console) session of the remote computer.
Type: Boolean
Default: Disabled
Inherit the host from the general settings.
Type: Boolean
Default: Enabled
:::note
If this option is enabled, the Host is overwritten by the host from the general settings and the Host is disabled.
:::
Host to connect to via Remote Desktop.
Type: String
Default: Empty
Example:
server-01.borntoberoot.net10.0.0.10Use credentials to authenticate with the remote computer.
Type: Boolean
Default: Disabled
Username to authenticate with the remote computer.
Type: String
Default: Empty
Example: Administrator
:::note
Only available if Use credentials is enabled.
:::
Domain to authenticate with the remote computer. This is optional.
Type: String
Default: Empty
Example: BORNTOBEROOT
:::note
Only available if Use credentials is enabled.
:::
Password to authenticate with the remote computer.
Type: String
Default: Empty
Example: P@ssw0rd
:::note
Only available if Use credentials is enabled.
:::
:::warning
Passwords are stored in plain text in the profile file unless Profile file encryption is enabled.
:::
Connect to the admin (console) session of the remote computer.
Type: Boolean
Default: Disabled
Display setting used for the remote desktop connection.
Type: Boolean (RadioButtons)
Default: Use the current view size as screen size
Possible values:
Adjust screen automatically (Remote Desktop will adjust the screen size automatically when the window is resized.)Use the current view size as screen size (Remote Desktop will use the current view size as screen size, but will not adjust the screen size automatically when the window is resized.)Fixed screen size (Remote Desktop uses the fixed screen size selected in the drop-down list below.)
Possible values:
640x480800x6001024x7681280x7201280x7681280x8001280x10241360x7681440x9001440x10501680x10501920x1080Custom screen size (Remote Desktop uses the custom screen size that can be entered in the text fields below.)Color depth used for the remote desktop connection.
Type: Integer
Default: 32
Possible values:
15162432Port used for the remote desktop connection.
Type: Integer
Default: 3389
Use the Credential Security Support Provider (CredSSP) protocol to authenticate with the remote computer.
Type: Boolean
Default: Disabled
Authentication level used for the remote desktop connection.
Type: Integer
Default: 2 [Min 0, Max 3]
Possible values:
0 (If server authentication fails, connect to the computer without warning.)1 (If server authentication fails, do not establish a connection.)2 (If server authentication fails, show a warning and allow me to connect or refuse the connection.)3 (No authentication requirement is specified.)Enable the use of a gateway server for the remote desktop connection.
Type: Boolean
Default: Disabled
Hostname of the gateway server used for the remote desktop connection.
Type: String
Default: Empty
Example: gateway.borntoberoot.net
:::note
Only available if Enable gateway server is enabled.
:::
Bypass the gateway server for local addresses.
Type: Boolean
Default: Enabled
:::note
Only available if Enable gateway server is enabled.
:::
Logon method used for the gateway server.
Type: NETworkManager.Models.RemoteDesktop.GatewayUserSelectedCredsSource
Default: Allow me to select later
Possible values:
Ask for password (NTLM) (Userpass)
Smart card or Windows Hello for Business (Smartcard)
Allow me to select later (Any)
:::note
Only available if Enable gateway server is enabled.
:::
Share the gateway credentials with the remote computer.
Type: Boolean
Default: Enabled
:::note
Only available if Enable gateway server is enabled.
:::
Use credentials to authenticate with the gateway server.
Type: Boolean
Default: Disabled
:::note
Only available if Enable gateway server is enabled and Logon method is set to Ask for password (NTLM).
:::
Username to authenticate with the gateway server.
Type: String
Default: Empty
Example: Administrator
:::note
Only available if Enable gateway server is enabled, Logon method is set to Ask for password (NTLM) and Use gateway credentials is enabled.
:::
Domain to authenticate with the gateway server. This is optional.
Type: String
Default: Empty
Example: BORNTOBEROOT
:::note
Only available if Enable gateway server is enabled, Logon method is set to Ask for password (NTLM) and Use gateway credentials is enabled.
:::
Password to authenticate with the gateway server.
Type: String
Default: Empty
Example: P@ssw0rd
:::note
Only available if Enable gateway server is enabled, Logon method is set to Ask for password (NTLM) and Use gateway credentials is enabled.
:::
:::warning
Passwords are stored in plain text in the profile file unless Profile file encryption is enabled.
:::
Configure the remote audio playback for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.AudioRedirectionMode
Default: Play on remote computer
Possible values:
Play on this computerPlay on remote computerDo not playConfigure the remote audio recording for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.AudioCaptureRedirectionMode
Default: Do not record
Possible values:
Record from this computerDo not recordConfigure the Windows key combinations for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.KeyboardHookMode
Default: On the remote computer
Possible values:
On this computerOn the remote computerConfigure the clipboard redirection for the remote desktop connection.
Type: Boolean
Default: Enabled
Configure the device redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the drive redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the port redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the smartcard redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the printer redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the persistent bitmap caching for the remote desktop connection.
Type: Boolean
Default: Disabled
Automatically reconnect if the connection is dropped.
Type: Boolean
Default: Disabled
Configure the network connection type for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.NetworkConnectionType
Default: Detect connection quality automatically
Possible values:
Detect connection quality automaticallyModem (56 kbps)Low-speed broadband (256 kbps - 2 Mbps)Satellite (2 Mbps - 16 Mbps with high latency)High-speed broadband (2 Mbps - 10 Mbps)WAN (10 Mbps or higher with high latency)LAN (10 Mbps or higher)Use credentials to authenticate with the remote computer.
Type: Boolean
Default: Disabled
Username to authenticate with the remote computer.
Type: String
Default: Empty
Example: Administrator
:::note
Only available if Use credentials is enabled.
:::
Domain to authenticate with the remote computer. This is optional.
Type: String
Default: Empty
Example: BORNTOBEROOT
:::note
Only available if Use credentials is enabled.
:::
Password to authenticate with the remote computer.
Type: String
Default: Empty
Example: P@ssw0rd
:::note
Only available if Use credentials is enabled.
:::
:::warning
Passwords are stored in plain text in the profile file unless Profile file encryption is enabled.
:::
Connect to the admin (console) session of the remote computer.
Type: Boolean
Default: Disabled
Display setting used for the remote desktop connection.
Type: Boolean (RadioButtons)
Default: Use the current view size as screen size
Possible values:
Adjust screen automatically (Remote Desktop will adjust the screen size automatically when the window is resized.)Use the current view size as screen size (Remote Desktop will use the current view size as screen size, but will not adjust the screen size automatically when the window is resized.)Fixed screen size (Remote Desktop uses the fixed screen size selected in the drop-down list below.)
Possible values:
640x480800x6001024x7681280x7201280x7681280x8001280x10241360x7681440x9001440x10501680x10501920x1080Custom screen size (Remote Desktop uses the custom screen size that can be entered in the text fields below.)Color depth used for the remote desktop connection.
Type: Integer
Default: 32
Possible values:
15162432Port used for the remote desktop connection.
Type: Integer
Default: 3389
Use the Credential Security Support Provider (CredSSP) protocol to authenticate with the remote computer.
Type: Boolean
Default: Disabled
Authentication level used for the remote desktop connection.
Type: Integer
Default: 2 [Min 0, Max 3]
Possible values:
0 (If server authentication fails, connect to the computer without warning.)1 (If server authentication fails, do not establish a connection.)2 (If server authentication fails, show a warning and allow me to connect or refuse the connection.)3 (No authentication requirement is specified.)Enable the use of a gateway server for the remote desktop connection.
Type: Boolean
Default: Disabled
Hostname of the gateway server used for the remote desktop connection.
Type: String
Default: Empty
Example: gateway.borntoberoot.net
:::note
Only available if Enable gateway server is enabled.
:::
Bypass the gateway server for local addresses.
Type: Boolean
Default: Enabled
:::note
Only available if Enable gateway server is enabled.
:::
Logon method used for the gateway server.
Type: NETworkManager.Models.RemoteDesktop.GatewayUserSelectedCredsSource
Default: Allow me to select later
Possible values:
Ask for password (NTLM) (Userpass)
Smart card or Windows Hello for Business (Smartcard)
Allow me to select later (Any)
:::note
Only available if Enable gateway server is enabled.
:::
Share the gateway credentials with the remote computer.
Type: Boolean
Default: Enabled
:::note
Only available if Enable gateway server is enabled.
:::
Use credentials to authenticate with the gateway server.
Type: Boolean
Default: Disabled
:::note
Only available if Enable gateway server is enabled and Logon method is set to Ask for password (NTLM).
:::
Username to authenticate with the gateway server.
Type: String
Default: Empty
Example: Administrator
:::note
Only available if Enable gateway server is enabled, Logon method is set to Ask for password (NTLM) and Use gateway credentials is enabled.
:::
Domain to authenticate with the gateway server. This is optional.
Type: String
Default: Empty
Example: BORNTOBEROOT
:::note
Only available if Enable gateway server is enabled, Logon method is set to Ask for password (NTLM) and Use gateway credentials is enabled.
:::
Password to authenticate with the gateway server.
Type: String
Default: Empty
Example: P@ssw0rd
:::note
Only available if Enable gateway server is enabled, Logon method is set to Ask for password (NTLM) and Use gateway credentials is enabled.
:::
:::warning
Passwords are stored in plain text in the profile file unless Profile file encryption is enabled.
:::
Configure the remote audio playback for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.AudioRedirectionMode
Default: Play on remote computer
Possible values:
Play on this computerPlay on remote computerDo not playConfigure the remote audio recording for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.AudioCaptureRedirectionMode
Default: Do not record
Possible values:
Record from this computerDo not recordConfigure the Windows key combinations for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.KeyboardHookMode
Default: On the remote computer
Possible values:
On this computerOn the remote computerConfigure the clipboard redirection for the remote desktop connection.
Type: Boolean
Default: Enabled
Configure the device redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the drive redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the port redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the smartcard redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the printer redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the persistent bitmap caching for the remote desktop connection.
Type: Boolean
Default: Disabled
Automatically reconnect if the connection is dropped.
Type: Boolean
Default: Disabled
Configure the network connection type for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.NetworkConnectionType
Default: Detect connection quality automatically
Possible values:
Detect connection quality automaticallyModem (56 kbps)Low-speed broadband (256 kbps - 2 Mbps)Satellite (2 Mbps - 16 Mbps with high latency)High-speed broadband (2 Mbps - 10 Mbps)WAN (10 Mbps or higher with high latency)LAN (10 Mbps or higher)Display setting used for the remote desktop connection.
Type: Boolean (RadioButtons)
Default: Use the current view size as screen size
Possible values:
Adjust screen automatically (Remote Desktop will adjust the screen size automatically when the window is resized.)Use the current view size as screen size (Remote Desktop will use the current view size as screen size, but will not adjust the screen size automatically when the window is resized.)Fixed screen size (Remote Desktop uses the fixed screen size selected in the drop-down list below.)
Possible values:
640x480800x6001024x7681280x7201280x7681280x8001280x10241360x7681440x9001440x10501680x10501920x1080Custom screen size (Remote Desktop uses the custom screen size that can be entered in the text fields below.)Color depth used for the remote desktop connection.
Type: Integer
Default: 32
Possible values:
15162432Port used for the remote desktop connection.
Type: Integer
Default: 3389
Use the Credential Security Support Provider (CredSSP) protocol to authenticate with the remote computer.
Type: Boolean
Default: Disabled
Authentication level used for the remote desktop connection.
Type: Integer
Default: 2 [Min 0, Max 3]
Possible values:
0 (If server authentication fails, connect to the computer without warning.)1 (If server authentication fails, do not establish a connection.)2 (If server authentication fails, show a warning and allow me to connect or refuse the connection.)3 (No authentication requirement is specified.)Enable the use of a gateway server for the remote desktop connection.
Type: Boolean
Default: Disabled
Hostname of the gateway server used for the remote desktop connection.
Type: String
Default: Empty
Example: gateway.borntoberoot.net
:::note
Only available if Enable gateway server is enabled.
:::
Bypass the gateway server for local addresses.
Type: Boolean
Default: Enabled
:::note
Only available if Enable gateway server is enabled.
:::
Logon method used for the gateway server.
Type: NETworkManager.Models.RemoteDesktop.GatewayUserSelectedCredsSource
Default: Allow me to select later
Possible values:
Ask for password (NTLM) (Userpass)
Smart card or Windows Hello for Business (Smartcard)
Allow me to select later (Any)
:::note
Only available if Enable gateway server is enabled.
:::
Share the gateway credentials with the remote computer.
Type: Boolean
Default: Enabled
:::note
Only available if Enable gateway server is enabled.
:::
Configure the remote audio playback for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.AudioRedirectionMode
Default: Play on remote computer
Possible values:
Play on this computerPlay on remote computerDo not playConfigure the remote audio recording for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.AudioCaptureRedirectionMode
Default: Do not record
Possible values:
Record from this computerDo not recordConfigure the Windows key combinations for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.KeyboardHookMode
Default: On the remote computer
Possible values:
On this computerOn the remote computerConfigure the clipboard redirection for the remote desktop connection.
Type: Boolean
Default: Enabled
Configure the device redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the drive redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the port redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the smartcard redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the printer redirection for the remote desktop connection.
Type: Boolean
Default: Disabled
Configure the persistent bitmap caching for the remote desktop connection.
Type: Boolean
Default: Disabled
Automatically reconnect if the connection is dropped.
Type: Boolean
Default: Disabled
Configure the network connection type for the remote desktop connection.
Type: NETworkManager.Models.RemoteDesktop.NetworkConnectionType
Default: Detect connection quality automatically
Possible values:
Detect connection quality automaticallyModem (56 kbps)Low-speed broadband (256 kbps - 2 Mbps)Satellite (2 Mbps - 16 Mbps with high latency)High-speed broadband (2 Mbps - 10 Mbps)WAN (10 Mbps or higher with high latency)LAN (10 Mbps or higher)