Installing Eggplant Functional
Eggplant Functional (EPF) runs on Windows, Mac, and Linux. Before you start your installation process, please be sure to read Prerequisites for information about supported operating systems and recommended installation configurations.
Starting after the release of EPF 23.1.1, the system requirements and supported operating system information moved to the Prerequisites page. Please see this page for more information about setting up systems for your EPF installation.
Following are instructions for installing on Windows, Mac, and Linux.
Installing Eggplant Functional on Windows
-
Download the EPF Windows installer from the Eggplant Functional Downloads page.
-
Double-click the EPF installer, then follow the instructions in the Setup Wizard to complete installation.
From the Select Components screen, you can choose to install Bonjour, which discovers other devices on your local network. Check with your system administrator if you're not sure whether or not you should install this service.
When you launch EPF for the first time after installation, you are required to agree to the Keysight EULA and acknowledge the Keysight Privacy Policy.
For quick access to Eggplant Functional, right-click the EPF icon on your desktop and select Pin to Taskbar or Pin to Start Menu.
Installing Eggplant Functional on Mac
- Download EPF from the Eggplant Functional Downloads page.
- Double-click the EPF .dmg file, then drag the EPF application into your Applications folder.
When you launch EPF for the first time after installation, you are required to agree to the Keysight EULA and acknowledge the Keysight Privacy Policy.
For quick access to EPF, drag the EPF icon from the Applications folder into your Dock.
Installing Eggplant Functional on Linux
EPF provides installation packages for Red Hat Enterprise Linux (RHEL), CentOS, and Ubuntu. Information about the available packages and instructions for installing them are provided below.
Installing EPF on Red Hat Enterprise Linux (RHEL) and CentOS
EPF provides two installation packages for RHEL and CentOS. The package you need, and the package manager you need to use to install it, depend on which operating system version you are running.
EPF RHEL and CentOS Packages and Required Package Managers
| Red Hat Enterprise Linux (RHEL) and CentOS Support | Version | Package Manager |
|---|---|---|
| RHEL | 8 | dnf |
| RHEL and CentOS | 7.x | rpm or yum |
Step by Step: Installing on RHEL and CentOS
EPF supports RHEL 8 for command line (runscript) executions only. However, you can enable the GUI for limited use with assistance from our Customer Support.
If you want to run EPF on RHEL 8, and are currently running EPF on CentOS 7, or if you installed a version of EPF prior to the 23.3.0 version on RHEL 8, you need to reset the system under teset (SUT) connection passwords for any existing saved passwords after you install the 23.3.0 version. Resetting these passwords requires enabling the GUI, which you can do with the help of our Customer Support.
| Installation Steps | RHEL- and/or CentOS-Specific Instructions by Version |
|---|---|
| 1. Download the appropriate EPF archive file from the Downloads page to the machine where you want to install EPF. | For RHEL 8: Download the archive specifially for Enterprise 8. For RHEL 7 and CentOS 7: Download the archive specifically for CentOS 7. |
| 2. Unpack the EPF archive (.tgz) file, which extracts a folder containing the EPF install package. | For RHEL 8, and RHEL 7 or CentOS 7: Use the extract utility available for your linux version. To use the tar extractor, open a terminal and enter the extract command at the command line. For example:tar xvfz Eggplant_23.3.0.tgz |
| 3. If EPF is already installed on this machine, open a terminal and use elevated privileges to remove the existing EPF package. Note that the E in the Eggplant package name must be upper-case. | For RHEL 8 Use the dnf package manager remove command:sudo dnf remove EggplantFor RHEL 7 or CentOS 7: Use the yum package manager remove command:sudo yum remove Eggplant |
| 4. Open a terminal (if not already open) and install the new EPF package using elevated privileges. | For RHEL 8: Use the dnf package manager and the following command.sudo dnf install <package_name>.rpmBe sure to qualify the package name with the path to its location, including the enclosing folder. For RHEL 7 and CentOS 7: Use the rpm package manager install command with the --force flag.sudo rpm -i --force <packagename>.rpmBe sure to qualify the package name with the path to its location, including the enclosing folder. |
When you launch EPF for the first time after installation, you are required to agree to the Keysight EULA and acknowledge the Keysight Privacy Policy.
Bonjour discovery is disabled.
Installing EPF on Ubuntu
EPF provides two installation packages for Ubuntu LTS. The package you need, and the package manager you need to use to install it, depend on which operating system version you are running.
EPF Ubuntu Packages and Required Package Managers
| Ubuntu Support | Version | Package Manager |
|---|---|---|
| Ubuntu LTS | 22.04 | apt |
| Ubuntu LTS | 16.04/20.04 | apt or dpkg |
Step by Step: Installing on Ubuntu
EPF supports Ubuntu 22.04 for command line (runscript) executions only. However, you can enable the GUI for limited use with assistance from our Customer Support.
If you want to run EPF on Ubuntu 22.04, and are currently running EPF on Ubuntu 16.04 or 20.04, or if you installed a version of EPF prior to installing the 23.3.0 version on 22.04, you need to reset the system under teset (SUT) connection passwords for any existing saved passwords after you install the 23.3.0 version. Resetting these passwords requires enabling the GUI, which you can do with the help of our Customer Support.
| Installation Steps | Ubuntu-Specific Instructions by Version |
|---|---|
| 1. Download the appropriate EPF for archive file from the EPF Downloads page to the machine where you want to install EPF. | For Ubuntu 22.04: Download the archive specifially for 22.04. For Ubuntu 16.04 and 20.04: Download the archive specifically for 16.04. |
| 2. Unpack the EPF archive (.tgz) file, which extracts a folder containing the EPF install package. | For Ubuntu 22.04, 20.04 and 16.04: Use the extract utility available for your linux version. To use the tar extractor, open a terminal and enter the extract command at the command line. For example:tar xvfz Eggplant_23.3.0.tgz |
| 3. If EPF is already installed on this machine, open a terminal and use elevated privileges to remove the existing EPF package. Note that the e in the Eggplant package name must be lower-case. | * For For Ubuntu 22.04, 20.04 and 16.04: Use the apt package manager remove command: sudo apt remove eggplant |
| 4. Update your system to the latest Ubuntu packages using elevated privilges. | For Ubuntu 22.04: This is required to update the base Ubuntu 22.04 operating system package with updates for EPF 23.3.0. sudo apt update |
| 5. Open a terminal (if not already open) and install the new EPF package using elevated privileges. | For Ubuntu 22.04: Use the apt package manager install command.sudo apt install <package_name>.deb Be sure to qualify the package name with the path to its location, including the enclosing folder. Ubuntu 20.04 and 16.04: Use the dpkg package manager install command:sudo dpkg -i <package_name>.deb Be sure to qualify the package name with the path to its location, including the enclosing folder. If you want to use the EPF GUI with Ubuntu 16.04 or 20.04, you need to install the Gnome desktop. You can use the following command to determine if its package is installed on your system: dpkg -L gnome-session-flashbackIf you need to install the Gnome desktop package, follow the steps below: 1. Install the Gnome desktop package using the following command. You can rerun the command above to ensure the package installed, if you want: sudo apt-get install gnome-session-flashback 2. Log out and when you log back in, choose the Metacity desktop option. 3. Verify that you are using the Metacity desktop using the following command: echo $DESKTOP_SESSION |
When you launch EPF for the first time after installation, you are required to agree to the Keysight EULA and acknowledge the Keysight Privacy Policy.
Licensing Eggplant Functional
When you complete installation, the next step is to license EPF. To read about this process, see Licensing Eggplant Functional. For specific instructions on using team licenses, see Using RLM for Team License Management.
Uninstalling Eggplant Functional
Information about removing EPF from your system is described below by operating system type.
From Windows
To uninstall EPF from a Windows system, use the Windows operating system Add/Remove Programs utility in the Control Panel. This removes the Eggplant folder from C:\Program Files, but leaves files in the installing users AppData folder.
From macOS
To uninstall EPF from macOS system, drag the Eggplant Functional from the Applications folder to the trash and then empty the trash. This removes EPF as an application but leaves some files.
From Linux
The instructions for uninstalling EPF from a linux system depend on the version of linux you are using and the EPF linux package you installed. Follow the instructions below as appropriate for your EPF linux installation.
Use elevated privileges and the appropriate package manager for your linux operating system as shown in the table below.
The case of the Eggplant package name is significant in the following commands:
- For Red Hat: The E is upper-case.
- For Ubuntu: The e is lower-case.
| Linux Version | Uninstall Command |
|---|---|
| RHEL 8 | sudo dnf remove Eggplant |
| RHEL 7 or CentOS 7 | sudo yum remove Eggplant |
| Ubuntu 22.04 | sudo apt remove eggplant |
| Ubuntu 16.04 and 20.04 | sudo dpkg -r eggplant or sudo apt remove eggplant |