FreeRDP connection
You can use Eggplant Gateway to create remote desktop (RDP) connections to Windows and Linux machines to execute tests using Eggplant Functional and Eggplant DAI.
For Linux based client machines, it is required to install FreeRDP before creating RDP connections via Eggplant Gateway.
Starting in version 4.1, FreeRDP dependency packages are bundled along with the Eggplant Gateway MacOS archive. Mac users are no longer required to manually install FreeRDP.
Starting in version 4.21, Windows Platform will default to using FreeRDP version 3.
Creating a Connection
To create an Eggplant Gateway remote desktop (RDP) 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>
The available options are:
| 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. This can be the hostname or 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 at which to initialize the remote desktop. |
For example, to create a connection that launches an RDP session to the system under test (SUT), use the following command:
./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 remote desktop (RDP) 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 \
The available options are:
| 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. This can be the hostname or 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 that launches an RDP session with RDP security options, use the following command:
./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 Multiple Monitors
To create an Eggplant Gateway remote desktop (RDP) connection with multiple monitors (Multi Monitors), 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> \
--numOfMonitors <Number of monitors screen display> \
The available options are:
| Key | Description |
|---|---|
name | The name of the connection you want to create. You can freely choose this name. |
serverHostname | The remote RDP server host to which you want to connect. The this host can be the hostname or 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 for the remote session connection. Default:3389. (Integer) |
domain | The domain for the RDP server login account. |
resolution | The resolution of at which to initialize the remote desktop. |
numOfMonitors | The number of monitors to display. Default: 1. |
For example, to create a connection that launches an RDP session with multiple monitors use the following command:
./epgw add rdp --name test_rdp_security --serverHostname "Rpd_Server_Hostname" --username "RdpUser" --password "RdpUser123" --serverPort 3389 --domain "domain" --resolution "1600x900" --numOfMonitors 2
Creating a Connection with Smart Card Authentication
To create an Eggplant Gateway remote desktop (RDP) 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>
The available options are:
| 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. This can be the hostname or 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 that launches an RDP session with smart card authentication, use the following command:
./epgw add rdp smartcard --name test_rdp_smartcard --serverHostname "Rpd_Server_Hostname" --username "RdpUser" --pin "12345678" --serverPort 3389 --domain "domain" --resolution "1600x900"
Creating a Smart Card Authentication Connection with Multiple Smart Cards
To create an Eggplant Gateway remote desktop (RDP) 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>
--readerName <smart card reader name>
The available options are:
| 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. This can be the hostname or 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. |
readerName | The smart card reader name that use for SUT authentication. |
For example, to create a connection that launches an RDP session with Smart card authentication that have multiple smart card use the following command:
./epgw add rdp smartcard --name test_rdp_smartcard --serverHostname "Rpd_Server_Hostname" --username "RdpUser" --pin "12345678" --serverPort 3389 --domain "domain" --resolution "1600x900" --readerName "reader name A"
All security options used with the Add rdp command are also available for use with the Add rdp smartcard command.
Connecting to Eggplant Functional
Follow these steps to log into your remote desktop and establish a connection to Eggplant Functional:
- Start Eggplant Functional
- Run
epgw connect <name>, where name is the name of your Gateway connection. For example,epgw connect test_rdp
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:
- Run
epgw vnc <name>, where name is the name of your Gateway connection. For example,epgw vnc test_rdp
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.