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.

Following are instructions for installing on Windows, Mac, and Linux.

Installing Eggplant Functional (EPF) on Windows

1. Read the Prerequisites page for information about supported Windows operating systems and recommendations.
2. Download the Eggplant Functional Windows installer from the Eggplant Functional Downloads page.
3. Double-click the Eggplant Functional installer, then follow the instructions in the Setup Wizard to complete installation.

Important

When you launch Eggplant Functional 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 Eggplant Functional icon on your desktop and select Pin to Taskbar or Pin to Start Menu.

Installing Eggplant Functional on Windows at the Command Line (Silent Install)

You can install Eggplant Functional using the command-line interface (CLI), which is also known as a silent install or unattended install. Silent installations run the installation without user interaction because the installer program runs without its graphical user interface (GUI). Silent installations enable you to install Eggplant Functional from shell scripts or in containers.

Important

If you want to run a silent installation on a machine where Eggplant Functional is already installed, you must uninstall the existing version before silently installing the new version. This is required because silent installations cannot handle the uninstall dialog. Note that you can run the uninstaller silently (unattended), which is described in the instructions below.

1. Open a Windows shell (Command Prompt or PowerShell).

2. If Eggplant Functional is already installed, uninstall the existing version before you silently install the new version. You can use the following command to uninstall Eggplant Functional silently:

   ノート

   In all the following examples, replace the xx.x.xx with the version number of the Eggplant Functional you are installing.

   start /wait "uninstall" "C:\Program Files\Eggplant\uninstall.exe"  --mode unattended

3. Install the new version of Eggplant Functional at the command line using one of the following commands, depending on whether you want to see any installation status or not:

   No Interface The following command runs the installer without displaying anything:

   C:\Downloads\Eggplant64Setupxx.x.xx.exe --mode unattended

   Or,

   Minimal Interface The following command runs the installer and displays an installation progress bar:

   “C:\Downloads\Eggplant64Setupxx.x.xx.exe” --mode unattended --unattendedmodeui minimal

Silent Installation Notes

• Regarding licenses, it is not possible to apply a license during a silent install, so you must apply a license manually. If you use an RLM license server, its IP address or server name is saved in the Eggplant.plist file, located in the installing user's %appdata%\Eggplant\Defaults. This file stores all the Eggplant Functional preferences and does not exist until Eggplant Functional is launched for the first time.

• Installing the Bonjour service is optional. Bonjour is Apple's implementation of zero-configuration networking, a group of technologies that includes service discovery, address assignment, and hostname resolution. Installing it allows Eggplant to find machines that advertise their availability on the network —- it is not a polling protocol. To skip the installation of Bonjour when doing silent installation of Eggplant Functional, use -disable-components bonjour, like this:

  C:\Downloads\Eggplant64Setupxx.x.xx.exe --mode unattended --disable-components bonjour

  After completion it is necessary to ensure the install.exe has been transferred to the device for the latest version of Eggplant Functional. This can be done with either minimal or no interface, using the below. Please note that xx.x.xx must be replaced with the current version of Eggplant Functional which you intend to install:

  Minimal Interface
  This following command displays an installation progress bar (be sure to customize the command for the latest version of Eggplant Functional which you are installing):

  start /wait "INSTALL" Eggplant64Setupxx.x.xx.exe --mode unattended --unattendedmodeui minimal

  No Interface

  start /wait "INSTALL" Eggplant64Setupxx.x.xx.exe --mode unattended --unattendedmodeui none

Installing Eggplant Functional on Mac

1. Read the Prerequisites page for information about supported macOS operating systems and recommendations.
2. Download Eggplant Functional from the Eggplant Functional Downloads page.
3. Double-click the Eggplant Functional .dmg file, then drag the Eggplant Functional application into your Applications folder.

Important

When you launch Eggplant Functional 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, drag the Eggplant Functional icon from the Applications folder into your Dock.

Installing Eggplant Functional on Linux

EPF provides installation packages for Red Hat Enterprise Linux (RHEL) and Ubuntu. The package you need, and the package manager you need to use to install, it depend on which operating system you are running.

Installing Eggplant Functional on Red Hat Enterprise Linux (RHEL)

Information about installing EPF on RHEL follows, including the supported OS version and which package manager to use.

Eggplant Functional RHEL Package and Required Package Manager

Red Hat Enterprise Linux (RHEL)	Version	Package Manager
RHEL	8	dnf
RHEL	9	dnf

Step by Step: Installing on RHEL

ノート

If you want to run Eggplant Functional on RHEL 8 or RHEL 9, and are currently running Eggplant Functional on RHEL 7, or if you installed a version of Eggplant Functional prior to the 23.3.0 version on RHEL 8, you need to reset the system under test (SUT) connection passwords for any existing saved passwords after you install the 23.3.0 or a later version of Eggplant Functional. Note that you only need to reset the SUT passwords one-time after you first install the Eggplant Functional package for RHEL 8/9.

Installation Steps	RHEL-Specific Instructions by Version
1. Read the Prerequisites page	For information about EPF system requirements and recommendations.
2. Download the appropriate Eggplant Functional archive file from the Downloads page to the machine where you want to install Eggplant Functional.	For RHEL 8/9: Download the archive specifically for Enterprise, v8 or 9 respectively.
3. Unpack the Eggplant Functional archive (.tgz) file, which extracts a folder containing the Eggplant Functional install package.	For RHEL 8/9: 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: For RHEL 8/9: tar xvfz Eggplant_EnterpriseLinux8.tgz Be sure to qualify the archive name with the path to its location.
4. If Eggplant Functional is already installed on this machine, open a terminal and use elevated privileges to remove the existing Eggplant Functional package. Note that the E in the Eggplant package name must be upper-case.	For RHEL 8/9 Use the dnf package manager remove command: sudo dnf remove Eggplant
5. Install the new Eggplant Functional package using elevated privileges.	For RHEL 8/9: Use the dnf package manager install command. For example: sudo dnf install Eggplant_EnterpriseLinux8/Eggplant_EnterpriseLinux8_<version>.rpm or sudo dnf install Eggplant_EnterpriseLinux9/Eggplant_EnterpriseLinux9_<version>.rpm, where version is the Eggplant Functional release you are installing. Be sure to qualify the package name with the path to its location, including the enclosing folder.
Optional: Install any missing required dependencies using Extra Packages for Enterprise Linux (EPEL).	For RHEL 8/9: You may find that you are missing required dependencies. In this case, you may want to use EPEL to install additional packages. EPEL requires enabling the CodeReady Linux Builder repo which provides additional tools for building applications for RHEL. For more information and detailed instructions, see What's EPEL, and how do I use it?

Important

When you launch Eggplant Functional for the first time after installation, you are required to agree to the Keysight EULA and acknowledge the Keysight Privacy Policy.

Example RHEL 8/9 Installation Commands

You can copy the following sample RHEL 8 and RHEL 9 installation commands, paste them into your linux terminal, and run them. Be sure to replace the Eggplant Functional archive and package names with the names and locations of the archive and package you are installing. Then run the commands with elevated privileges as shown. You may be prompted to confirm that you want to perform a task while running these commands. Enter "Y" or "y" for "Yes" to confirm as needed.

For installing RHEL 8:

tar xvfz Eggplant_EnterpriseLinux8_<version>.tgz
sudo dnf remove Eggplant
sudo dnf install <path_to_extracted_epf_install_package>/Eggplant_EnterpriseLinux8/Eggplant_EnterpriseLinux8_<version>.rpm

For installing RHEL 9:

tar xvfz Eggplant_EnterpriseLinux9_<version>.tgz
sudo dnf remove Eggplant
sudo dnf install <path_to_extracted_epf_install_package>/Eggplant_EnterpriseLinux9/Eggplant_EnterpriseLinux9_<version>.rpm

ノート

Bonjour discovery is disabled.

Installing Eggplant Functional on Ubuntu

Eggplant Functional 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.

Eggplant Functional Ubuntu Packages and Required Package Managers

Ubuntu Support	Version	Package Manager
Ubuntu LTS	22.04	apt
Ubuntu LTS	16.04	apt or dpkg

Step by Step: Installing on Ubuntu

Installation Steps	Ubuntu-Specific Instructions by Version
1. Read the Prerequisites page	For information about EPF system requirements and recommendations.
2. Download the appropriate Eggplant Functional for archive file from the Eggplant Functional Downloads page to the machine where you want to install Eggplant Functional.	For Ubuntu 22.04: Download the archive specifially for 22.04.
3. Unpack the Eggplant Functional archive (.tgz) file, which extracts a folder containing the Eggplant Functional install package.	For Ubuntu 22.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_Ubuntu22.tgz
4. If Eggplant Functional is already installed on this machine, open a terminal and use elevated privileges to remove the existing Eggplant Functional package. Note that the e in the Eggplant package name must be lower-case.	For Ubuntu 22.04: Use the apt package manager remove command: sudo apt remove eggplant
5. Update your system to the latest Ubuntu packages using elevated privilges.	For Ubuntu 22.04: This step is required to update the base Ubuntu 22.04 operating system package: sudo apt update
6. Open a terminal (if not already open) and install the new Eggplant Functional package using elevated privileges.	For Ubuntu 22.04: Use the apt package manager install command sudo apt install Eggplant_Ubuntu22/Eggplant_Ubuntu22_<version>.deb, where version is the release of Eggplant Functional you are installing. Be sure to qualify the package name with the path to its location, including the enclosing folder.

Important

When you launch Eggplant Functional for the first time after installation, you are required to agree to the Keysight EULA and acknowledge the Keysight Privacy Policy.

Example Ubuntu 22.04 Installation Commands

You can copy the following sample Ubuntu 22.04 installation commands, paste them into your linux terminal, and run them. Be sure to replace the Eggplant Functional archive and package names with the names and locations of the archive and package you are installing. Then run the commands with elevated privileges as shown. You may be prompted to confirm that you want to perform a task while running these commands. Enter "Y" or "y" for "Yes" to confirm as needed.

tar xvfz Eggplant_<version>.tgz
sudo apt remove eggplant
sudo apt update
sudo apt install <path_to_extracted_epf_install_package>/Eggplant_Ubuntu22/Eggplant_Ubuntu22_<version>.deb

Licensing Eggplant Functional

When you complete installation, the next step is to license Eggplant Functional. 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 Eggplant Functional from your system is described below by operating system type.

From Windows

To uninstall Eggplant Functional 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 user's AppData folder.

From Windows at the Command Line (Silent Uninstall)

You can uninstall Eggplant Functional at the command line, which is called a silent uninstall or unattended uninstall as follows:

1. Open a Windows shell (Command Prompt or PowerShell).

2. Enter the following command to uninstall Eggplant Functional silently:

   start /wait "uninstall" "C:\Program Files\Eggplant\uninstall.exe"  --mode unattended

From macOS

To uninstall Eggplant Functional from macOS system, drag the Eggplant Functional from the Applications folder to the trash and then empty the trash. This removes Eggplant Functional as an application but leaves some files.

From Linux

The command you use to uninstall Eggplant Functional from a linux system depends on the version of linux you are using and the Eggplant Functional linux package you installed. The following table summarizes the Eggplant Functional uninstall commands by linux version. The same commands are provided below the table in a format you can copy into your linux terminal and run.

Important

The case of the letter "e" or "E" in 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.

You can copy the following Eggplant Functional uninstall commands, paste them into your linux terminal, and run them. Be sure to run the commands with elevated privileges as shown in the commands below. You may be prompted to confirm that you want to perform a task while running these commands. Enter "Y" or "y" for "Yes" to confirm as needed.

Linux Version	Uninstall Command
RHEL 8	sudo dnf remove Eggplant
RHEL 9	sudo dnf remove Eggplant
Ubuntu 22.04	sudo apt remove eggplant
Ubuntu 16.04	sudo dpkg -r eggplant or sudo apt remove eggplant