The IGEL Remote Desktop app enables users to establish Remote Desktop Protocol (RDP) connections to local RDP environments. It uses the IGEL Remote Desktop Core to provide the underlying RDP functionality.
This article describes the available configuration options for the IGEL Remote Desktop app and its RDP sessions. For more information on the IMH Published App sessions, see Configuration of IGEL Remote Desktop for IMH Published Apps.
This article is based on IGEL Remote Desktop version 1.4.0 BUILD 1.0.
Requirements
-
IGEL Remote Desktop app is imported to your IGEL UMS. For details on app import, see How to Import IGEL OS Apps from the IGEL App Portal.
How to Create a RDP Session
-
In the IGEL UMS, create a profile configuring the app. For details on profile creation, see How to Create and Assign Profiles in the IGEL UMS Web App.
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions.
-
Click
to add a new session.
-
Define the starting methods for the session. The starting method parameters are described under Starting Methods for Apps.
-
Configure the session according to your needs; for details, see below.
-
Save the settings.
-
Assign the profile to the required devices.
Configuring the Logon
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Logon.
-
Edit the settings according to your needs. The parameters are described in the following.
Enable Single Sign-On
- The login data saved temporarily when logging in to the device will be used for the user name and password for the RDP Session. This option can be used if the local device login takes place via Kerberos or UMS as Identity Broker. (Default)
For more information on configuring the supported authentication methods in IGEL OS 12, see UMS as Identity Broker with IGEL OS 12 or Active Directory/Kerberos - Enable Login in IGEL OS 12
Login to Azure AD
- Azure AD is prepended to the username.
- Azure AD is not prepended to the username. (Default)
Server
Hostname, fully qualified domain name (FQDN), or IP address of the server.
Changeable server address on local login
- The user can overwrite the preset server address during local login.
- The preset server address cannot be overwritten during local login. (Default)
Collection
Specifies the name of the RDP session collection to connect to or the full routing token.
Enter the collection name or a full routing token beginning with tsv://....
Command
Specifies a program to start automatically when you connect to a remote computer using the alternate shell RDP property. The program replaces the desktop session.
Shell working directory
Specifies the working directory on the remote computer for the alternate shell specified in Command.
Use this setting together with Command when the alternate shell must start from a particular directory.
Username or username@domain or @domain
A username or a preset domain name used for automatic connection to the RDP session. The string after "@" is taken as a preset domain name.
Example:
user@your.domain.com: To log in, the user does not need to enter the username and the domain name.
@your.domain.com: To log in, the user only needs to enter the username. The preset domain – your.domain.com – will automatically be appended.
Overwriting the Preset Domain Name
Use the following registry key to specify whether the user should be able to overwrite the preset domain, e.g. with username@other-domain.com:
|
Path |
System > Registry |
|
Registry |
|
|
Value |
enabled / disabled (Default) |
|
Note |
If enabled: the domain entered by the user is accepted.
|
Domain
Windows domain
Password
The password used for the automatic connection to the RDP session.
If the Login Credentials Should Not Be Applied Automatically
You can use the following registry key to always prompt for a user name and password or only for a password when connecting to an RDP session:
|
Path |
System > Registry |
|
Parameter |
Always prompt for username and password upon session host connection |
|
Registry |
|
|
Value |
enabled / disabled (Default) |
|
Path |
System > Registry |
|
Parameter |
Always prompt for password upon session host connection |
|
Registry |
|
|
Value |
enabled / disabled (Default) |
|
Note |
On the server side, you can enable the RDP group policy "Always prompt for password upon connection" to achieve the same result. |
Configuring the Gateway
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Gateway.
-
Edit the settings according to your needs. The parameters are described in the following.
Enable gateway support
- Gateway support is enabled for the RDP connection, and the gateway settings are available, see below.
- Gateway support is disabled. (Default)
Gateway
IP address of the RD Gateway server.
RD Gateway usage
Specifies when the RD Gateway is used for the connection.
Possible values:
-
Use an RD Gateway if a direct connection can't be made to the RD Session Host: The RD Gateway is used if a direct connection to the RD Session Host cannot be established. (Default)
-
Always use an RD Gateway: The RD Gateway is always used for the connection.
-
Don't use an RD Gateway: The RD Gateway is not used for the connection.
Use other credentials for RD Gateway authentication
- Separate gateway credentials are used. Gateway User name, Gateway Domain, and Password become available, see below
- The RDP session credentials are used for RD Gateway authentication. (Default)
Gateway User name
User name used to authenticate to the RD Gateway.
Gateway Domain
Domain used to authenticate to the RD Gateway.
Password
Password used to authenticate to the RD Gateway. Enter the password in both fields and select Set password.
Configuring the Redirections
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Redirections.
-
Edit the settings according to your needs. The parameter is described in the following.
Clipboard redirection
- Text and images from the clipboard are shared between the RDP session and the local client.
- Text and images from the clipboard are not shared between the RDP session and the local client. (Default)
Drive redirection
- Redirection is bound to the
/mediafolder, so that locally mounted storage devices, including USB sticks, are forwarded to the RDP session. (Default)
Smartcard redirection
- Smartcards are forwarded to the RDP session.
- Smartcards are not forwarded to the RDP session. (Default)
Webcam redirection
- Local webcams can be made available within the RDP session.
- Webcam redirection is disabled. (Default)
Audio output redirection
- Audio output is redirected between the RDP session and the local client. (Default)
Audio input redirection
- Audio input (microphone) is redirected between the local client and the RDP session. (Default)
AAC Codec
- The AAC (Advanced Audio Coding) codec used for support of audio output redirection is enabled. (Default)
H264 hardware acceleration
- H264 hardware acceleration is used. (Default)
H264 hardware acceleration level
Defines which content uses H.264 hardware acceleration. This setting is relevant when H264 hardware acceleration is enabled.
Possible values:
-
Video content: Uses H.264 hardware acceleration only for video content.
-
Fullscreen: Uses H.264 hardware acceleration for the complete remote desktop.
Serial port redirection
- Local serial ports are redirected to the RDP session.
- Serial port redirection is disabled. (Default)
Configuring the Options
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Options.
-
Edit the settings according to your needs. The parameters are described in the following.
UDP Short Path
- UDP Short Path is enabled. (Default)
In-session toolbar
- The in-session toolbar is enabled. (Default)
Show network status in toolbar
- The network status is shown in the toolbar. (Default)
Show network status on startpage
- The network status is shown on the start page. (Default)
Show battery status in toolbar
- The battery status is shown in the toolbar. (Default)
Show battery status on startpage
- The battery status is shown on the start page. (Default)
Disconnect notification timeout
Specifies how long the disconnect notification window is displayed. The value specifies the duration in seconds for which the disconnect notification window remains visible.
Possible values:
-
0 seconds (Disabled)
-
1–10 seconds
In IGEL Remote Desktop version 1.4.2 BUILD 1.0, relative mouse mode cannot be configured via a parameter or registry key in the UMS Profile Configurator or IGEL Setup and is always disabled. A configuration option is planned for a later version.
Configuring the Display
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Display.
-
Edit the settings according to your needs. The parameters are described in the following.
Window size
Specifies the width and height of the window.
Possible options:
-
Full-screen: The session is shown on the full screen. The device's taskbar is not visible. (Default)
-
Work area: The session is shown on the full screen, minus the area needed by the device's taskbar.
-
Numeric details: The session is shown in the selected resolution or on the selected percentage of the screen area.
Multimonitor full-screen mode
This setting is relevant if more than one monitor is connected to the terminal.
Possible options:
-
Single monitor: Restricts the full-screen session to one monitor.
-
Multiple monitors: Displays the full-screen session on multiple monitors. (Default)
-
Expand to all monitors: Expands the full-screen session across all monitors.
Start monitor
Specifies the monitor on which the session is displayed.
Possible options:
-
No configuration: The monitor is selected according to the current position of the mouse pointer. (Default)
-
1st-8th monitor
Scale factor
Specifies the desktop scaling in percent.
Possible values:
-
Automatic scale: The resolution set under User Interface > Display Settings > DPI Options > Monitor-DPI is used for the session. For details, see DPI Options.
-
Numeric details: The display is magnified by the factor given here (100-500).
Configuring the Customization
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Customization.
-
Edit the settings according to your needs. The parameters are described in the following.
Disable company logo
- The company logo is not displayed.
- The company logo is displayed. (Default)
Logo image filename
Specifies the filename of the image to use as the company logo.
Configure the download source for the image under: User Interface > Desktop > Background > Custom Wallpaper Server
Disable background image
- The background image is not displayed.
- The background image is displayed. (Default)
Background image filename or color (#rrggbb)
Specifies either the filename of the background image or a background color.
For a background image, configure the download source under: User Interface > Desktop > Background > Custom Wallpaper Server
For a background color, specify the color using the #rrggbb format. Example: #005078
Username Placeholder
Specifies the placeholder text displayed in the username field on the login screen.
For example: someone@example.com
Configuring the Keyboard
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Keyboard.
-
Edit the settings according to your needs. The parameters are described in the following.
Remote Keymapping
- Key events are sent as Windows scan codes instead of Unicode. This allows the remote keyboard mapping to be fully taken into account. (Default)
Enabling Remote Keymapping may be required for some input methods to work correctly.
Grab whole keyboard
- All local hotkeys are passed to the RDP session.
- Local hotkeys are not passed to the RDP session. (Default)
Configuring the Printing
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Printing.
-
Edit the settings according to your needs. The parameter is described in the following.
CUPS printer redirection
- CUPS printers are redirected to the RDP session. (Default)
Configuring the Debug Options
-
In the Profile Configurator, go to Apps > RDP > RDP Sessions > [Session Name] > Debug Options.
-
Edit the settings according to your needs. The parameters are described in the following.
IGEL RDP log level
Sets the log level for the IGEL RDP client.
Possible values:
-
Critical (Default): Logs severe system failures that require immediate attention.
-
Error: Logs failures where something did not work as expected but the system may continue running.
-
Warning: Logs potential issues or unusual situations that are not errors yet but could cause problems.
-
Info: Logs general operational messages about normal system behavior.
-
Debug: Logs detailed information useful for troubleshooting and development.
-
Trace: Logs very fine-grained, step-by-step details of program execution for deep debugging.
RdClientSDK log level
Sets the log level for the RdClientSDK.
Possible values:
-
None (Default): No logging is recorded, or only minimal essential events are captured.
-
Low: Logs only basic, high-level information such as major events and errors.
-
Medium: Includes more detailed operational data useful for general troubleshooting.
-
High: Captures extensive, verbose details (including debug-level data) for in-depth diagnostics.