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

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 <screen resolution>

Key	Description
name	The name of the connection you want to create. You can freely choose this name.
serverHostname	The RDP server hostname that you want to remote to. Example: "ServerHostname" or "Server_IP_address".
username	The name of the RDP server login user.
password	The password for RDP server login user.
serverPort	The RDP server port number to connect to remote session. Default:3389. (Integer)
domain	The domain for the RDP server login account.
resolution	The 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"

Creating a connection with RDP Security options

To create an Eggplant Gateway for remote desktop connection with rdp security options, 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 <screen resolution> \
  --rdpSecurity \
  --tlsSecurity \
  --nlaSecurity \
  --extSecurity \
  --authentication \
  --securityNegotiation \
  --ignoreCertificate \

Key	Description
name	The name of the connection you want to create. You can freely choose this name.
serverHostname	The RDP server hostname that you want to remote to. Example: "ServerHostname" or "Server_IP_address".
username	The name of the RDP server login user.
password	The password for RDP server login user.
serverPort	The RDP server port number to connect to remote session. Default:3389. (Integer)
domain	The domain for the RDP server login account.
resolution	The resolution of at which to initialize the remote desktop.
rdpSecurity	Configure standard RDP Security. Default:[True]
tlsSecurity	Configure Transport Layer Security. Default:[True]
nlaSecurity	Configure Network Level Authentication. Default:[True]
extSecurity	Configure Extended Security. Default:[False]
authentication	Configure Basic Authentication. Default:[True]
securityNegotiation	Configure Security Negotiation for TLS, NLA and RDP security. Default:[True]
ignoreCertificate	Configure Certificate Validation. Default:[True]

For example, to create a connection which will launch remote desktop session with rdp security options:

./epgw add rdp --name test_rdp_security --serverHostname "Rpd_Server_Hostname" --username "RdpUser" --password "RdpUser123" --serverPort 3389 --domain "domain" --resolution "1600x900" --rdpSecurity --tlsSecurity --nlaSecurity --extSecurity --authentication --securityNegotiation --ignoreCertificate

Creating a connection with smart card authentication

To create an Eggplant Gateway for remote desktop connection with smart card authentication, run the following command:

./epgw add rdp smartcard\
  --name <name> \
  --serverHostname <RDP server hostname> \
  --username <RDP server smart card username> \
  --pin <smart card pin> \
  --serverPort <RDP server port> \
  --domain <RDP server smart card domain> \
  --resolution <screen resolution>

Key	Description
name	The name of the connection you want to create. You can freely choose this name.
serverHostname	The RDP server hostname that you want to remote to. Example: "ServerHostname" or "Server_IP_address".
username	The name of the RDP server login user with smart card enrolled.
pin	The pin number for smart card reader.
serverPort	The RDP server port number to connect to remote session. Default:3389. (Integer)
domain	The domain for the RDP server login account with smart card enrolled.
resolution	The resolution of at which to initialize the remote desktop.

For example, to create a connection which will launch remote desktop session with Smart card authentication:

./epgw add rdp smartcard --name test_rdp_smartcard --serverHostname "Rpd_Server_Hostname" --username "RdpUser" --pin "12345678" --serverPort 3389 --domain "domain" --resolution "1600x900"

info

All security options from Add rdp command are also available in Add rdp smartcard command.

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.