Skip to main content

FreeRDP connection

You can use the Eggplant Gateway to perform Remote Desktop Connection to Windows and Linux machine to execute test using Eggplant Functional and Eggplant DAI tests.

info

Support for Eggplant Gateway Remote Desktop Connection is currenly tested on Windows, Linux and Mac. For Linux based client machine, it is required to install FreeRDP first before perform RDP connection via Eggplant Gateway.

Note: Starting from version 4.1, FreeRDP dependency packages are bundled along Eggplant Gateway MacOS archive. Mac users no longer required to perform manual installation of FreeRDP.

Getting started

Creating a connection

To create an Eggplant Gateway for remote desktop connection, run the following command:

./epgw add rdp \
  --name <name> \
  --serverHostname <RDP server hostname> \
  --username <RDP server username> \
  --password <password> \
  --serverPort <RDP server port> \
  --domain <RDP server domain> \
  --resolution <screenResolution>
KeyDescription
nameThe name of the connection you want to create. You can freely choose this name.
serverHostnameThe RDP server hostname that you want to remote to. Example: "ServerHostname" or "Server_IP_address".
usernameThe name of the RDP server login user.
passwordThe password for RDP server login user.
serverPortThe RDP server port number to connect to remote session. Default:3389. (Integer)
domainThe domain for the RDP server login account.
resolutionThe resolution of at which to initialize the remote desktop.

For example, to create a connection which will launch remote desktop session to the System Under Test:

./epgw add rdp --name test_rdp --serverHostname "Rpd_Server_Hostname" --username "RdpUser" --password "RdpUser123" --serverPort 3389 --domain "domain" --resolution "1600x900"

Connecting to Eggplant Functional

Follow these steps to log in to your remote desktop and establish a connection to Eggplant Functional:

  1. Start Eggplant Functional
  2. Run epgw connect <name>, where name is the name of your Gateway connection. For example, epgw connect test_rdp

The Eggplant Gateway will now log in to your the server remote desktop, establish a connection and connect to Eggplant Functional.

Setting up a VNC server for your remote desktop connection

Alternatively, you can set up a VNC server for your remote desktop connection. To do so:

  1. Run epgw vnc <name>, where name is the name of your Gateway connection. For example, epgw vnc test_rdp

The Eggplant Gateway will now log in to your remote desktop server, establish a connection and start a VNC server at port 5900.

You'll need to manually add your device to the connection list in Eggplant Functional.

Last updated on