Create a Basic RDP Connection
Below are instructions for creating RDP connections in Eggplant Test products. For an overview and prerequisites for using RDP connections, please read RDP Connections Overview and RDP Connection Prerequisites first.
When you create an RDP connection, you need to supply the connection information for the Windows system you want to use as a SUT, along with any information required for the connection options you want to use. The following tables provide details about the information you need to supply to establish an RDP-type connection to a SUT. The following tables describe the information needed:
- Basic RDP connections
- RDP connections with the Multiple Monitors option
- RDP connections with the Smart Card authentication option
- RDP connections that uses RDP protocol security options
For information about the different ways you can create connections (within the app, in a script, or at the command-line when you run a script that way), or to see examples of the connection panels in the Eggplant Test apps, see Managing Connections in Eggplant Test Applications.
Basic RDP Connections
The table below lists the information you need to make a basic RDP connection. Examples of how to run tests at the command line with a basic RDP connection, as well as how to use them in a SenseTalk script connect command are also provided. Links to where you can create an RDP connection in an Eggplant Test app are also provided.
If you need information about how to create an RDP connection in the different Eggplant Test products, see Managing Connections in Eggplant Test Applications.
While you can only connect to Windows and Linux systems as SUTs, you can use the RDP connection type from Eggplant products running on any supported platform (Windows, Mac, or Linux).
To create a basic RDP connection, provide the following information about the Windows system you want to connect to as a SUT. Below the table describing these fields are examples of how to specify this option in a SenseTalk connect command or when you run a script from the command line.
| Basic Connection Information | Description |
|---|---|
| name | The name you want to give your connection. This can be any name you choose. |
| serverHostname | The hostname or IP address of the Windows system you want to use for a SUT. |
| username | A username with permission to log into the Windows SUT. For connections defined in EPF, you can qualify the username with the domain. |
| password | The password for the username specified above. If your Eggplant Test product is running on Mac or Windows, you can avoid specifying a password here by storing your credentials in your operating system's credential manager. See Securing SUT Connection Credentials for more information. |
| serverPort | The port number to use for the connection on the Windows system. Default: 3389 (Integer) |
| domain (EPGW only) | The domain to which the Windows SUT and username specified above belong. For EPGW only, this is a separate field. |
| resolution (EPGW only) | The screen resolution in pixels you want for your SUT viewer window display. |
| Screen Width (in the Eggplant Studio, EPF, and DAI apps) -DefaultWidth (runscript command option) | The width in pixels you want for your SUT viewer window display. Default: 1024 |
| Screen Height (Eggplant Studio, EPF, and DAI apps) -DefaultWidth (runscript command option) | The height in pixels you want for your SUT viewer window display. Default: 768 |
A Basic RDP Connection in an Eggplant Test App GUI
Eggplant Studio, Eggplant Functional, and DAI all provide graphical user interfaces (GUI) interfaces you can use to create an RDP connection.
Click the Eggplant Test product name below to see a sample RDP connection panel in that app.
- Eggplant Studio
- Eggplant Functional
- DAI
Below is an example Add Connection panel for an RDP connection in Eggplant Studio:
The New Connection panel for an RDP Connection in Eggplant Studio
Below is an example New Connection panel for a Connection Type RDP in Eggplant Functional (EPF):
The New Connection panel for an RDP Connection in EPF
Below is an example General panel for a Connection type RDP in DAI. Note that to access this panel, you must first display the New SUT panel, or edit an existing SUT and add or edit a new connection.
The New Connection panel for an RDP Connection in DAI
A Basic RDP Connection in SenseTalk connect Command Example
SenseTalk is the Eggplant Test scripting language. The following example shows how you can use the SenseTalk connect command to establish a connection within a script. For more information about creating connections within a scrpt, see Connect Command in the SenseTalk Reference.
Connect {serverID: SUTID, portNum: 3389, password: SUTPassword, username: SUTUsername, Type:"RDP", Width: 1920, Height: 1080}
A Basic RDP Connection in a runscript Command Line Example
The Eggplant Funtional (EPF)/Fusion Engine runscript command is the command that you use to run SenseTalk scripts from a command line. You can pass SUT connection information with the runscript command when you run a script at the command line. For more information about running scripts from a command line, see Running from the Command Line in the Eggplant Functional documentation.
Click the operating system below to see an appropriate example of how to pass connection information for a basic RDP connection (-type rdp) as parameters to the runscript command.
- Windows
- Linux
- macOS
An example runscript command on Windows that passes the SUT connection information with the -host, password, and -type rdp parameters at the command-line interface (CLI) with the test script.
"C:\Program Files\Eggplant\runscript.bat" "C:\Users\Alex\Documents\MySuite.suite\Scripts\test2.script" -host <ip address> -password "<password>" -type rdp -DefaultWidth 1920 -DefaultHeight 1080
An example runscript command on Linux that passes the SUT connection information with the -host, password, and -type rdp parameters at the command-line interface (CLI) with the test script.
runscript ~/Documents/appTests.suite/Scripts/test1.script -host <ip address> -type rdp -port 5901 -username "<username>" -password <password>
An example runscript command on macOS that passes the SUT connection information with the -host, password, and -type rdp parameters at the command-line interface (CLI) with the test script.
/Applications/Eggplant.app/Contents/MacOS/runscript /Users/Alex/Docs.suite/Scripts/myTests/test2.script -host <ip address> -type rdp -port 3389 -username <username> -password <password>