5.2.1 – RDP parameters
| Parameter | Value |
|---|---|
| gateway | BindString, address and listening port of the gateway. For example: 192.168.0.8:443 |
| server | String, address of the RDP host. |
| port | Integer, RDP listening port. Optional, default is 3389 |
| user | String, user name (Windows User). |
| pwd | String, password for user name. |
| domain | String, domain name |
| keyboard | Integer, keyboard layout, default is 0x409 (US) |
| useConsole | Boolean, connecting to console session/Admin mode. Default is false. |
| legacyMode | Boolean, connecting to xrdp or VirtualBox RDP |
| width | Integer, screen width of RDP session. Default is 800 |
| height | Integer, screen height of RDP session. Default is 600 |
| server_bpp | Integer, color depth of RDP session. Default is 16 |
| playSound | Integer, Default is 1: Do not play sound; 0: bring sound to local; 2: leave sound on remote computer. |
| startProgram | String, "shell": start a program on connection; "app": start a RemoteApp |
| command | Command for “Start a program on connection (startProgram=shell)” |
| directory | Directory for running command (startProgram=shell) |
| exe | Program or file for RemoteApp (startProgram=app) |
| args | Arguments for RemoteApp (startProgram=app) |
| background | Boolean, default is false, disable background. |
| smoothfont | Boolean, default is false, disable font smoothing. |
| contents | Boolean, default is false, disable full windows drag. |
| animation | Boolean, default is false, disable menu animations. |
| composition | Boolean, default is false, disable desktop composition. |
| styles | Boolean, default is false, disable theming. |
| mapClipboard | Boolean, default is false, disable clipboard rediretioin. |
| mapPrinter | Boolean, default is false, disable printer redirection. |
| mapDisk | Boolean, default is false, disable disk redirection. |
| touchpad | Boolean, default is false, touchpad mode (relative mouse movement, touch interface only). |
| waWidth | Work area width for RemoteApp, Default value is the screen width. You may want to change it if you display app in a iframe. |
| waHeight | Work area height for RemoteApp. Default value is the screen height. You may want to change it if you display app in a iframe. |
| printer | Printer name. You can specify multiple printer names by using “;” as seperator, e.g. “Printer1;Printer2”. The first one will always be the default printer. |
| useSSL | Use WSS (WebSocket secure connection), only used by Rdp2 class. |
| timezone | The client time zone name. Please check the values you can use in rdp.html |
| loadBalanceInfo | Load balance information |
| vmid | Hyper-V VM GUID, For example: B3D5444C-2611-405A-9CA0-7AA8DA94DF0B, it’s for Hyper-V console connection. |
| minWidth, minHeight | Minimum width and height, some applications can only work on a minimum resolution |
| connectType | Connecting type: CONNECTION_TYPE_MODEM 1 Modem (56 Kbps) CONNECTION_TYPE_BROADBAND_LOW 2 Low-speed broadband (256 Kbps - 2 Mbps) CONNECTION_TYPE_SATELLITE 3 Satellite (2 Mbps - 16 Mbps with high latency) CONNECTION_TYPE_BROADBAND_HIGH 4 High-speed broadband (2 Mbps - 10 Mbps) CONNECTION_TYPE_WAN 5 WAN (10 Mbps or higher with high latency) CONNECTION_TYPE_LAN 6 LAN (10 Mbps or higher) Default value is 5. |
| shareClipboardId | Connections will same shareClipboardId will use shared clipboard on gateway. User can copy anything among these connections |
| shareClipboard | on: enabled shared clipboard, it’s enabled by default if mapClipboard is on. |
| symlink | Id of the created symlink. |
| sessionRecord | 0: no session recording, 1: recording grphic only (no sound), 3 means recording graphic and sound. This can only be configured in pluign |
| __record_name | Recording file name. This can only be configured in pluign before version 4.8.8. |
| recording | on: record session on client side |
| audioRecord | on: enable remote audio recording |
| pingInterval | Seconds for ping |
| soundPref | 0: low quality sound; 1: high quality sound |
| smartcard | on: enable smart card redirection |
| passwordIsPin | Use password as the pin of smart card |
| name | Show the name on the cursor on joined users |
| mac | Computer MAC address for Wake on LAN. Need to enable it in gateway.conf (timeoutWoL) |
| macIP | Network broadcast ip address for WoL. |
| decompressingRDP61 | Enable RDP6.1 compression. |
| portCheckTimes, portCheckInterval | Gateway will check if the port is open before connecting. portCheckInterval: milliseconds. |
| copyToLocal | on: user can copy data to local from remote. It can be used to disable bi-directional copy/paste |
| copyToRemote | on: user can copy data to remote from local. It can be used to disable bi-directional copy/paste |
| copyTextOnly | on: user can only copy plain text. |
| textPrinter | on: redirect a text only printer (for receipts, label printers) |
| mapCamera | Boolean, default is false, enable webcam redirection. Enable it in RDP server with Group Policy: Computer Configuration > Administrative Templates > Windows Components > Remote Desktop Services > Remote Desktop Session Host > Device and Resource Redirection > Do not allow supported Plug and Play device redirection: Disabled |
| scanner | Boolean, default is false, enable scanner redirection. |