Additional Eggplant Network Emulator Commands

There are several commands you can use in a command-line interface (CLI) with the Eggplant Network Emulator that are not directly related to emulations. These commands help to provide information on the emulation and the general configuration of the Emulator.

Note: The examples on this page assume you're using the command-line Python script,, which you can download from the Eggplant downloads page for Eggplant Network.

Reboot the Emulator

This command reboots the Emulator.



The Emulator responds with --ok and then reboots.


C:\Users\Lara>python --host --user admin --password admin --reboot


Get License Details

You can retrieve details of a part of the product license with the --getLicense command by specifying one of the identifiers in the table below.


--getLicense <Identifier>

The <Identifier> indicates what license information you want to see. The table below shows the license information that can be requested along with the <Identifier> to use.

Identifier Description
Ports Returns a comma-separated list of licensed ports.
Links Returns the number of licensed links.
Bandwidth Returns the maximum bandwidth allowed.
ProductId Returns the Product Identifier Number (19 for Model 5; 21 for Model 20).


--license "<Identifier>;;<items>…"


The following example shows the retrieval of the ProductId:

C:\Users\Lara>python --host --user admin --password admin --getLicense "ProductId"

--license "ProductId;;21

Get License Status

This following command gets the license status—whether Eggplant Network is licensed or not, and if a temporary license exists, the license expiration date.




--licenseStatus <N>;<expiration date>|permanent

In the output, <N> is 1 if the license is valid and current, or 0 if it does not exist or has expired. The <expiration date>, in the form YYYY-MM-DD, is the date the license expires; or, if the word permanent is here, there is no expiration.


C:\Users\Lara>python --host --user admin --password admin --getLicenseStatus

--licenseStatus 1;2016-12-20

Get Ports

The following command returns information about the ports in the Emulator and whether they are available or in use by an emulation.




--ports "<number of ports>;;<port id1>;;<name1>;;<port parent id1>;;<emulation_id1>..."

The output returns the <number of ports> and four values per port:

<port idN>: the internal ID of the port

<nameN>: the name of the port

<port parent idN>: the ID of the parent port of this port, if any (-1 if no parent)

<emulation_idN>: the ID of the emulation assigned to this port (-1 if there is no emulation)

If the ports have not been assigned IP addresses, they are named 0, 1, 2, and 3; if they have been assigned an IP address, you will see names such as port_1, port_2. In the latter case, the port parent ID tells you what the parent port is.


C:\Users\Lara>python --host --user admin --password admin --getPorts

--ports "4;0;0;-1;-1;1;1;-1;-1;2;2;-1;1;3;3;-1;1;"

Get Version

Use this command to output version numbers for the Emulator along with the build date/time of the emulation engine.




--versions "<number of components>;<component name 1>;<component version 1>;<component name 2>;<component version 2>;;...

In this output, <number of components> is the number of components for which build numbers are being returned. For each component, there are two parts:

  • Component name: the name of the component
    • Build: the overall product build
    • WebGUI: the web GUI
    • Ippe: the emulation engine
  • Component version/build: the version/build number of the component


C:\Users\Lara>python --host --user admin --password admin --getVersion

--ok "3;Build;1.6.0;WebGui;1.8.5;Ippe;8.0.3 201503241158;"

The output above says we’re running version 1.6.0 with a web GUI version of 1.8.5 and an Emulation engine of 8.0.3 201503241158.


This topic was last updated on August 19, 2021, at 03:30:51 PM.

Eggplant icon | Documentation Home | User Forums | Support | Copyright © 2021 Eggplant