0% found this document useful (0 votes)

286 views152 pages

Eve NG Comm Book

Uploaded by

Emanuel Bernardes

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

286 views152 pages

Eve NG Comm Book

Uploaded by

Emanuel Bernardes

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 152

EVE-NG Community

Cookbook

Version 5.1

Author:
Uldis Dzerkals

Editors:
Michael Doe
Christopher Lim

The information contained in this document is the property of EVE-NG Limited

The contents of the document must not be reproduced or disclosed wholly or in part or used
for purposes other than that for which it is supplied without the prior written permission of
EVE-NG Limited.
EVE-NG Community Cookbook
Version 5.1

Table of Contents
PREFACE .................................................................................................................................. 7
1 INTRODUCTION ................................................................................................................ 8
1.1 WHAT IS EVE-NG? ....................................................................................................... 8
1.2 WHAT IS EVE-NG USED FOR? ....................................................................................... 8
1.3 WHO IS EVE-NG FOR? ................................................................................................. 8
2 SYSTEM REQUIREMENTS............................................................................................... 9
2.1 HARDWARE REQUIREMENTS ........................................................................................... 9
2.1.1 Minimal Laptop/PC Desktop system requirements .............................................. 9
2.1.2 Recommended Laptop/PC Desktop system requirements ................................ 10
2.1.3 Virtual Server system requirements ................................................................... 10
2.1.4 Dedicated Server (bare) system requirements .................................................. 11
2.1.5 Nodes per lab calculator .................................................................................... 11
2.2 SUPPORTED VIRTUALIZATION PLATFORMS AND SOFTWARE ............................................. 11
2.3 UNSUPPORTED HARDWARE AND SYSTEMS .................................................................... 11
3 INSTALLATION ............................................................................................................... 13
3.1 VMWARE WORKSTATION OR VM PLAYER ..................................................................... 13
3.1.1 VMware workstation EVE VM installation using ISO image (preferred) ............ 13
3.1.1.1 EVE VM Setup and Settings ....................................................................................................... 13
3.1.1.2 EVE-NG VM Installation steps ................................................................................................... 17
3.1.2 VMware workstation OVF deployment .............................................................. 21
3.1.2.1 Deployment and VM machine settings ..................................................................................... 22
3.1.2.2 OVF VM update to the latest EVE version ................................................................................. 23
3.1.2.3 OVF VM HDD Size expansion ..................................................................................................... 24
3.2 VMWARE ESXI ........................................................................................................... 24
3.2.1 VMware ESXi EVE installation using ISO image (preferred)............................. 24
3.2.1.1 EVE-NG ESXi VM Setup and Settings ......................................................................................... 24
3.2.1.2 EVE-NG ESXi VM Installation steps ............................................................................................ 26
3.2.2 VMware ESXi OVF deployment ......................................................................... 30
3.2.2.1 ESXi OVF VM Setup and Settings ............................................................................................... 31
3.2.2.2 ESXi OVF VM update to the latest EVE version ......................................................................... 32
3.2.2.3 ESXi OVF VM HDD Size expansion ............................................................................................. 32
3.3 BARE HARDWARE SERVER EVE INSTALLATION .............................................................. 32
3.3.1 EVE-NG Community BM Server Installation...................................................... 32
3.4 GOOGLE CLOUD PLATFORM ......................................................................................... 37
3.4.1 Google account .................................................................................................. 37
3.4.2 Goggle Cloud project ......................................................................................... 37
3.4.3 Preparing Ubuntu boot disk template ................................................................ 38
3.4.4 Creating VM ....................................................................................................... 39
3.4.5 EVE-NG-Community installation ........................................................................ 42
3.4.6 Access to Google Cloud EVE-COMM ............................................................... 43
3.4.7 Optional: GCP Firewall rules for native console use ......................................... 43
3.5 EVE MANAGEMENT IP ADDRESS SETUP ....................................................................... 46
3.5.1 Management static IP address setup (preferred) .............................................. 46
3.5.2 EVE Management IP address setup via DHCP ................................................. 49
3.5.3 EVE Management IP address reset .................................................................. 50
3.6 EVE-NG COMMUNITY UPGRADE TO EVE-NG PROFESSIONAL ....................................... 51
3.6.1 Mandatory Prerequisites .................................................................................... 51
3.6.1.1 EVE Community disk space ....................................................................................................... 51
3.6.1.2 Verify current EVE Community version ..................................................................................... 51
3.6.1.3 Steps to upgrade to the latest EVE Community version ............................................................ 52
3.6.2 Upgrading EVE Community to EVE-NG Professional ....................................... 52
3.7 NATIVE TELNET CONSOLE MANAGEMENT SETUP ............................................................ 53

© EVE-NG LTD Page 2 of 152

EVE-NG Community Cookbook
Version 5.1

3.7.1 Windows Native Console ................................................................................... 53

3.7.2 Linux Native Console ......................................................................................... 54
3.7.3 MAC OSX Native Console ................................................................................. 55
3.8 LOGIN TO THE EVE WEB GUI ..................................................................................... 57
4 EVE-NG COMMUNITY UPDATE & UPGRADE .............................................................. 58
4.1 EVE-NG COMMUNITY UPDATE .................................................................................... 58
4.2 EVE-NG COMMUNITY UPGRADE .................................................................................. 59
5 TYPES OF EVE MANAGEMENT CONSOLES ............................................................... 61
5.1 NATIVE CONSOLE ........................................................................................................ 61
5.1.1 Native Console: telnet ........................................................................................ 61
5.1.2 Native Console: Wireshark ................................................................................ 62
5.1.3 Native Console: VNC ......................................................................................... 64
5.1.4 Native Console: RDP ......................................................................................... 64
5.2 HTML5 CONSOLE........................................................................................................ 65
5.2.1 HTML5 Console: Telnet ..................................................................................... 66
5.2.2 HTML5 Console: VNC ....................................................................................... 66
5.2.3 HTML5 Console: RDP for Windows .................................................................. 67
6 EVE WEB GUI MANAGEMENT ...................................................................................... 69
6.1 EVE MANAGEMENT PAGE............................................................................................ 69
6.1.1 Management buttons ......................................................................................... 69
6.1.2 Management tabs .............................................................................................. 70
6.2 FOLDERS AND LAB FILES MANAGEMENT ........................................................................ 71
6.2.1 Folders Management ......................................................................................... 71
6.2.1.1 Create folder ............................................................................................................................. 71
6.2.1.2 Delete folder ............................................................................................................................. 71
6.2.1.3 Move Folder .............................................................................................................................. 71
6.2.1.4 Export Folder ............................................................................................................................. 71
6.2.1.5 Import Folder ............................................................................................................................ 72
6.2.2 Lab files Management........................................................................................ 73
6.2.2.1 Create Lab ................................................................................................................................. 73
6.2.2.2 Delete Lab ................................................................................................................................. 73
6.2.2.3 Clone Lab ................................................................................................................................... 74
6.2.2.4 Move Lab................................................................................................................................... 74
6.2.2.5 Export Lab ................................................................................................................................. 75
6.2.2.6 Import Labs ............................................................................................................................... 75
6.3 EVE MANAGEMENT DROPDOWN MENU ........................................................................ 76
6.3.1 EVE User management ..................................................................................... 76
6.3.1.1 Creating a new EVE User ........................................................................................................... 77
6.3.1.2 Edit EVE User ............................................................................................................................. 77
6.3.1.3 User monitoring ........................................................................................................................ 78
6.4 EVE SYSTEM DROPDOWN MENU .................................................................................. 78
6.4.1 System status .................................................................................................... 78
6.4.2 System logs ....................................................................................................... 79
6.4.3 Stop All Nodes ................................................................................................... 80
6.5 EVE INFORMATION DROPDOWN MENU.......................................................................... 80
6.6 OTHER TAB LINE INFO .................................................................................................. 80
6.7 LAB PREVIEW AND GLOBAL SETTINGS ............................................................................ 80
6.7.1 Lab preview window ........................................................................................... 81
6.7.2 Lab preview buttons ........................................................................................... 81
6.7.3 Lab preview information ..................................................................................... 81
6.7.4 Lab Global Settings............................................................................................ 82
7 EVE WEB TOPOLOGY PAGE ........................................................................................ 84
7.1 SIDE BAR FUNCTIONS ................................................................................................... 84
7.1.1 Add an object ..................................................................................................... 85
7.1.1.1 Node object ............................................................................................................................... 85

© EVE-NG LTD Page 3 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.1.2 Network object.......................................................................................................................... 85

7.1.1.3 Picture object ............................................................................................................................ 86
7.1.1.4 Custom shape object ................................................................................................................. 86
7.1.1.5 Text object ................................................................................................................................ 86
7.1.2 Nodes ................................................................................................................. 87
7.1.3 Networks ............................................................................................................ 88
7.1.4 Startup-configs ................................................................................................... 89
7.1.5 Logical Maps ...................................................................................................... 89
7.1.6 Configured Objects ............................................................................................ 89
7.1.7 More actions ...................................................................................................... 90
7.1.7.1 Start all nodes ........................................................................................................................... 90
7.1.7.2 Stop all nodes ............................................................................................................................ 90
7.1.7.3 Wipe all nodes ........................................................................................................................... 90
7.1.7.4 Console to All Nodes ................................................................................................................. 91
7.1.7.5 Export all CFGs .......................................................................................................................... 91
7.1.7.6 Edit lab ...................................................................................................................................... 91
7.1.7.7 Set node’s startup-cfg to default configset ............................................................................... 91
7.1.7.8 Set node’s startup-cfg to none .................................................................................................. 92
7.1.7.9 Delete default startup-cfgs........................................................................................................ 92
7.1.8 Refresh Topology ............................................................................................... 92
7.1.9 Lab page zoom/unzoom .................................................................................... 92
7.1.10 Status ................................................................................................................. 92
7.1.11 Lab details .......................................................................................................... 93
7.1.12 Lock Lab with password..................................................................................... 93
7.1.13 Dark mode or Light mode .................................................................................. 94
7.1.14 Close lab ............................................................................................................ 94
7.1.15 Logout ................................................................................................................ 94
7.2 EVE LAB TOPOLOGY MENUS ........................................................................................ 94
7.2.1 Lab topology menu ............................................................................................ 94
7.2.2 Connection menu ............................................................................................... 95
7.2.3 Cloud or Bridge network menu .......................................................................... 95
7.2.4 Stopped node menu........................................................................................... 96
7.2.5 Running node menu........................................................................................... 96
7.2.6 Selected nodes menu and features ................................................................... 97
7.3 EVE LAB NODE STATES AND SYMBOLS........................................................................ 100
7.3.1 Stopped (non-running) nodes .......................................................................... 100
7.3.2 Running nodes ................................................................................................. 100
7.3.3 Node connector symbol ................................................................................... 101
7.4 OTHER ...................................................................................................................... 101
7.4.1 Notifications area ............................................................................................. 101
8 WORKING WITH EVE LABS ........................................................................................ 102
8.1 CREATING A LAB ........................................................................................................ 102
8.1.1 Adding nodes to the lab ................................................................................... 102
8.1.1.1 Node values Table ................................................................................................................... 104
8.1.2 Edit node .......................................................................................................... 107
8.1.2.1 Edit nodes globally .................................................................................................................. 107
8.1.2.2 Edit node individually. ............................................................................................................. 108
8.1.3 Wipe Node ....................................................................................................... 109
8.1.4 Interconnecting nodes...................................................................................... 109
8.1.5 Delete connection between nodes ................................................................... 109
8.1.6 Delete Node ..................................................................................................... 110
8.2 RUNNING LABS .......................................................................................................... 110
8.2.1 Starting lab ....................................................................................................... 110
8.3 SAVING LABS ............................................................................................................. 110
8.4 STOPPING LABS ......................................................................................................... 111
8.5 START SAVED LAB...................................................................................................... 111
8.6 IMPORTING LABS........................................................................................................ 111
8.7 EXPORTING LABS ....................................................................................................... 111

© EVE-NG LTD Page 4 of 152

EVE-NG Community Cookbook
Version 5.1

8.8 DELETING LABS ......................................................................................................... 111

8.9 MOVING LABS ............................................................................................................ 112
9 EVE CLOUDS AND NETWORKS ................................................................................. 113
9.1 BRIDGE NETWORK ..................................................................................................... 113
9.2 MANAGEMENT CLOUD0 INTERFACE ............................................................................ 114
9.3 OTHER CLOUD INTERFACES........................................................................................ 116
9.4 CONNECTING EXTERNAL VM MACHINES TO THE EVE LAB ............................................ 118
9.4.1 ESXi VM machines .......................................................................................... 118
9.4.2 VMWare workstation machines ....................................................................... 120
9.5 CONNECTING EVE LAB TO A PHYSICAL DEVICE ........................................................... 122
9.5.1 ESXi EVE ......................................................................................................... 122
9.5.2 VMWare workstation EVE ............................................................................... 124
9.5.3 Bare metal server EVE .................................................................................... 126
10 ADVANCED EVE LAB FEATURES .......................................................................... 127
10.1 LAB DESIGN OBJECTS ............................................................................................. 127
10.1.1 Custom shape .................................................................................................. 127
10.1.2 Resize square or circle objects ........................................................................ 128
10.1.3 Text object ....................................................................................................... 128
10.1.4 Add custom picture on the Lab using Text object feature ............................... 129
10.1.5 Cloning objects and overlay positions ............................................................. 130
10.1.6 Objects Editing ................................................................................................. 130
10.1.7 Lock objects movement ................................................................................... 131
10.2 CUSTOM DESIGN LOGICAL TOPOLOGY ..................................................................... 131
10.2.1 Custom design upload ..................................................................................... 131
10.2.2 Custom topology mapping ............................................................................... 132
10.2.3 Delete topology or mapping ............................................................................. 133
10.3 CONFIGURATION EXPORT FEATURE ......................................................................... 134
10.3.1 Supported nodes for configuration exports ...................................................... 135
10.3.2 Startup config management ............................................................................. 135
10.3.2.1 Global commands ............................................................................................................... 135
10.3.2.2 Individual node commands ................................................................................................. 135
10.3.2.3 Multiple selected nodes commands ................................................................................... 136
10.3.2.4 Startup-configuration window ............................................................................................ 136
10.3.2.5 Startup-config window information ................................................................................... 137
10.3.3 Export configuration ......................................................................................... 137
10.3.4 Boot nodes from exported config set ............................................................... 138
10.3.5 Edit exported configurations ............................................................................ 138
10.3.6 Set lab to boot from none ................................................................................ 139
10.3.7 Lab config script timeout .................................................................................. 139
11 EVE TROUBLESHOOTING ....................................................................................... 141
11.1 CLI DIAGNOSTIC INFORMATION DISPLAY COMMANDS ................................................ 141
11.1.1 Display full EVE Community diagnostic ........................................................... 141
11.1.2 Display the currently installed EVE Community version: ................................. 141
11.1.3 Display if EVEs Intel VT-x/EPT option on/off: .................................................. 141
11.1.4 Display EVEs CPU INFO: ................................................................................ 141
11.1.5 Display EVEs HDD utilization. ......................................................................... 141
11.1.6 Display EVEs Bridge interface status .............................................................. 142
11.1.7 Display EVEs system services status .............................................................. 142
11.2 EXPAND EVES SYSTEM HDD................................................................................. 142
11.2.1 Expand HDD on VMware Workstation ............................................................. 142
11.2.2 Expand your HDD on ESXi .............................................................................. 143
11.2.3 Expand your HDD on a Bare Metal EVE Server ............................................. 143
11.3 RESET MANAGEMENT IP ........................................................................................ 144
11.4 EVE COMMUNITY SQL DATABASE RECOVERY ........................................................ 144
11.5 EVE LOG FILES ..................................................................................................... 144

© EVE-NG LTD Page 5 of 152

EVE-NG Community Cookbook
Version 5.1

11.6 EVE CLI DIAGNOSTIC INFO ...................................................................................... 144

12 IMAGES FOR EVE ..................................................................................................... 145
12.1 QEMU IMAGE NAMING TABLE ................................................................................... 145
12.2 HOW TO PREPARE IMAGES FOR EVE ....................................................................... 146
12.3 HOW TO ADD CUSTOM IMAGE TEMPLATE .................................................................. 146
12.3.1 Templates folder choice ................................................................................... 146
12.3.2 Prepare template file ........................................................................................ 146
12.3.3 Prepare interface format and name lines......................................................... 147
12.3.4 Edit your new template file: .............................................................................. 148
12.3.5 Prepare new icon for your template: ................................................................ 149
12.3.6 Template use ................................................................................................... 150
12.4 HOW TO HIDE UNUSED IMAGES IN THE NODE LIST ..................................................... 150
12.4.1 Creating new config.php file ............................................................................ 150
12.4.2 Edit config.php file ............................................................................................ 150
13 EVE RESOURCES ..................................................................................................... 152

© EVE-NG LTD Page 6 of 152

EVE-NG Community Cookbook
Version 5.1

Preface
When I first heard about EVE-NG I was skeptical. Back then I used to Lab mainly with ESX by
deploying many virtual Devices and connecting them manually by separate vSwitches for Point-
to-Point connections. The Problem with that was, that it was extremely time-consuming and did
not scale - for every new Device I had to create multiple vSwitches to interconnect them with
the virtual Machines - a Nightmare. I was in the middle of my JNCIE-Exam-Prep when I first
saw EVE-NG on Twitter - I downloaded the Community Edition, which was the only Edition
back then and I was amazed how easy Labbing all of a sudden was. No more deploying of
vSwitches to interconnect nodes and boy did it Scale…
If you follow me on Twitter you know, that I'm one of the hardest Juniper Fanboys and of course
my Goal was to "Juniperize" EVE. I started to get in touch with Uldis and Alain and found myself
into the Position as one of the Juniper Test Guys. Meanwhile I added nearly all Juniper related
Devices (including cSRX and JATP) and I still test a Lot - but now on EVE-Pro.
The Pro-Edition was a big step forward for the Project. It added some nice Features like "hot-
add-interconnect" and the Ability to use EVE-NG with multiple Users. Especially Companies
will love EVE as it is THE Solution for Labs and PoC's. I have successfully run over 30 PoC's
in EVE and over 100 Labs (Job-Related and Personal Labs) - and I still enjoy it every day
thanks to EVE and the amazing Team behind it. When the Guys asked me to write the
Introduction I was of course honored and now this Book is finally coming out to help you on
your Quest to Setup, Run and Manage EVE-NG in a lot of possible ways.

Well - enough from my Side. I hope you enjoy this Cookbook and use it wisely for your Everyday
EVE Work. If you have Problems there is always the EVE-Forum and Live-Helpdesk - you will
also find me there from time to time ;)
I wish you happy reading and if you think, that this Product is amazing feel free to support it by
buying the PRO-Edition or Donating a bit – it helps to expand this already cool Product even
more and it also honors all the work that the Guys spent in it.

Christian Scholz
@chsjuniper

© EVE-NG LTD Page 7 of 152

EVE-NG Community Cookbook
Version 5.1

1 Introduction
1.1 What is EVE-NG?
To describe what Emulated Virtual Environment – Next Generation (EVE-NG) is without solely
stating dry facts about features, we need to elaborate more on what EVE-NG can be used for
and whom it would be useful for.
In some trivial dry words, EVE-NG gives you tools to use around virtual devices and
interconnect them with other virtual or physical devices. Many of its features greatly simplify the
usabilities, re-usability, manageability, interconnectivity, distribution and therefore the ability to
understand and share topologies, work, ideas, concepts or simply “labs”. This can simply mean
it will reduce the cost and time to set up what you need or it might enable you to do tasks you
would not have thought could be done this simple.

1.2 What is EVE-NG used for?

This is the real question but there is no finite answer, the possibilities are almost limitless and
depends on what you want to use it for.
It can be used for studying all kinds of technologies. You can learn about general technologies
or vendor specific topics. You can test new technologies like network automation, SDN, etc.
It can be used to recreate corporate networks and test changes before putting them into
production. You can create proof of concepts for clients. You can troubleshoot network issues
by recreating them and e.g. use Wireshark to inspect packets.
It is most definitely not just for networking, it can be used to test software in simulated networks,
test out security vulnerabilities of any kind, system engineering like LDAP and AD servers and
many more areas.
You could set it up to automate sandboxing unknown files/software and use software to analyse
short and long term behaviour for malicious intent much simpler than without EVE-NG.
The list of what EVE-NG can be used for could go on indefinitely, possibilities are limited by
knowledge and imagination only. Both of which can be improved with EVE-NG.
To get a very small idea of what can be done with EVE-NG, check out the tested/supported
images (many have not been tested, almost everything virtual should run on EVE-NG) and refer
to section 12.
EVE-NG helps you achieve what you want to and more.

1.3 Who is EVE-NG for?

EVE-NG is for everyone working in the Information Technology Sector, period.
It is for very large enterprise companies, training facilities, service providers, consultants,
people who want to train themselves; it is for everyone, it is for YOU!
Use-cases that are more than worth it, almost priceless even, can be found everywhere.

The EVE-NG community version is free for everyone; while the paid professional version adds
a few things that make your life easier. Almost everything can still be done with the free version,
just less conveniently and therefore more time-consuming.
However, with the free version, the possibility to train yourself with technologies, hone your
skills and become an expert even with very no monetary possibilities. For some this is and has
been life changing.

© EVE-NG LTD Page 8 of 152

EVE-NG Community Cookbook
Version 5.1

2 System requirements
EVE-NG is available in the OVF or ISO file format. The Open Virtualization Format (OVF) is an
open standard for packaging and distributing virtual appliances. It can be used to deploy a VM
in hypervisors like VMware Workstation, Player and ESXi. Please note that installing EVE as a
Virtual Machine (VM) will mean any nodes deployed within EVE will be nested. Nested
virtualization causes degraded performance in deployed nodes. This should be fine for lab
purposes as long as the host meets or exceeds the resource requirements for the deployed
nodes.

EVE-NG can also be installed directly on physical hardware, without a hypervisor, using the
provided ISO image. This is referred to as a “bare metal” install and is the most recommended
method of installing EVE-NG.

2.1 Hardware requirements

2.1.1 Minimal Laptop/PC Desktop system requirements

Prerequisites:

CPU: Intel CPU supporting Intel® VT-x /EPT virtualization

Operating System: Windows 10, 11 or Linux Desktop
VMware Workstation 15.0 or later
VMware Player 15.0 or later

PC/Laptop HW requirements
CPU Intel i7 (4 Logical processors), Enabled Intel virtualization in
BIOS
RAM 8Gb
HDD Space 40Gb
Network LAN/WLAN
EVE Virtual machine requirements
CPU 4/1 (Number of processors/Number of cores per processor)
Enabled Intel VT-x/EPT virtualization engine
RAM 6Gb or more
HDD 40Gb or more
Network VMware NAT or Bridged network adapter

Note: Minimal PC Desktop/Laptop will be able to run small Labs. The performance and quantity
of nodes per lab depend on the types of nodes deployed in the lab.

Example:
IOL image-based nodes: up to 40-50 nodes per lab
Dynamips image-based nodes: up to 20-25 nodes per lab
vIOS image-based nodes: up to 8-10 nodes per lab
CSRv1000 or XRv image-based nodes: up to 2-3 per lab

© EVE-NG LTD Page 9 of 152

EVE-NG Community Cookbook
Version 5.1

2.1.2 Recommended Laptop/PC Desktop system requirements

Prerequisites:

CPU: Intel CPU supporting Intel® VT-x /EPT virtualization

Operation System: Windows 10, 11 or Linux Desktop
VMware Workstation 15.0 or later
VW Ware Player 15.0 or later

PC/Laptop HW requirements
CPU Intel i7 (8 Logical processors), Enabled Intel virtualization in
BIOS
RAM 32Gb
HDD Space 200Gb
Network LAN/WLAN
EVE Virtual machine requirements
CPU 8/1 (Number of processors/Number of cores per processor)
Enabled Intel VT-x/EPT virtualization engine
RAM 24Gb or more
HDD 200Gb or more
Network VMware NAT or Bridged network adapter

Note: PC Desktops/Laptops will be able to run small to medium Labs. Performance and quantity
of nodes per lab depend on the type of nodes deployed in the lab.

Example:
IOL image-based nodes: up to 120 nodes per lab
vIOS image-based nodes: up to 20-40 nodes per lab
CSR image-based nodes: up to 10 per lab

2.1.3 Virtual Server system requirements

Prerequisites:

CPU: Intel Xeon CPU supporting Intel® VT-x with Extended Page Tables (EPT)
Operation System: ESXi 6.5 or later

Server HW requirements
CPU Recommended CPU 2x Intel E5-2650v3 (40 Logical processors)
or better supporting Intel® VT-x with Extended Page Tables
(EPT)
Minimum CPU is any Intel Xeon CPU supporting Intel® VT-x
with Extended Page Tables (EPT)
RAM 128Gb
HDD Space 2Tb
Network LAN Ethernet
EVE Virtual machine requirements
CPU 32/1 (Number of processors/Number of cores per processor)
Enabled Intel VT-x/EPT virtualization engine
RAM 64Gb or more
HDD 800Gb or more

© EVE-NG LTD Page 10 of 152

EVE-NG Community Cookbook
Version 5.1

Network vSwitch/VMnet

Note: Performance and quantity of nodes per lab depends from the type of nodes used in the
lab.

Example:
120 IOL image-based lab
20 CSRv1000 image-based nodes per lab

2.1.4 Dedicated Server (bare) system requirements

Prerequisites:

CPU: Intel Xeon CPU supporting Intel® VT-x with Extended Page Tables (EPT)
Operation System: Ubuntu Server 20.04.4 LTS x64

Server HW requirements
CPU Recommended CPU Intel E5-2650v3 (40 Logical processors) or
better supporting Intel® VT-x with Extended Page Tables (EPT)
Minimum CPU is any Intel Xeon CPU supporting Intel® VT-x
with Extended Page Tables (EPT)
RAM 128Gb
HDD Space 2Tb
Network LAN Ethernet

Note: Performance and quantity of nodes per lab depends from type of nodes used in the lab.

2.1.5 Nodes per lab calculator

It is recommended to use the “nodes per lab calculator” to achieve best performance and avoid
overloading your EVE system.

https://drive.google.com/file/d/1Rbu7KDNSNuWiv_AphWx0vCek8CKVB1WI/view

2.2 Supported virtualization platforms and software

• VMware Workstation 15.0 or later

• VMware Player 15.0 or later

• VMware ESXi 6.5 or later

• Ubuntu Server 20.04 LTS as platform for bare metal

• Google Cloud Platform

2.3 Unsupported hardware and systems

The following are currently not supported:

• VirtualBox virtualization

© EVE-NG LTD Page 11 of 152

EVE-NG Community Cookbook
Version 5.1

• Citrix XenServer

• Microsoft HyperV

© EVE-NG LTD Page 12 of 152

EVE-NG Community Cookbook
Version 5.1

3 Installation
3.1 VMware Workstation or VM Player

3.1.1 VMware workstation EVE VM installation using ISO image

(preferred)

Mandatory Prerequisites: Internet must be reachable from your PC and VMware. EVE ISO
installation requires internet access to get updates and install the latest EVE-COMM version
from the EVE-NG repository. DNS must work as well, to check it, do a named ping, for example
ping www.google.com

Download EVE-NG Community ISO distribution image:

https://www.eve-ng.net/downloads/eve-ng-2

3.1.1.1 EVE VM Setup and Settings

Step 1: Create a New Virtual machine Step 2: Select “I will install the operating
system later”

© EVE-NG LTD Page 13 of 152

EVE-NG Community Cookbook
Version 5.1

Step 3: Select a Guest Operating system: Step 4: Enter the name for your EVE-
Linux and select the version: Ubuntu 64-bit COMM VM and select Location where your
EVE VM will be stored on the host PC.

Step 5: Select max Number of processors, Step 6: Assign desirable memory for your
and Number of cores per processor =1 EVE VM

© EVE-NG LTD Page 14 of 152

EVE-NG Community Cookbook
Version 5.1

Step 7: Select then network for your EVE Step 8: Leave recommended I/O settings,
VM. For Laptop it is recommended to use LSI Logic
NAT Adaptor

Step 9: Leave recommended Disk Type Step 10: Select Create a new virtual disk
(SCSI) settings

© EVE-NG LTD Page 15 of 152

EVE-NG Community Cookbook
Version 5.1

Step 11: Select your desirable HDD size. It Step 12: Select Customize Hardware
is recommended to set minimum 200Gb or
more. Select Store virtual disk as single file.

Step 13: IMPORTANT! Select CPU and Step 14: Select CD/DVD Option: “use ISO
Enable Virtualize Intel VT-x/EPT option image file.” Browse to your downloaded
eve-com-v5.iso (actual name can be
different) file

© EVE-NG LTD Page 16 of 152

EVE-NG Community Cookbook
Version 5.1

Step 15: Click Finish to complete VM setup

3.1.1.2 EVE-NG VM Installation steps

Mandatory Prerequisites: Internet must be reachable from your PC and VMware. EVE ISO
installation requires internet access to get updates and install the latest EVE-PRO version from
the EVE-NG repository. DNS must work as well, to check it, do a named ping, for example ping
www.google.com

EVE VM Installation from ISO has 3 Phases

Phase 1 (Ubuntu installation)

Step 1: Power ON EVE VM. Chose Install Step 2: Select English language. Confirm
EVE-NG Community Server and confirm with Enter.
with Enter.

© EVE-NG LTD Page 17 of 152

EVE-NG Community Cookbook
Version 5.1

Step 3: Make sure if English US keyboard is Step 4: If your network has DHCP
selected and confirm with Enter. ENABLED, Continue to Step 10

Step 5: If your network has not DHCP. Step 6: Confirm interface selection with
Static IP setup. If you have not enabled Enter, select “Edit IPv4” and confirm with
DHCP in the network, you must assign an Enter again.
IP address manually. Use arrow UP key to
select your interface for IP
address.assignment.

Step 7: Hit Enter on IPv4 Method and select Step 8: Enter your “Subnet”, “IP Address”,
“Manual”, confirm with Enter. “Gateway IP”, “Domain server IPs” and
“Search domain”. Select “Save” and confirm
with Enter. NOTE, it is very important that
your DNS (Name servers) will resolve

© EVE-NG LTD Page 18 of 152

EVE-NG Community Cookbook
Version 5.1

Internet names.

Step 10: If your DHCP IP settings are

Step 9: Select “Done” and confirm with correct, select Done and confirm with Enter.
Enter

Step 11: If you have proxy in use for your Step 12: Select “Continue” and confirm with
internet, assign your network proxy settings. Enter.
If no proxy in use, with Tab key select
Continue and confirm with Enter.

© EVE-NG LTD Page 19 of 152

EVE-NG Community Cookbook
Version 5.1

EVE VM Installation Phase 2 (EVE installation)

Step 13: After the Ubuntu “Install Complete” Step 14: Without powering off the EVE VM,
select “Reboot Now” and hit Enter to open the EVE VM settings and remove
continue. CD/DVD ISO Device. Save VM Settings.

Step 15: Return back to EVE console screen Step 16: Depending on your internet speed
and confirm Continue with Enter, EVE VM EVE installation will take some time. After
will reboot and continue Phase 2 installation installation EVE VM will auto reboot and EVE
login screen will appear, login in CLI with
root/eve and follow installation Phase 3

EVE VM Installation Phase 3 (Management IP setup and updates)

Step 17: Setup EVE Management IP Step 18: After your EVE is rebooted,
address. A Static IP address setup is
preferred Login to EVE CLI and type:

apt update

© EVE-NG LTD Page 20 of 152

EVE-NG Community Cookbook
Version 5.1

Follow steps in section : apt upgrade

3.5.1 for static IP, 3.5.2 for DHCP IP

Step 19: On the EVE CLI prompt, reboot

EVE by typing

reboot

NOTE: Verify your EVE-NG server installation, type “dpkg -l eve-ng” command, it must display
latest EVE Community version

root@eve-ng:~# dpkg -l eve-ng

Desired=Unknown/Install/Remove/Purge/Hold
| Status=Not/Inst/Conf-files/Unpacked/halF-conf/Half-inst/trig-
aWait/Trig-pend
|/ Err?=(none)/Reinst-required (Status,Err: uppercase=bad)
||/ Name Version Architecture Description
+++-==============-============-============-
==============================================
ii eve-ng 5.0.1-10 amd64 A new generation software
for networking labs.
root@eve-ng:~#

NOTE: If your newly installed EVE-NG Community shows nothing like above, you must check
your internet reachability and verify DNS configuration on your EVE-PRO server.

root@eve-ng:~# ping www.google.com

PING www.google.com (172.217.22.164) 56(84) bytes of data.
64 bytes from arn09s11-in-f164.1e100.net (172.217.22.164): icmp_seq=1
ttl=120 time=8.84 ms
64 bytes from arn09s11-in-f164.1e100.net (172.217.22.164): icmp_seq=2
ttl=120 time=8.84 ms
^C
--- www.google.com ping statistics ---
2 packets transmitted, 2 received, 0% packet loss, time 1001ms
rtt min/avg/max/mdev = 8.848/8.848/8.849/0.094 ms
root@eve-ng

Launch EVE-NG Community installation manually

root@eve-ng:~# cd /etc
root@eve-ng:~# ./eve-setup

IMPORTANT NOTE: You must prepare and upload at least a couple of images to start
building your labs. Refer to section 12

3.1.2 VMware workstation OVF deployment

Download EVE-NG Community OVF image zip file, place it in the dedicated HDD storage for
EVE VM and unzip it:

© EVE-NG LTD Page 21 of 152

EVE-NG Community Cookbook
Version 5.1

https://www.eve-ng.net/index.php/download/#DL-COMM

3.1.2.1 Deployment and VM machine settings

Step 1: VMware workstation or VM Player, Step 2: Browse your downloaded and

Open Virtual Machine unzipped EVE-COM-5, EVE-COM-5.ovf,
followed by Open

Step 3: Browse your desired EVE VM store Step 4: Open your EVE VM Settings and
destination followed by Import set the desired RAM.

Step 5: IMPORTANT Set CPU Number of Step 6: Laptop PC Select your desirable
Cores and number of cores per processor. Network Adapter.
Set Intel VT-x/EPT Virtualization engine to
ON (checked). NOTE: It is recommended to choose the
NAT adapter option for Laptops to avoid
NOTE: VMware Player will display only one EVE management interface IP changes.
CPU option: Number of processors. This can happen anytime the laptop is
connected to a different SSID.

© EVE-NG LTD Page 22 of 152

EVE-NG Community Cookbook
Version 5.1

Step 7: Desktop PC Select your desirable Step 8: Power ON your EVE VM and follow
Network Adapter. Management IP setup instructions described
in section 3.5.1 for Static IP or 3.5.2 for
NOTE: Desktop PC EVE management DHCP IP.
interface can be either NAT or Bridged to
home LAN subnet.

IMPORTANT NOTE: You must prepare and upload at least a couple of images to start
building your labs. Refer to section 12

3.1.2.2 OVF VM update to the latest EVE version

Step 9: Make sure if your EVE OVF VM is up to date to the newest EVE version.
Follow the steps described in section 4.

© EVE-NG LTD Page 23 of 152

EVE-NG Community Cookbook
Version 5.1

3.1.2.3 OVF VM HDD Size expansion

IMPORTANT NOTE: DO NOT expand the current EVE OVF HDD. To expand your EVE
system size, please follow Troubleshooting section 11.2

3.2 VMware ESXi

3.2.1 VMware ESXi EVE installation using ISO image (preferred)

Mandatory Prerequisites: Internet must be reachable from your Server and ESXi. EVE ISO
installation requires internet access to get updates and install the latest EVE-COMM version
from the EVE-NG repository. DNS must work as well, to check it, do a named ping, for example
ping www.google.com

Download EVE-NG Community ISO installation image:

http://www.eve-ng.net/downloads/eve-ng-2

3.2.1.1 EVE-NG ESXi VM Setup and Settings

Step 1: Upload EVE ISO image to the ESXi Step 2: Create NEW VM
store.

Step 3: Enter the name for your EVE-PRO Step 4: Select Location where your EVE VM
VM and select Guest Operating system will be stored in HDD.
Linux and version: Ubuntu 64-bit

© EVE-NG LTD Page 24 of 152

EVE-NG Community Cookbook
Version 5.1

Step 5: IMPORTANT Customize your EVE Step 6: Assig desirable RAM for your EVE
VM CPU Settings. Set CPU Number of
Cores and number of cores per processor.
Set Intel VT-x/EPT Virtualization to ON
(checked).

Step 7: Set the size of HDD for your new Step 8: Set your Management network.
EVE VM. It is recommended to set “Thick Adapter type VMXNET3
Provisioned eagerly provisioned”. Server
EVE HDD is recommended to set at least
500Gb

NOTE: Additional Network Adapters can be

added for further use.

© EVE-NG LTD Page 25 of 152

EVE-NG Community Cookbook
Version 5.1

Step 9: Add new device to your EVE VM, Step 10: Set DVD drive to “Datastore ISO
CD/DVD File” and browse your uploaded EVE-
PRO.iso. Make sure that Status is checked
ON, “Connect at power on”

3.2.1.2 EVE-NG ESXi VM Installation steps

Mandatory Prerequisites: Internet must be reachable from your PC and VMware. EVE
ISO installation requires internet access to get updates and install the latest EVE-PRO
version from the EVE-NG repository. DNS must work as well, to check it, do a named
ping, for example ping www.google.com

EVE ESXi VM Installation from ISO has 3 Phases

Phase 1 (Ubuntu installation)

Step 1: Power ON EVE VM. Chose Install Step 2: Select English language. Confirm
EVE-NG Community Server and confirm with Enter.
with Enter.

Step 3: Make sure if English US keyboard is Step 4: If your network has DHCP
selected and confirm with Enter. ENABLED, Continue to Step 10

© EVE-NG LTD Page 26 of 152

EVE-NG Community Cookbook
Version 5.1

© EVE-NG LTD Page 27 of 152

EVE-NG Community Cookbook
Version 5.1

Internet names.

Step 10: If your DHCP IP settings are

Step 9: Select “Done” and confirm with correct, select Done and confirm with Enter.
Enter

© EVE-NG LTD Page 28 of 152

EVE-NG Community Cookbook
Version 5.1

EVE VM Installation Phase 2 (EVE installation)

EVE VM Installation Phase 3 (Management IP setup and updates)

Step 17: Setup EVE Management IP Step 18: After your EVE is rebooted,
address. A Static IP address setup is
preferred Login to EVE CLI and type:

Follow steps in section : apt update

apt upgrade
3.5.1 for static IP, 3.5.2 for DHCP IP

© EVE-NG LTD Page 29 of 152

EVE-NG Community Cookbook
Version 5.1

Step 19: On the EVE CLI prompt, reboot

EVE by typing

reboot

NOTE: Verify your EVE-NG server installation, type “dpkg -l eve-ng” command, it must display
latest EVE Community version

root@eve-ng:~# dpkg -l eve-ng

NOTE: If your newly installed EVE-NG Community shows nothing like above, you must check
your internet reachability and verify DNS configuration on your EVE-PRO server.

root@eve-ng:~# ping www.google.com

Launch EVE-NG Community installation manually

root@eve-ng:~# cd /etc
root@eve-ng:~# ./eve-setup

IMPORTANT NOTE: You must prepare and upload at least a couple of images to start
building your labs. Refer to section 12

3.2.2 VMware ESXi OVF deployment

Download EVE-NG Community OVF image zip file, place it in the dedicated HDD storage for
EVE VM and unzip it:
https://www.eve-ng.net/index.php/download/#DL-COMM

© EVE-NG LTD Page 30 of 152

EVE-NG Community Cookbook
Version 5.1

3.2.2.1 ESXi OVF VM Setup and Settings

Step 1: ESXi Host, Create/Register VM Step 2: Set option Deploy a virtual machine
from an OVF or OVA file

Step 3: Type the name for your new EVE Step 4: Select the storage where your EVE
VM and browse to select your all VM will be deployed.
downloaded EVE OVF files

Step 5: Select your Management network Step 6: IMPORTANT Open VM Settings.

and Thick Disk provisioning. EVE OVF Set the quantity of CPUs and number of
HDD is only 100Gb large. It is cores per socket. Set Intel VT-x/EPT
recommended after installation to add extra Hardware Virtualization engine to ON
HDD. Section 11.2 (checked).

© EVE-NG LTD Page 31 of 152

EVE-NG Community Cookbook
Version 5.1

Step 7: Set desirable RAM for your EVE. Step 8: Power ON your EVE VM and follow
Management IP setup instructions described
in section 3.5.1 for Static IP or 3.5.2 for
DHCP IP.

IMPORTANT NOTE: You must prepare and upload at least a couple of images to start
building your labs. Refer to section 12

3.2.2.2 ESXi OVF VM update to the latest EVE version

Make sure that your EVE OVF VM is up to date with the newest EVE version.
Follow the steps described in section 4 for upgrade instructions

3.2.2.3 ESXi OVF VM HDD Size expansion

NOTE: IMPORTANT! DO NOT expand the current EVE OVF HDD. To expand your EVEs
system disk size, please follow the troubleshooting section 11.2

3.3 Bare hardware server EVE installation

Mandatory Prerequisites: Internet must be reachable from your Server. EVE ISO installation
requires internet access to get updates and install the latest EVE-COMM version from the EVE-
NG repository. DNS must work as well, to check it, do a named ping, for example ping
www.google.com

3.3.1 EVE-NG Community BM Server Installation

Phase 1 (Ubuntu installation)

© EVE-NG LTD Page 32 of 152

EVE-NG Community Cookbook
Version 5.1

Step 1: Create a bootable DVD disk or USB

flash drive with an Ubuntu server image. Step 2: Select English language. Confirm
Boot your server from ISO. Chose Install with Enter.
EVE-NG Community Server and confirm
with Enter.

Step 3: Make sure if English US keyboard is Step 4: If your network has DHCP
selected and confirm with Enter. ENABLED, Continue to Step 10

© EVE-NG LTD Page 33 of 152

EVE-NG Community Cookbook
Version 5.1

address.assignment.

Step 10: If your DHCP IP settings are

Step 9: Select “Done” and confirm with correct, select Done and confirm with Enter.
Enter

© EVE-NG LTD Page 34 of 152

EVE-NG Community Cookbook
Version 5.1

EVE VM Installation Phase 2 (EVE installation)

Step 13: After the Ubuntu “Install Complete” Step 14: Remove CD/DVD ISO Media.
select “Reboot Now” and hit Enter to
continue.

Step 15: Return back to EVE console screen Step 16: Depending on your internet speed
and confirm Continue with Enter, EVE VM EVE installation will take some time. After
installation EVE VM will auto reboot and EVE
login screen will appear, login in CLI with

© EVE-NG LTD Page 35 of 152

EVE-NG Community Cookbook
Version 5.1

will reboot and continue Phase 2 installation root/eve and follow installation Phase 3

EVE Installation Phase 3 (Management IP setup and updates)

Step 17: Setup EVE Management IP Step 18: After your EVE is rebooted,
address. A Static IP address setup is
preferred Login to EVE CLI and type:

Follow steps in section : apt update

apt upgrade
3.5.1 for static IP, 3.5.2 for DHCP IP

NOTE: Verify your EVE-NG server installation, type “dpkg -l eve-ng” command, it must display
latest EVE Community version

root@eve-ng:~# dpkg -l eve-ng

NOTE: If your newly installed EVE-NG Community shows nothing like above, you must check
your internet reachability and verify DNS configuration on your EVE-PRO server.

root@eve-ng:~# ping www.google.com

© EVE-NG LTD Page 36 of 152

EVE-NG Community Cookbook
Version 5.1

root@eve-ng

Launch EVE-NG Community installation manually

root@eve-ng:~# cd /etc
root@eve-ng:~# ./eve-setup

IMPORTANT NOTE: You must prepare and upload at least a couple of images to start
building your labs. Refer section 12

3.4 Google Cloud Platform

3.4.1 Google account

Step 1: Connect to Google Cloud Platform (GCP
https://console.cloud.google.com/getting-started

Step 2: Sign into GCP. Create a new GCP account if you do not already have one.

3.4.2 Goggle Cloud project

Create new project. By default, GCP will offer you a project named “My First Project”. It can be
used as well.

Step 1. GCP top bar, click on “My First Project”

Step 2. Next pop up window, click “NEW PROJECT”

Step 3. Enter your project name, and confirm “CREATE”

© EVE-NG LTD Page 37 of 152

EVE-NG Community Cookbook
Version 5.1

This will take some time.

3.4.3 Preparing Ubuntu boot disk template

Step 1: Open the google cloud shell and press: “START CLOUD SHELL”

Step 2: create a nested Ubuntu 20.04 image model. Copy and paste the below command into
the shell. Use copy/paste. crtl +c/ctrl +v. It is single line command. Confirm with “enter”:

gcloud compute images create nested-ubuntu-focal --source-image-

family=ubuntu-2004-lts --source-image-project=ubuntu-os-cloud --licenses
https://www.googleapis.com/compute/v1/projects/vm-
options/global/licenses/enable-vmx

© EVE-NG LTD Page 38 of 152

EVE-NG Community Cookbook
Version 5.1

You will get the following output when your image is ready:

3.4.4 Creating VM
Step 1: Navigate: Navigation Menu/Compute Engine/VM Instances and press “Create”

Step 2: Assign the name for your VM

Step 3: Set your own region and zone

Step 4: Edit your Machine Configuration. General-Purpose. Choose the series of CPU platform,
Preferred are Intel CPUs Skylake or Cascade.

Step 5: Choose your desirable CPU and RAM settings.

IMPORTANT: “Deploy a container image” must be UNCHECKED.

© EVE-NG LTD Page 39 of 152

EVE-NG Community Cookbook
Version 5.1

Step 6: Select Boot disk. Press Change

© EVE-NG LTD Page 40 of 152

EVE-NG Community Cookbook
Version 5.1

Step 7. Select Custom images, Select Project (EVE-test) and the custom boot images you
created previously. Choose HDD disk type and size. HDD size can vary depends of your
needs.

Step 7: Allow http traffic and create VM

© EVE-NG LTD Page 41 of 152

EVE-NG Community Cookbook
Version 5.1

3.4.5 EVE-NG-Community installation

Step 1: Click VM Instances to get access SSH to your VM, Connect to the VM with the first
option “Open in browser window”

Step 2: Launch installation with:

Type the below command to become root:

sudo -i

Start EVE-COMM installation

wget -O - https://www.eve-ng.net/focal/install-eve.sh | bash -i

Step 3: Update and upgrade your new EVE-COMM

apt update

apt upgrade
Confirm with Y

Step 5. Reboot EVE. Allow some time for reboot and then press “Reconnect”

Step 6: IMPORTANT: Setup IP

© EVE-NG LTD Page 42 of 152

EVE-NG Community Cookbook
Version 5.1

Once the IP wizard screen appears, press ctrl +c and type the below command to become root:
sudo -i

Now follow the IP setup wizard.

IMPORTANT: set IP as DHCP!

Step 6: Reboot

3.4.6 Access to Google Cloud EVE-COMM

Use your public IP for accessing EVE via http.

Default web login: admin/eve

3.4.7 Optional: GCP Firewall rules for native console use

Step 1: Navigate: Navigation menu/VPC Network/Firewall rules

© EVE-NG LTD Page 43 of 152

EVE-NG Community Cookbook
Version 5.1

Step 2: Create new firewall rule

Step 3: Create an ingress FW rule; allow TCP ports 0-65535

© EVE-NG LTD Page 44 of 152

EVE-NG Community Cookbook
Version 5.1

Step 4: Create an egress FW rule; allow TCP ports 0-65535

© EVE-NG LTD Page 45 of 152

EVE-NG Community Cookbook
Version 5.1

Summary FW rules.

3.5 EVE Management IP Address setup

3.5.1 Management static IP address setup (preferred)

The steps below will walk you through the network setup and assign a static management IP
for EVE.

Step 1: Log into the EVE CLI using the default Step 2: Retype your root password again
login root/eve After login, type your preferred and confirm with enter.
root password for EVE, default is eve.
Remember it for further use. Confirm with
enter

NOTE: Typed characters in the password

field are not visible.

© EVE-NG LTD Page 46 of 152

EVE-NG Community Cookbook
Version 5.1

Step 3: Choose your EVE VMs hostname. By Step 4: Type your domain name for your
default, it is eve-ng. You can leave it as it is. EVE VM. By default, it is example.com. The
Confirm with enter default value can be used as well.
Confirm with enter

Step 5: Using the arrow keys, select the Step 6: Type your desirable EVE
option “static”, confirm your selection with management IP. Confirm with enter.
the space key, followed by enter

© EVE-NG LTD Page 47 of 152

EVE-NG Community Cookbook
Version 5.1

Step 7: Type the subnet mask of your EVE Step 8: Type your networks gateway IP.
management network. Confirm with enter. Confirm with enter.

Step 9: Type your networks primary DNS Step 10: Type your network Secondary
IP. Confirm with enter. DNS IP. Confirm with Enter.
IMPORTANT: DNS must be reachable and IMPORTANT: DNS must be reachable and
resolve public addresses. resolve public addresses.

Step 11: Type your preferred NTP server IP. Step 12: If you have a proxy in use for your
It can be left empty as well; in this case, your Internet, select the respective proxy option
EVE VM will automatically assign the time and configure your proxy settings. By default,
from its host. it is direct connection (no proxy). Confirm
your selection with enter. EVE will reboot
automatically.

© EVE-NG LTD Page 48 of 152

EVE-NG Community Cookbook
Version 5.1

IMPORTANT NOTE: If you are setting up your management IP for the first time (fresh
EVE installation), please return to the install section and complete installation phase 3.

3.5.2 EVE Management IP address setup via DHCP

The steps below will walk you through the network setup and assign a management IP for EVE
via DHCP.

NOTE: Typed characters in the password

field are not visible.

© EVE-NG LTD Page 49 of 152

EVE-NG Community Cookbook
Version 5.1

Step 5: Using the arrow keys, select the Step 6: Type your preferred NTP server IP.
option “dhcp”, confirm your selection with the It can be left empty as well; in this case, your
space key, followed by enter EVE VM will automatically assign the time
from its host.

Step 7: If you have a proxy in use for your

Internet, select the respective proxy option
and configure your proxy settings. By default,
it is direct connection (no proxy). Confirm
your selection with enter. EVE will reboot
automatically.

IMPORTANT NOTE: If you are setting up your management IP for the first time (fresh
EVE installation), please return to the install section and complete installation phase 3.

3.5.3 EVE Management IP address reset

If for any reason you need to change these settings after the installation, you can rerun the IP
setup wizard. Type the following command in the CLI and hit enter:

rm -f /opt/ovf/.configured

Then reboot. Once you log into the CLI again, EVE will go through the network setup again.
Please follow the steps in section 3.5.1 for Static IP or 3.5.2 for DHCP IP.

© EVE-NG LTD Page 50 of 152

EVE-NG Community Cookbook
Version 5.1

3.6 EVE-NG Community upgrade to EVE-NG Professional

3.6.1 Mandatory Prerequisites

Mandatory Prerequisites: Internet must be reachable from your PC and VMware. EVE
ISO installation requires internet access to get updates and install the latest EVE-PRO
version from the EVE-NG repository. DNS must work as well, to check it, do a named
ping, for example ping www.google.com

3.6.1.1 EVE Community disk space

You must have enough HDD space available. The main eve--ng--vg-root partition must have
at least 10GByte free space while the boot partition must have at least 50Mbyte. To check how
much space is available on your HDD, enter the following command into the CLI of EVE:

df -h

To free up space on the /boot, enter the following command, hit enter and confirm with “y”

apt autoremove

3.6.1.2 Verify current EVE Community version

You have to make sure that your EVE Community Edition is of version (v2.0.3-86) or later. You
must be able to reach the internet from your PC, VMware or Server.

To check your current EVE-NG version, enter the following command

dpkg -l eve-ng

You can also verify your current EVE version from the WEB GUI. Top menu bar, System,
System status.

© EVE-NG LTD Page 51 of 152

EVE-NG Community Cookbook
Version 5.1

You can check the version number of the newest currently available Community version on the
EVE-NG Community site: http://www.eve-ng.net/community.

3.6.1.3 Steps to upgrade to the latest EVE Community version

Type the following commands below and hit enter after each.

apt update

In case of any Y/N prompt, answer Yes.

apt upgrade

In case of any Y/N prompt, answer Yes.

reboot

3.6.2 Upgrading EVE Community to EVE-NG Professional

WARNING: Please be ready to purchase a license when upgrading, as you will not be
able to start any nodes until a valid license has been activated on your EVE.

To upgrade to EVE-NG Pro, issue the following commands into the CLI of EVE followed by
enter.

apt update

apt install eve-ng-pro

reboot

After the reboot continue with the below commands, followed by enter
apt update

apt install eve-ng-dockers

reboot

Continue to the EVE-NG Pro license purchase section of the website and follow the remaining
instructions.

© EVE-NG LTD Page 52 of 152

EVE-NG Community Cookbook
Version 5.1

3.7 Native telnet console management setup

If you prefer to use a natively installed telnet client to manage nodes inside EVE, follow the
steps below:

3.7.1 Windows Native Console

Step 1: Download the EVE Windows Client Step 2: Install it as administrator

integration pack:

http://www.eve-ng.net/downloads/windows-
client-side-pack

Step 3: Leave the option for UltraVNC Step 4: Continue with Next. When it asks to
checked. UltraVNC is very tiny and the choose Ultra VNC Options, only leave the
preferred VNC client for Windows by EVE. UltraVNC Viewer checked, the rest is not
needed.

Step 5: Continue with Next and finish the

installation.

By default, EVE Windows Client Integration will install Putty as your Telnet Client. The default
location for the EVE Windows Client Integration software and .reg files is: “C:\Program
Files\EVE-NG”

Set the default telnet program manually in Windows 10. Example: SecureCRT

Step 1: Go to: Windows Settings/Apps/Default Apps/Choose Default Apps by Protocol

Step 2: Set your default Telnet program:

NOTE: The first time click on the type of link that is used to access a running node
inside EVE via telnet, the browser will ask to choose the telnet program. If you have

© EVE-NG LTD Page 53 of 152

EVE-NG Community Cookbook
Version 5.1

prepared your default telnet program with the instructions above, you have to choose
your default Telnet program.

Example: Firefox browser:

Set your default application, check the box “Remember my choice telnet links” and click Open
link

3.7.2 Linux Native Console

The steps below will show how to setup the native consoles pack for Linux Mint 18 (Ubuntu):

Step 1: Go to the EVE Linux Side Step 2: Open the link to GitHub
integration pack download page:
https://github.com/SmartFinn/eve-ng-
http://www.eve-ng.net/downloads/linux- integration
client-side

Step 3: Scroll down to the installation part

Step 4: Login as root to your Linux system and enter the commands below:

NOTE: An internet connection is required. Enter each command line below one after the
other

sudo add-apt-repository ppa:smartfinn/eve-ng-integration

sudo apt-get update

sudo apt-get install eve-ng-integration

For other Linux native console setup options please refer to:
https://github.com/SmartFinn/eve-ng-integration

© EVE-NG LTD Page 54 of 152

EVE-NG Community Cookbook
Version 5.1

3.7.3 MAC OSX Native Console

Telnet Protocol:

OSX Sierra (and older releases) is ready to use for the telnet protocol.

For High Sierra, a telnet binary must be added (Apple decided to remove it and it is not present
anymore on the latest OSX releases).

Procedure to install a previous telnet binary:

Download telnet and ftp binaries from eve:

http://your_eve_ip/files/osx.zip (to be updated) Please contact to EVE Live chat for this
package.

Step 1: Reboot the Mac and hold down the “Command” and “R” key simultaneously after you
hear the start-up chime, this will boot OSX into Recovery Mode

Step 2: When the “OSX Utilities” screen appears, pull down the ‘Utilities’ menu at the top of the
screen instead, and choose “Terminal”

Step 3: Type the following command into the terminal then hit enter:

© EVE-NG LTD Page 55 of 152

EVE-NG Community Cookbook
Version 5.1

crutil disable; reboot

Step 4: When the OSX reboot is done, extract the osx.zip to your home directory

Step 5: Copy the files to /usr/bin and set the permissions using the terminal utility:

sudo –i

cp telnet ftp /usr/bin ; chmod 555 /usr/bin/telnet; chmod 555 /usr/bin/ftp

chown root:wheel /usr/bin/telnet /usr/bin/ftp

1. Reboot the Mac and hold down Command + R keys simultaneously after you hear
the startup chime, this will boot OSX into Recovery Mode
2. When the “OSX Utilities” screen appears, pull down the ‘Utilities’ menu at the top of
the screen instead, and choose “Terminal”

Type the following command into the terminal then hit enter:

crutil enable; reboot

VNC Protocol:

Download Chicken of VNC at: https://sourceforge.net/projects/chicken/files/Chicken-

2.2b2.dmg/download

Install and use it as default VNC Client

RDP Protocol:

Download and install the Microsoft Remote Desktop on the App Store:

© EVE-NG LTD Page 56 of 152

EVE-NG Community Cookbook
Version 5.1

3.8 Login to the EVE WEB GUI

http://<your_eve_ip>/

Default user access:

User: admin

Password: eve

NOTE: You can change your EVE WEB Admin password, please refer to section
6.3.1.2

IMPORTANT NOTE: You must prepare and upload at least a couple of images to start
building your labs. Refer to section 12

© EVE-NG LTD Page 57 of 152

EVE-NG Community Cookbook
Version 5.1

4 EVE-NG Community Update & Upgrade

Prerequisites: Internet access and working DNS on your EVE-NG is required.

Verify your internet reachability with named ping. Example: ping www.google.com

ping www.google.com

If your ping is success, follow next step for update. If named ping has no success, please verify
your DNS IP assigned for EVE or firewall. Some cases ping can be blocked by FW, but Internet
and DNS are capable to make update/upgrade.

OPTION for bare EVE installations which has bnx2x Broadcom Ethernet drivers, please
rewrite your driver to the newest linux-firmware:

sudo apt-get -o Dpkg::Options::="--force-overwrite" install linux-firmware

IMPORTANT NOTE: before you start your EVE Community update & upgrade, please free
up your EVE Community from older kernel packages:

apt autoremove

4.1 EVE-NG Community Update

It is strongly recommended to keep your EVE-NG up to date. To update and upgrade, SSH to
your EVE CLI.

To verify your current EVE-NG version, please follow “CLI diagnostic information display
commands” in section 11.1.1. You can verify your current EVE version from the System/System
Status tab on the top menu of the WEB GUI as well.

The newest version of EVE-NG can be verified by checking the official website: http://www.eve-
ng.net/community/community-2. The main page will display the latest EVE-NG version and
correct steps to update.

© EVE-NG LTD Page 58 of 152

EVE-NG Community Cookbook
Version 5.1

Type the below commands followed by Enter

apt update

In case the prompt asks to confirm with Y/N, answer Yes.

4.2 EVE-NG Community Upgrade

Type commands followed by Enter

apt upgrade

In case the prompt asks to confirm with Y/N, answer Yes.

IMPORTANT NOTE: If you are upgrading EVE Community from older version, the
installation may ask you to confirm additional! Information:

Answer for prompt above is “N”

© EVE-NG LTD Page 59 of 152

EVE-NG Community Cookbook
Version 5.1

Answer for grub-pc version is: “Keep the local version currently installed”

After the completion of the update and upgrade, reboot your EVE Server. Type the following
command and hit enter.

reboot

© EVE-NG LTD Page 60 of 152

EVE-NG Community Cookbook
Version 5.1

5 Types of EVE management consoles

IMPORTANT NOTE: EVE Console TCP ports. EVE Community uses a static port
range between 32678-40000.

Formula is = 32768+128POD+1 -> 32768+128POD+128 POD: user id ( admin = 0 )

Exemple: you got admin (POD 0) + 2 users ( POD 1, POD 2 )
32768+128*0+1(First port for POD0) -> 32768+128*2+128(Last port of POD 2 ) = 32769 ->
33152
Port per user pod:

POD First Port Last Port

0 32769 32896
1 32897 33024
2 33025 33152
3 33153 33280
4 33281 33408
5 33409 33536
6 33537 33664
7 33665 33792
8 33793 33920
9 33921 34048
10 34049 34176

EVE Community supports two different console types.

5.1 Native console

EVE Native console option requires locally installed software
to access your lab nodes. To use the Native console option,
you must have Administrator rights on your PC and ensure
the TCP port range 32768-40000 is not blocked by a firewall
or antivirus software. (See table above)

5.1.1 Native Console: telnet

Windows OS: You can use your preferred telnet program like Putty, SecureCRT or others.
Example: Putty as native telnet client on Windows.
To setup Windows native telnet client please follow section 3.7.1

© EVE-NG LTD Page 61 of 152

EVE-NG Community Cookbook
Version 5.1

Linux OS: You can use your preferred telnet program like the Native Terminal, SecureCRT,
or others.
Example: Telnet client from the native terminal on Linux Mint. To setup Linux native telnet
client please follow section 3.7.2

MAC OSX: You can use your preferred telnet program like the native Terminal, SecureCRT,
or others.
Example: Telnet client from the native terminal on MAC OSX. To setup MAC OSX native
telnet client please follow section 3.7.3

5.1.2 Native Console: Wireshark

EVE Community has an integrated connection with natively installed Wireshark software on
your PC. This allows live captures with Wireshark installed on the client machine. The EVE
will capture natively installed Wireshark session.

IMPORTANT NOTE: Make sure you have installed Wireshark and EVE-NG client
pack. It is strongly recommended if your Wireshark software is installed at your PC
default location.

© EVE-NG LTD Page 62 of 152

EVE-NG Community Cookbook
Version 5.1

IMPORTANT NOTE: The Wireshark wrapper located in your PC station must match
your EVE root password. Edit your EVE root password in the wireshark_wrapper.bat,
if you had changed it during install.

Example: Fortinet live interface port1 capture.

© EVE-NG LTD Page 63 of 152

EVE-NG Community Cookbook
Version 5.1

5.1.3 Native Console: VNC

Windows OS: Recommended and tested is UltraVNC but any other compatible one can be
used.
Example: UltraVNC as Native VNC client on Windows. To setup Windows native VNC client
please follow section 3.7.1

Linux OS: Remote Desktop Viewer for VNC Sessions.

Example: Remote Desktop Viewer for VNC sessions on Linux Mint. To setup Linux native
Remote Desktop Viewer please follow section 3.7.2

MAC OSX: Preferred VNC program: Chicken VNC

Example: Chicken VNC as Native VNC client on MAC OSX. To setup MAC OSX native RDP
Viewer client please follow section 3.7.3

5.1.4 Native Console: RDP

Windows OS: Windows Native RDP.
Example: Windows RDP session to Win10 host in the lab.

© EVE-NG LTD Page 64 of 152

EVE-NG Community Cookbook
Version 5.1

Linux OS: Remote Desktop Viewer as RDP session to lab Win10 host.
Example: RDP session to Win10 host in the lab. To setup Linux native Remote Desktop
Viewer please follow section 3.7.2

MAC OSX: Remote Desktop Viewer as RDP session to lab Win10 host.
Example: RDP session to Win10 host in the lab.
To setup MAC OSX native RDP Viewer client please follow section 3.7.3

5.2 HTML5 console

The EVE Community HTML5 console
provides a clientless solution for
managing labs and node sessions.
Management is achieved directly through
the browser by opening new browser
window. It is very convenient for
Corporate users with restricted
Workstation permissions (Locked Telnet,
vnc, rdp).

© EVE-NG LTD Page 65 of 152

EVE-NG Community Cookbook
Version 5.1

5.2.1 HTML5 Console: Telnet

HTML5 Telnet console opens telnet sessions in the new browser window.

5.2.2 HTML5 Console: VNC

HTML5 VNC opens VNC sessions in the new browser window.

© EVE-NG LTD Page 66 of 152

EVE-NG Community Cookbook
Version 5.1

5.2.3 HTML5 Console: RDP for Windows

HTML5 RDP console opens RDP sessions in the new browser window. For Windows 7,
Windows Server 2008.

During Windows machine image installation, you can allow RDP sessions to be used for access
to Windows host. If your Windows host has enabled RDP session, edit windows node settings
and set RDP console. Give time to boot this node and RDP session will opens in new browser
tab.

© EVE-NG LTD Page 67 of 152

EVE-NG Community Cookbook
Version 5.1

© EVE-NG LTD Page 68 of 152

EVE-NG Community Cookbook
Version 5.1

6 EVE WEB GUI Management

6.1 EVE Management Page
The Main EVE management window

6.1.1 Management buttons

Button Description

Select All or Deselect All folders or labs in the EVE tree

Create/Add new Lab

Change selected item name. To use this option, please select the folder or lab
that you want to rename. You must not rename the Shared folder, the Users
folder or any folder inside the Users folder.

Move selected item(s) to a different location. To use this option, please select
the folder(s) or lab(s) that you want to move.

Delete selected folders or labs. You must not delete the Shared folder, the
Users folder or any folder inside the Users folder.

© EVE-NG LTD Page 69 of 152

EVE-NG Community Cookbook
Version 5.1

Import an EVE lab or lab folder from a previous export. Import file must be in
.zip format

Export EVE lab or folder. Select folder(s) and/or labs you wish to export and
select this option. The export is saved to your local PC in .zip format and is
ready to import to another EVE.

Toggle the sorting folders and labs between alphabetical and last edit date
(ascending/descending cannot be changed currently).

Refresh current folder content

6.1.2 Management tabs

Tab Description

Returns back to the EVE Home Management screen.

Management dropdown, opening the management submenu.

Management submenu, refer to sections: 6.3

System dropdown.

System submenu, refer to section 6.4

Information dropdown

© EVE-NG LTD Page 70 of 152

EVE-NG Community Cookbook
Version 5.1

Information submenu, for details see section 6.5

6.2 Folders and Lab files management

This section will explain how to manage folders and labs on the EVE management page.

6.2.1 Folders Management

6.2.1.1 Create folder

Type the new folder name and click “Add Folder”

6.2.1.2 Delete folder

Select the folder you wish to delete and press

Delete.

NOTE: All folder content will be deleted as

well.

6.2.1.3 Move Folder

Select the folder you wish to move and press the

Move to button.

Type and select the target destination for your folder and
confirm by clicking on Move.

6.2.1.4 Export Folder

Select the folder(s) you wish to export from your EVE and press Export.

© EVE-NG LTD Page 71 of 152

EVE-NG Community Cookbook
Version 5.1

Save the exported file as .zip to your local PC. The exported zip file is ready to import to another
EVE instance.

If your browser is set to save downloaded files to a default directory, your exported file will be
saved in the browsers default downloads directory.

6.2.1.5 Import Folder

IMPORTANT: Importable file MUST be in .zip format, do NOT unzip the file.

Step 1: Press the Import button.

Step 2: Choose the zipped file that contains EVE folders with labs.

Step 3: Press the Upload Button

© EVE-NG LTD Page 72 of 152

EVE-NG Community Cookbook
Version 5.1

Step 4: After you made sure your folder is imported and has all its content (labs), you can close
the upload session.

6.2.2 Lab files Management

You can manage created labs from the main EVE file manager window

6.2.2.1 Create Lab

Click on the New Lab button and refer to section 8.1

6.2.2.2 Delete Lab

Select the lab or labs you wish to delete and then press the Delete button

© EVE-NG LTD Page 73 of 152

EVE-NG Community Cookbook
Version 5.1

6.2.2.3 Clone Lab

The cloning feature provides a very convenient way to duplicate original labs to share with
others or base another lab on it.

Cloned labs will copy exported configs (on supported nodes) but will not copy saved
states/configurations in Qemu nodes like Windows hosts, Cisco ISE, or other Qemu nodes that
are not supported by the export config feature. Please refer to section 10.1 for more information
on configuration export for labs.

Step 1: Select the lab you wish to clone and move the mouse pointer (blue) to that lab, an extra
option will appear. Click on Clone.

Step 2: Your lab will be cloned with all your exported configurations or configuration sets with
a new name.

Step 3: The lab has been cloned lab and can be renamed to your liking. Move the mouse pointer
to the cloned lab and choose Rename.

Step 4: Rename it, and click OK to confirm

6.2.2.4 Move Lab

Step 1: Select the lab you wish to Move and move the mouse pointer (blue) to that lab, an extra
option will appear. Choose Move to.

© EVE-NG LTD Page 74 of 152

EVE-NG Community Cookbook
Version 5.1

Step 2: Type the path to the new destination and

confirm by clicking Move

6.2.2.5 Export Lab

Select the Lab(s) you wish to export from your EVE Server and press Export.

Save exported file as .zip to your local PC. The exported zip file is ready to import into another
EVE.

If your browser is set to save downloaded files to default directory, your exported file will be
saved in the browsers default downloads directory.

6.2.2.6 Import Labs

IMPORTANT: Importable file MUST be in .zip format, do NOT unzip the file.

Step 1: Press the Import button.

© EVE-NG LTD Page 75 of 152

EVE-NG Community Cookbook
Version 5.1

Step 2: Choose the zipped file which contains the EVE labs.

Step 3: Press the Upload Button

Step 4: After you made sure your lab is imported, you can close the upload session.

6.3 EVE Management Dropdown Menu

6.3.1 EVE User management

The User Management page, under the
Management dropdown, will allow Admin
accounts to manage other user accounts.

© EVE-NG LTD Page 76 of 152

EVE-NG Community Cookbook
Version 5.1

6.3.1.1 Creating a new EVE User

Step 1: Open the User management submenu. Management>User management and click Add
user

Step 2: The Add New User management window will pop up. Fill in the main information about
your EVE user

Step 3: The POD number is a value assigned to user accounts automatically. POD numbers
are like user profiles inside of EVE and are a unique value for every user Think of PODs like a
virtual rack of equipment for each user. Admins can assign a preferred number between 1-128.
Please keep POD numbers unique between users!

Step 4: Press ADD

6.3.1.2 Edit EVE User

Step 1: Open the User management submenu. Management -> User management and choose
which user you want to edit.

© EVE-NG LTD Page 77 of 152

EVE-NG Community Cookbook
Version 5.1

Step 2: The Edit user management window will pop up. Now you can edit necessary user
information, roles, or access time. Confirm settings by pressing Edit at the bottom of the
window.

6.3.1.3 User monitoring

There is a dropdown menu next to “Add User” called “More Info” that can provide additional
information about your users. Click the checkbox next to the relevant information that you would
like displayed. Additional columns will be added for each checkbox that is chosen.

6.4 EVE System Dropdown menu

The EVE System dropdown contains the system utilization status, log
files, and an option to stop all running nodes on the server.

6.4.1 System status

The System Status page, under the System Dropdown, will show EVE
server resource utilization, the number of running nodes per template,
current running versions of EVE and Qemu, and the current status of the
UKSM and CPU Limit options.

© EVE-NG LTD Page 78 of 152

EVE-NG Community Cookbook
Version 5.1

UKSM – “Ultra KSM (kernel same-page merging) is a Linux kernel feature that allows the KVM
hypervisor to share identical memory pages among different process or virtual machines on the
same server.” It can be disabled globally for EVE on this page. It is recommended to keep
UKSM enabled.

CPU Limit – CPU limit is used to limit CPU

overloads during the nodes run time. It acts
like a smart CPU usage option. If a running
node reaches 80% CPU utilization, the CPU
Limit feature throttles CPU use for this node
to 50% until process usage drops under 30%
for a period of 1 minute.

It is recommended to keep the Global CPU

Limit option enabled.

CPU Limit can be turned for individual nodes

in a lab. EVE node templates are set, by
default, with the recommended CPU limit
settings. An Unchecked CPU Limit option
means that this node will boot without CPU
limit.

Reference:

https://searchservervirtualization.techtarget.com/definition/KSM-kernel-samepage-merging

6.4.2 System logs

The System logs page, under the System Dropdown, will display EVE
server log information

In the menu you can select a specific log file for inspection.

© EVE-NG LTD Page 79 of 152

EVE-NG Community Cookbook
Version 5.1

6.4.3 Stop All Nodes

The Stop All Nodes option, under the System Dropdown, is an
option that stops all running nodes on the EVE server. This
option is accessible only by Admin users.

6.5 EVE Information Dropdown menu

The Eve Information Dropdown contains links to the EVE
Website, EVE forum, EVE YouTube channel, and the web-
based EVE Live Help chat.

To join the EVE Forum, in order to make posts or download

materials, a forum user account must be created.

To join the EVE Live Chat for support, please use your Google account for access, or create a
new user account for this chat. Please note the forum and live chat use separate user accounts.

6.6 Other Tab line info

Other items on the top menu are: Real-time clock, a shortcut to edit the currently logged in user,
and a sign-out button.

6.7 Lab preview and global settings

Once you click on a lab in the folder tree, a main window on the right side will display schematic
content of the lab as well as lab management options like open, edit, and delete.

© EVE-NG LTD Page 80 of 152

EVE-NG Community Cookbook
Version 5.1

6.7.1 Lab preview window

The lab preview window displays the schematic position of nodes and their connectivity. The
Scale option allows you change the lab preview size.

6.7.2 Lab preview buttons

In the lab preview, these buttons allow you to manage the selected lab.

Button Description

Opens the Lab to the Topology Canvas

Opens the Labs Global Settings. Refer to section 6.7.4 for more info.

Deletes the lab

6.7.3 Lab preview information

Description, version, UUID etc.

© EVE-NG LTD Page 81 of 152

EVE-NG Community Cookbook
Version 5.1

6.7.4 Lab Global Settings

Lab Global Settings Page is opened when you click on the Edit button below the Lab
preview window or from the Topology page Side bar:

This page allows you to fill out important information about the lab. The red numbers in the
picture correlate with the numbers listed below

1. Lab name.

2. Version: Version numbers allow a lab author to assign a value to a unique state of a
lab. Increase the number to correspond to new developments in the lab. If left unfilled,
EVE will assign a value of 1 automatically.

3. Author: You can add a lab author name in this field

4. Config Script Timeout: It is the value in seconds used for the “Configuration Export”
and “Boot from exported configs” operations. Refer to section 10.3 for more
information.

5. Description: In the Description field you can write a short description of the lab.

6. Tasks: In the Tasks field you can write the task for your lab.

The Lab details window can be opened from the Topology Canvas page
sidebar during labbing, to read the Tasks for the lab.

© EVE-NG LTD Page 82 of 152

EVE-NG Community Cookbook
Version 5.1

© EVE-NG LTD Page 83 of 152

EVE-NG Community Cookbook
Version 5.1

7 EVE WEB Topology page

Once you open a lab, the topology page for that lab will open.

7.1 Side bar functions

Move your mouse pointer over to the left on top of the minimized sidebar to expand the
interactive sidebar as shown in below screenshot

© EVE-NG LTD Page 84 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.1 Add an object

The “Add an object” menu can be accessed in two different ways, from the sidebar and by right-
clicking on the Topology Page

7.1.1.1 Node object

The Node object opens the “Add a new node” window. Only nodes that appear blue in the
dropdown menu can be added. A grey image name signifies that you have not yet properly
uploaded an image to the proper folder. A blue image name means that at least one image
exists in the proper folder for this template.

7.1.1.2 Network object

The Network object opens the “Add a new network” window. This function is used to add any
kind of network (Cloud, Bridge). For details on these, please refer to section 9

© EVE-NG LTD Page 85 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.1.3 Picture object

The picture object opens the “Add Picture” window and allows you to upload custom topologies
in jpg or png format. After uploading, you can edit these pictures and map selected areas to
nodes from the topology to use your own designs as a lab topology from which you can directly
connect to the nodes. For details, refer to section 10.2

7.1.1.4 Custom shape object

The Custom shape object allows you to add shape elements onto the topology; these currently
include squares, round squares and circles. For details, refer to section 10.1

7.1.1.5 Text object

The Text object allows you to add Text elements onto the topology. For details, refer to section
10.1.3

© EVE-NG LTD Page 86 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.2 Nodes
The Nodes object in the sidebar opens the “Configured Nodes” window.

In this window, you can make changes for nodes that are on the lab topology. More options
can be found in the detailed node specific menu, for details refer to section 8.1.2.

NOTE: Running nodes are highlighted in Blue, their settings cannot be changed. You
can only change settings of nodes that are not currently running.

You can change the following values:

• Node Name
• Boot image
• Number of CPUs for the node
• Enable or disable CPU Limit (Refer to section 6.4.1)
• IDLE PC for Dynamips node
• NVRAM in Kbyte
• RAM in Mbyte
• Ethernet quantity. NOTE: The Node must be disconnected from any other nodes to
make this change. You cannot change the interface quantity if the node is connected
to any other node.
• Serial interface quantity, IOL nodes only. You cannot change Serial interface quantity
if the node is connected to any other node.
• Type of Console
• Node Icon that appears on the Topology
• Startup configuration to boot from

Actions Buttons (Stopped node):

• Start node

© EVE-NG LTD Page 87 of 152

EVE-NG Community Cookbook
Version 5.1

• Stop node
• Wipe node
• Export the nodes config
• Networks
• Edit node
• Delete Node

Actions Buttons (Running node):

• Console to the node

• Stop node
• Wipe node
• Export the nodes config
• Edit node
• Delete Node

7.1.3 Networks
The Networks object in the sidebar will open the “Configured
Networks” window.

The “Configured Networks” window will only show networks that were specifically added to the
topology; it will not show node interconnections. The example below is showing information for
networks on the Topology. For Cloud networks and how to connect EVE labs to a network
external to EVE, please refer to section 9

© EVE-NG LTD Page 88 of 152

EVE-NG Community Cookbook
Version 5.1

• Edit Network
• Delete Network

7.1.4 Startup-configs
The Startup-configs object in the sidebar opens the “Startup-configs”
window.

This window will show you startup-config for each node and if the node is set to boot from it
(ON) or not (OFF).

7.1.5 Logical Maps

NOTE: The Logical Maps object will only appear in the sidebar after
you have uploaded a custom topology picture to the lab EVE lab
(Please refer to section 7.1.1.3). The Pictures object in the sidebar opens the “Picture
Management” window.

For details on the Picture / custom topology feature, refer to section 10.2

7.1.6 Configured Objects

The “Configured Objects” window will display a list of all objects that
are added onto the topology. For details on different objects, refer to
section 10.1

NOTE: You will not see any objects in this window if none have been added to the lab yet.

© EVE-NG LTD Page 89 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.7 More actions

The More actions menu in the sidebar has a submenu with the following functions.

7.1.7.1 Start all nodes

The “Start all nodes” action will start all nodes on your topology, taking
the (configurable) startup delay of each node into consideration.

IMPORTANT. Starting many nodes at once can seriously spike your CPU utilization.
Please make sure that you are not using the “Start all nodes” option for heavy labs or
that you have configured a proper delay between the nodes. For heavy nodes and
large quantities, it is recommended to start them in smaller groups, wait for them to
finish booting and then start another small group of nodes.

7.1.7.2 Stop all nodes

Stopping all nodes will power off all nodes on your topology.

NOTE: It is recommended to save your (running) configurations on the nodes in your

lab before you stop the lab if you want to continue where you left off the next time.
Stopping the nodes will leave the images in a temporary folder and will take up space
on your drive until they have been wiped.

7.1.7.3 Wipe all nodes

The “Wipe all nodes” action will wipe the NVRAM or currently saved
image of all your nodes in the current lab.

Example: You have saved the nodes configuration by saving the running configuration to the
startup configuration. The Wipe command will delete the saved NVRAM startup configuration
and on the next boot it will boot from factory defaults.

The same applies to images without configurations, e.g. a linux node. If you make modifications
to the system and afterwards wipe this node, the next time it will boot from the original base
image again as the modified image was deleted.

The “Wipe node” action is commonly used with initial startup configuration modifications. The
Wipe node action does not delete configured startup configurations or sets. Please refer to
section 10.3

© EVE-NG LTD Page 90 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.7.4 Console to All Nodes

“Console to all nodes” will open a console to all of your running

nodes in the current lab. This includes all different kinds of
configured console types for lab nodes like VNC, Telnet and RDP.

7.1.7.5 Export all CFGs

The “Export all configurations” action will export current configs to

the EVE startup-configs.

Export configurations are supported for:

Cisco Dynamips all nodes Juniper VRR

Cisco IOL (IOS on Linux) Juniper VMX
Cisco ASA Juniper vMX-NG
Cisco ASAv Juniper vQFX
Cisco CSR1000v Juniper vSRX
Cisco Nexus 9K Juniper vSRX-NG
Cisco Nexus Titanium Mikrotik
Cisco vIOS L3 PFsense FW
Cisco vIOS L2 Timos Alcatel
Cisco XRv vEOS Arista
Cisco XRv9K

For a full explanation of exporting configurations, please refer to section 10.3

7.1.7.6 Edit lab

Opens the Edit lab window. Refer to section: 6.7.4

7.1.7.7 Set node’s startup-cfg to default configset

Sets nodes to the default startup-config. NOTE: If you have

nothing saved in the default config set for any node, that node
will boot from factory default instead. This is commonly used with the wipe nodes function so
the node will boot from the configured startup-config on next boot and not from the startup-
config in its NVRAM in case the node was started before already.

Please refer to section 10.3

© EVE-NG LTD Page 91 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.7.8 Set node’s startup-cfg to none

Setting all lab nodes to boot from factory default. Used

commonly with the wipe nodes function. The example below
shows the steps to set a lab to boot from factory default.

Step 1: Wipe all nodes

Step 2: Set all nodes to startup-cfg none

Please refer to section 10.3

7.1.7.9 Delete default startup-cfgs

WARNING: this action will delete all configurations saved to your saved default config
set. Please make sure that is what you want to do before you execute this.

7.1.8 Refresh Topology

Sometimes it is necessary to refresh the topology if many objects are
added on the topology.

7.1.9 Lab page zoom/unzoom

This action is used to zoom or unzoom a large topology in EVE.

7.1.10 Status
Opens the EVE Status window.

Especially useful while working with labs to monitor your EVE’s resource utilization. It shows
EVEs CPU, RAM and disk utilization in real time. You can also see the number of running
nodes per node type. For details on UKSM and CPU Limit, please refer to section 6.4.1

© EVE-NG LTD Page 92 of 152

EVE-NG Community Cookbook
Version 5.1

7.1.11 Lab details

Lab details display information about a lab, its UUID, description and
lab tasks. To edit the lab description and lab tasks, please refer to
section 6.7.4 and 7.1.7.6

7.1.12 Lock Lab with password

“Lock Lab” disables some of the functions on the lab topology. If the lab is locked, you cannot
move any node or object nor edit any node settings. Basically, the whole lab will be in read-
only mode except for the lab settings itself, which you can still edit as Administrator from the
main menu.

Lab is unlocked and all operations are

working

Enter and confirm your lab lock password

To unlock a Lab, simply press on the red “Unlock Lab” button with an Administrator account.

© EVE-NG LTD Page 93 of 152

EVE-NG Community Cookbook
Version 5.1

Lab is locked and all operations are

restricted

Enter lab unlock password to unlock lab.

Warning: Please remember your Lab lock password. In case of a lost password, you will not be
able to recover it. Unlocking a lab / removal of password can be done by EVE-NG support only.

7.1.13 Dark mode or Light mode

Sets your lab background to the dark mode Sets your lab background to light mode

7.1.14 Close lab

Closes the lab topology. The lab can be closed while the nodes in
the lab nodes are stopped.

7.1.15 Logout
Log out from the EVE WEB GUI session.

7.2 EVE Lab topology menus

Right-clicking within the EVE topology can open new menus with various functions and options
for managing nodes.

7.2.1 Lab topology menu

Right-clicking on the (free/unused) canvas of the EVE topology opens a new
menu. (Add-) Node, Network, Picture, Custom Shape and Text are the same
functions referred to in section 7.1.1.

Auto Align. This function will help align objects on the topology. The lab
creator does not need to worry about small displacements of objects. Auto
Align will align all objects to a virtual grid with a single click and can make
neatly arranged labs look even neater.

© EVE-NG LTD Page 94 of 152

EVE-NG Community Cookbook
Version 5.1

7.2.2 Connection menu

Right-clicking on the connection between nodes allows you
to delete this connection.

7.2.3 Cloud or Bridge network menu

Right-clicking on a Cloud or Bridge network allows you to edit or delete it.

If you have chosen Edit, the Network edit window will

open a window where you can change the placement,
network type or name/prefix.

For details on how to operate EVE Cloud networks and

external connections, please refer to section 9

© EVE-NG LTD Page 95 of 152

EVE-NG Community Cookbook
Version 5.1

7.2.4 Stopped node menu

Right-clicking on a stopped node also opens a menu:

Start node: This will start the selected node in this lab

Wipe node: Wiping a node will erase the NVRAM

(running config) or the temporary image snapshot
depending on the type of node. This option is used to
clean up a node in order to boot it from factory
defaults or a custom set of configurations.

Edit node: Opens the Edit node window (picture on

the right). For details please refer to section 8.1.2

Delete node. Deletes the node from the lab. It is

recommended to disconnect (delete connections to it)
the node before you delete it.

7.2.5 Running node menu

Right-clicking on a running node also opens a menu:

Wipe node: Wiping a node will erase the NVRAM (running config) or the temporary image
snapshot depending on the type of node. This option is used to clean up a node in order to
boot it from factory defaults or a custom set of configurations.

Export CFG: This function is used to export the saved running configuration to the EVE
startup configuration sets. Reference section 10.3

© EVE-NG LTD Page 96 of 152

EVE-NG Community Cookbook
Version 5.1

Capture. Wireshark capture. Select the interface which you wish

to capture. Reference section 5.1.2

7.2.6 Selected nodes menu and features

It is possible to select many objects or nodes at once in EVE. Using your mouse, you can select
an area which will cover your nodes and/or you can click on nodes while holding the CTRL key
on your keyboard.

A right-click on any of the selected nodes opens a group menu:

Start Selected: This will start the selected nodes in this lab.

Stop Selected: This will stop the selected nodes in this lab

Wipe Selected: The Wipe Selected nodes action will wipe the NVRAM or currently saved
image of the selected nodes in the current lab.

© EVE-NG LTD Page 97 of 152

EVE-NG Community Cookbook
Version 5.1

The Wipe node action is commonly used with initial startup configuration modifications. The
Wipe node action does not delete configured startup configurations or sets. Please refer to
section 10.3

Console To Selected Nodes: Console To Selected Nodes will open a console to all selected
running nodes in the current lab. This includes all different kinds of configured console types
for lab nodes like VNC, Telnet and RDP

Export all CFGs: The Export all configurations action will export current configs of selected
nodes to the EVE startup-configs.

For a full explanation of exporting configurations, please refer to section 10.3

Set nodes startup-cfg to default configset: Sets nodes to Default startup config, used
commonly with the wipe nodes function. NOTE: If you have nothing saved in the default config
set for any node, that node will boot from factory default instead. This is commonly used with
the wipe nodes function so the node will boot from the configured startup-config on next boot
and not from the startup-config in its NVRAM in case the node was started before already.

Please refer to section 10.3

Set nodes startup-cfg to none. Setting selected lab nodes to boot from factory default. Used
commonly with the wipe nodes function. The example below shows the steps to set selected
nodes to boot from factory default.

Step 1: Wipe selected nodes

Step 2: Set nodes startup-cfg to none

Please refer to section 10.3

Horizontal Align. Aligns the selected nodes in one horizontal line.

Step 1: Select the nodes you wish to align.

Step 2: Right click on one of the selected nodes and choose Horizontal align, this will align all
nodes to the selected node.

Picture before:

Picture after:

Vertical Align: Aligns the nodes in one vertical line.

Step 1: Select the nodes you wish to align.

© EVE-NG LTD Page 98 of 152

EVE-NG Community Cookbook
Version 5.1

Step 2: Right click on one of the selected nodes and choose Vertical align, this will align all
nodes to the selected node.

Picture before Picture after

Circular Align: Aligns the nodes in a circle.

Step 1: Select the nodes you wish to align.

Step 2: Right click on one of the selected nodes and choose Circular Align, this will align all
nodes in a circle, the midpoint of the circle will be at the coordinates the selected node was at
before.

Picture Before Picture After

Delete nodes startup-config.

WARNING, this action will delete the configurations of the selected nodes that are
saved to your Default config set. Please make sure that is what you want to do before
you execute this.

Delete selected: This will delete the selected nodes from your current lab.

Selected nodes can be moved as a group across the topology.

© EVE-NG LTD Page 99 of 152

EVE-NG Community Cookbook
Version 5.1

Example: You can select nodes and objects to better position them on the Topology.

7.3 EVE Lab node states and symbols

7.3.1 Stopped (non-running) nodes

Grey colour and a square symbol below a node means that the node is stopped
and not running. Once you will start it, the node will change to one of the running
states below.

A grey node with an exclamation mark inside a triangle below the node means
that there was a problem during the boot process, this could be a corrupted boot
image, insufficient resources or problems with the initial configuration. A node in
this state cannot be started again.

Workaround: Right-click on the node and wipe it, the symbol will then change to a grey colour
with a square symbol below it. Then edit the node and make sure you have configured sufficient
resources and the correct settings for this node, if it has startup-configs you can check them as
well. Afterwards start the node again.

7.3.2 Running nodes

The blue colour and black Play triangle symbol means that the node is started and
running, the node is in a working/functional state.

A running node with a clock symbol below the node means that the node is waiting
to finish loading from the set exported/startup configuration. Once the configuration
has been successfully applied, the node symbol will change to a Play triangle
symbol. If the node has finished booting but the clock symbol does not change to
the Play triangle symbol, the problem could be in the uploaded startup configuration. For how
to use exported configurations and boot nodes from them, please refer to section 10.1

A running node with a turning red gear symbol means that the node is either in the
process of hibernating the node or it has sent the shutdown signal to the node and
is waiting for it to turn off. Once this process has successfully finished, the symbol
will turn into a grey node with a black square symbol below it (stopped state).

© EVE-NG LTD Page 100 of 152

EVE-NG Community Cookbook
Version 5.1

NOTE: If the node does not support a system shutdown or does not recognize the
shutdown signal (example: Cisco router), after clicking on Shutdown, the node can
stay with a turning red gear symbol below it indefinitely.
Workaround: Use Stop or Stop/PowerOff to stop the node.

Example nodes where Stop/Shutdown is supported: Microsoft Windows and most Linux nodes
as well as a lot of appliances based on linux.

7.3.3 Node connector symbol

Connector symbol: If you move your mouse pointer on top of a running
or stopped node, an orange connector symbol appears. It is used to
connect nodes on the topology in a drag and drop style. Drag the
symbol from one node and release the mouse pointer on the second
node. A new window will appear where you can select the
interfaces the link should connect to.

7.4 Other

7.4.1 Notifications area

The Notification area in the top right is displaying
informational or error messages.

© EVE-NG LTD Page 101 of 152

EVE-NG Community Cookbook
Version 5.1

8 Working with EVE labs

IMPORTANT NOTE: You must prepare and upload at least a couple of images to start
building your labs. Refer to section 12

8.1 Creating a lab

Step 1: Click Add new lab. For more information on creating new labs, please refer to section
6.2.2.1

Step 2:

Fill out the lab information. Name and Version are required fields. Next hit Save. Refer to
section 6.7.4 for more information about the different fields in the Edit lab window.

8.1.1 Adding nodes to the lab

The new Topology page will open. There are two different ways to add nodes to the topology
canvas:

Step 1: Object/Add Node

Left Side Bar > Add object > node. Refer to Right click on a free area of the topology
section 7.1.1.1 for more information. page and click on “Node” to add a new node.
Refer to section 7.2.1 for more information.

© EVE-NG LTD Page 102 of 152

EVE-NG Community Cookbook
Version 5.1

Step 2: The Add new node window will appear. You can scroll down to choose which node you
wish to add to the lab topology, or you can type the node name to filter through the node list.

NOTE: It will only be possible to select and add nodes that have images preloaded in
EVE. These nodes will be displayed in a blue font. To prepare images for EVE, refer
to section

Step 3: Edit “Add a new node” settings. Please refer to the picture and table below.

© EVE-NG LTD Page 103 of 152

EVE-NG Community Cookbook
Version 5.1

8.1.1.1 Node values Table

Number Description

© EVE-NG LTD Page 104 of 152

EVE-NG Community Cookbook
Version 5.1

Template menu. Choose which node template to add

to the topology
1.

Chose the number of nodes of this type you want to add

2.
to the topology

Choose your preferred version from preloaded images

3. list (if you have more than one image loaded for a
single template).

Type your preferred

node name. If you are
adding more than one, EVE will automatically append numbers to the nodes
name.
4.
Example. We are adding 5 CSR nodes with the name R. On the topology they
will appear as R1, R2, R3, R4, R5. Later using the Nodes window, you can edit
the node names per your needs. Refer to section 7.1.2 or edit the node
individually, refer to section 8.1.2.

Node icons can be changed from the

default per your preference, simply choose
5. the preferred icon from the dropdown list.
Node icons can be changed later per your
needs. Refer to section 7.1.2

The UUID number is

assigned automatically after
6. a node is created. You may
also set it manually in case you are using a license that is tied to a particular
UUID.

CPU limit per node. This option is already set

7. (checked/unchecked) per EVE recommendations. Refer to
section 6.4.1

Each node template has a pre-set CPU value that aligns

8. with vendor requirements. This value can be changed per
your needs.

© EVE-NG LTD Page 105 of 152

EVE-NG Community Cookbook
Version 5.1

Each node template has a pre-set RAM value that aligns

9. with vendor requirements. This value is displayed in MB
and may be changed per your needs.

The number of ethernets interfaces.

NOTE for IOL nodes:

Ethernet interfaces for IOL nodes are placed into groups of 4. A value of 1 for
Ethernet means your node will have 4 interfaces.
10.
The serial interface option is available for IOL nodes only and follows the same
grouping structure as ethernet interfaces. A value of 1 for Serial means your
node will have 4 serial
interfaces.

Custom MAC address for Qemu nodes only. You can define your own MAC
address for first interface:

11.

EVE will pre-set the best recommended QEMU version

12. for each node template. This value can be changed per
your needs.

Qemu architecture is pre-set per image vendor

13. recommendations. This value can be changed per your
needs

Type of Qemu NIC is pre-set per image vendor

recommendations. This value can be changed per your
14. needs.

Qemu custom options are pre-set

15. per image vendor
recommendations. This value can be changed per your needs

© EVE-NG LTD Page 106 of 152

EVE-NG Community Cookbook
Version 5.1

Startup configuration: Value can

16. be changed to set your node to
boot from saved configurations. Refer to section 10.3 for more details.

The Delay value is set in seconds and can

be used to delay a node from booting after
it is started. Example: if the value is set to 30, the node will wait 30 seconds
17.
before processing its boot sequense. This feature is useful in conjunction with
the “Start all nodes” function if your lab requires certain nodes to start up before
others or to avoid a mass-start of very heavy nodes.

Console types for each

template are pre-set with
recommended settings.
The setting can be changes per your needs.
18.
NOTE: The Docker template contains a wide variety of images,
therefore, please refer to section 14.1.3 for recommended console
types for each docker image. Windows nodes can use either RDP or
VNC but RDP needs to be enabled in Windows itself.

OPTIONAL: Templates for

Cisco FirePower, F5, Linux,
and Citrix have the option to
19. manually set the MAC address for the first ethernet interface. This will enable
the use of licenses that are tied to a particular MAC address.

MAC Address format must be like: 00:50:0a:00:0b:00

8.1.2 Edit node

EVE provides two ways to edit nodes after being added to the topology canvas.

NOTE: A node must be wiped each time an image or startup configuration has been
changed.

8.1.2.1 Edit nodes globally

From the Topology page. Click “Nodes” from the left sidebar to bring up the nodes list. Refer to
section 7.1.2 for more details.

© EVE-NG LTD Page 107 of 152

EVE-NG Community Cookbook
Version 5.1

8.1.2.2 Edit node individually.

Right click on the node and click Edit

The “Edit node” window will appear. It is very similar to the window that is displayed when you
add a new node. To change values for the node, refer to the nodes value table in section
8.1.1.1.

© EVE-NG LTD Page 108 of 152

EVE-NG Community Cookbook
Version 5.1

8.1.3 Wipe Node

The “Wipe node” function will clear the NVRAM of the node. Each time
a node setting is changed (CPU, RAM, boot image or startup
configuration) a wipe must be issued on that node. For more information
refer to section 10.3

8.1.4 Interconnecting nodes

To connect nodes on the lab, use the drag and drop style method

Connector symbol: Moving the mouse over a node will make an orange male plug
appear. The male plug is used to connect nodes on the topology, drag and drop
style. Release the mouse pointer on the second node.

The connection window will appear. Choose the interface you want to use to interconnect the
nodes. Click Save when finished.

8.1.5 Delete connection between nodes

To delete a connection, right click on it and hit “Delete.”

© EVE-NG LTD Page 109 of 152

EVE-NG Community Cookbook
Version 5.1

8.1.6 Delete Node

To delete a node, right click it and hit “Delete.” This is a non-reversable
function

NOTE: It is strongly recommended to delete connections from a node

before deleting the node itself.

8.2 Running labs

8.2.1 Starting lab

Nodes inside a lab may be started individually, in groups, or all at once.

The Start all nodes option will start all nodes on your topology.

IMPORTANT. Starting all the nodes at once can result in major spikes in CPU
utilization. Please make sure you are not using the “Start all nodes” option for heavy
labs. Instead, it is recommended to start nodes in small groups.

Starting a node or group of nodes:

Right click on single node or node group and hit “Start.”

Running nodes will turn blue. Refer to section 7.3 for node states

8.3 Saving labs

To save a running lab, refer to the vendor recommended save commands for each node.

Example:
Cisco: “copy run start”
Juniper “commit”

Your current work will be saved in the nodes’ NVRAM and the lab can be stopped safely.
Starting the lab again will allow you to pick up from where you left off.

© EVE-NG LTD Page 110 of 152

EVE-NG Community Cookbook
Version 5.1

WARNING: Using the wipe action on a node will clear its NVRAM. This is similar to
doing a factory reset on a device.

The configurations of nodes can be exported and used as initial or startup configurations for
your labs. To export configurations and configuration sets for labs refer to section 10.1

8.4 Stopping labs

The Stop all nodes option will stop all nodes on your topology.

NOTE: It is recommended to save your running configurations before you stop your nodes.

Stopping a node or group of nodes:

Right click on single node or node group and hit “Stop.”

For individual node Stop options refer to section 7.2.5

8.5 Start saved lab

Select the lab you want to start and click “Open”. To start Lab refer section 8.2.1

8.6 Importing labs

Refer to section 6.2.2.6

8.7 Exporting labs

Refer to section 6.2.2.5

8.8 Deleting labs

Refer to section 6.2.2.2

© EVE-NG LTD Page 111 of 152

EVE-NG Community Cookbook
Version 5.1

8.9 Moving labs

Refer to section 6.2.2.4

© EVE-NG LTD Page 112 of 152

EVE-NG Community Cookbook
Version 5.1

9 EVE Clouds and Networks

9.1 Bridge Network
The EVE Bridge interface acts like an unmanaged Switch. It supports passing along tagged
dot1q packets.

Example: We have to connect many nodes in a flat (dot1q) network

Step 1: Add a Bridge Network onto the topology. There are two ways to do this: Right-clicking
on the topology area and selecting “Add Network” or in the sidebar click “Add an Object” and
then select “Network.” Please refer to sections 7.2.3 and 7.1.1.2

Step 2: Name/prefix can be changed in order to rename your Bridge network. Make sure your
network type is set to bridge.

Step 3: Connect your nodes using the drag and drop connector. Refer to sections 8.1.4 and
7.2.3

© EVE-NG LTD Page 113 of 152

EVE-NG Community Cookbook
Version 5.1

9.2 Management Cloud0 interface

EVE management interface is also known as the Cloud0
network for labs. The Cloud0 interface is bridged with your
EVEs first NIC. “Cloud” is used as an alias to pnet. Pnet is
the bridge interface name inside of EVE.

Cloud0 is commonly used inside EVE labs to get management access to nodes running inside
EVE from a host machine external to EVE.

IMPORTANT NOTE: For EVE VMs running on ESXi, make sure your management
interface bridged with the vSwitch (Port group) has the security settings for
Promiscuous Mode set to Accept. Any port group or vSwitch used to connect an
external network to an EVE Cloud network needs to have the Promiscuous mode set
to “Accept”!

vSwitch Settings

Portgroup Settings

EVE Cloud0 bridging table.

© EVE-NG LTD Page 114 of 152

EVE-NG Community Cookbook
Version 5.1

EVE
Lab name interface Type Notes
name (inside)

Cloud0/pnet0 is bridged with your primary

EVE ethernet port. It is assigned a
management IP address used for WEB
Cloud0 pnet0 Bridged
GUI access. The EVE management
subnet can be used as a management
network in labs.

Question: How can I obtain my Cloud0 subnet and gateway IP. Many EVE VMs only
have a DHCP address assigned on the pnet0 interface.

Answer: SSH to EVE and type the following from the CLI:

route

Example: We want to use Cloud0 as a management network for an ASAv node in an EVE lab.
From the above-obtained information, we know that our Cloud management subnet is
192.168.90.0 with a mask of 255.255.255.0 and the Gateway IP is 192.168.90.1.

Step 1: Add A New Network onto the topology.

There are two ways to do this: Right-clicking on
topology area and selecting “Network” or in the
sidebar, “Add an Object” and then select “Network.”

Step 2: Name/prefix can be changed in order to

rename your Cloud0 network. Make sure your
network type is set to Management(Cloud0).

Step 3: Connect your ASAv using the drag and drop

connector to the Cloud0 network. Refer to sections
8.1.4 and 7.2.3

Step 4: Start the node and configure the interface connected to Cloud0 with an IP address from
the management subnet (192.168.90.0/24 in this example). Make sure you do not assign
duplicate IPs.

© EVE-NG LTD Page 115 of 152

EVE-NG Community Cookbook
Version 5.1

NOTE: Cloud interfaces can be used to connect multiple nodes to a single cloud instance on
the topology.

9.3 Other cloud interfaces

Other cloud interfaces can be used to extend a lab connection inside of EVE or bridged with
other EVE interfaces to connect external networks or devices.

EVE Cloud bridging table.

EVE VMware
ESXi VM
Lab cloud interface Workstation Bare HW
Type corresponding Notes
name name corresponding Server
interface
(inside) interface

Cloud0/pnet0 is bridged with

your primary EVE ethernet port.
First It is assigned a management IP
Network Network ethernet address used for WEB GUI
Cloud0 Pnet0 bridged
adapter 1 Adapter access. The EVE management
Eth0 subnet can be used as
management network in the
labs.

EVE-NG Community Cookbook
Version 5.1

Cloud1 can be bridged with your

EVE second ethernet port to
Second achieve connection to another
Network Network ethernet network or device. The IP
Cloud1 Pnet1 bridged
adapter 2 Adapter 2 address is not required to be
Eth1 configured on it. It will act like a
pure bridge your external
connection with EVE lab node.

Third
Network Network ethernet
Cloud2 Pnet2 bridged Same as Cloud1
adapter 3 Adapter 3
Eth2

Fourth
Network Network ethernet
Cloud3 Pnet3 bridged Same as Cloud1
adapter 4 Adapter 4
Eth3

Network Network
Cloud4-9 Pnet4-9 bridged Same as Cloud1
adapter 5-10 Adapter 5-10

Example: Cloud7 network is used as an extended connector between nodes:

Step 1: Add two Cloud7 networks onto the topology.

Step 2: Connect your lab nodes to Cloud7. Your

configured nodes will work like being connected to
the same switch (or the same bridge in EVE).
Even CDP works. It is convenient if it is necessary
to have connections across the lab and you don’t
want to have connections going from one end of
the lab to the other.

If some of the clouds (e.g. Cloud1) are bridged to another ethernet (VMnet) you can connect
your EVE lab to an external VM or physical device (like e.g. a switch, IP phone or access point).

For ESXi make sure that you have set Promiscuous mode security settings on the
vSwitch and Port group to Accept. Please refer to section 9.2

EVE-NG Community Cookbook
Version 5.1

The next sections will explain how you can use Cloud networks in EVE to connect to other
external (e.g. VMWare) VMs or physical devices.

9.4 Connecting external VM machines to the EVE Lab

9.4.1 ESXi VM machines

External ESXi VM machines can be connected to EVE labs using cloud interfaces.

NOTE: A single Cloud interface can be used to connect more than one external VM to
the EVE lab.

Example: Connecting a Web Security Appliance (WSA) to the lab using the Cloud1 interface.

Step 1: Create a new or use an existing portgroup on your ESXi and assign it to EVE and WSA
VMs as shown below. Make sure you have set Promiscuous mode on the vSwitch (portgroup
WSA-MGMT) to Accept.

NOTE: VM machines must be in a powered off state to assign network interfaces.

Portgroup WSA-MGMT (with vSwitch5 as parent) settings:

Parent vSwitch5 settings:

EVE-NG Community Cookbook
Version 5.1

EVE and WSA VMs settings

EVE VM, second port is assigned to Cisco Web security appliance (WSA),
portgroup WSA-MGMT. It is Cloud1 on the Management port is assigned in portgroup
EVE topology. WSA-MGMT.

EVE Lab connected to the WSA (Cloud1)

NOTE: ESXi WSA VM obtained the IP 192.168.10.3 from the DHCP pool on the lab
switch. The gateway is 192.168.10.1

NOTE: The Firefox Docker node user for management obtained the IP 192.168.10.2
from the DHCP pool configured on the lab switch.

EVE-NG Community Cookbook
Version 5.1

9.4.2 VMWare workstation machines

External (meaning not running inside EVE) VMWare workstation machines can be connected
to EVE labs using cloud interfaces.

NOTE: A single Cloud interface can be used to connect more than one external VM to
the EVE lab.

Example: Connecting Web security Appliance (WSA) to the lab using Cloud2 interface.

NOTE: VMs must be in a powered off state to assign network interfaces.

Step 1: Open your VMWare Workstation Virtual Network Editor and configure the VMnet
interface for the Cloud and WSA VMs. If necessary, add a new VMnet. The example below is
showing VMnet2 Settings in VMWare workstation. DHCP must be disabled for VMnet2.

Virtual Network Editor settings:

EVE and WSA VMs settings

EVE-NG Community Cookbook
Version 5.1

EVE VM, the third port (Network adapter 3) is Cisco Web Security Appliance (WSA),
assigned to VMnet2. This is Cloud2 inside your Management port is assigned to VMnet2
EVE labs.

EVE Lab connected to the WSA (Cloud2)

NOTE: ESXi WSA VM obtained the IP 192.168.10.3 from the DHCP pool on the lab
switch. The gateway is 192.168.10.1

NOTE: The Firefox Docker node user for management obtained the IP 192.168.10.2
from the DHCP pool configured on the lab switch.

EVE-NG Community Cookbook
Version 5.1

9.5 Connecting EVE Lab to a physical device

IMPORTANT NOTE: To bypass MAC addressing over pnet/cloud interface please
SSH to your EVE and type:

for i in /sys/class/net/pnet*/bridge/group_fwd_mask ; do echo 8 > $i ; done

9.5.1 ESXi EVE

To connect a physical device (e.g. router, switch) to an EVE lab over a cloud interface, we have
to bridge the ESXi NICs ethernet port to a VMnet interface.

IMPORTANT NOTE: Make sure that you have set Promiscuous mode security settings
on the vSwitch and Port group to Accept.

IMPORTANT NOTE: If you are building trunk between EVE lab node to real Switch,
please make sure you have set your ESXi vSwitch interface to accept all vlans.
Reference: https://kb.vmware.com/s/article/1004074

The Example below is showing ESXi Server settings of the virtual network bridged to the
physical interface.

Logical chain of the networking bridge:

EVE Lab Cloud0 →Portgroup “Management 90 UD”→vSwitch 1→Physical Adapter eth1

vSwitch1 settings bridged with Server Ethernet port vmnic1 (physical adapter)

Portgroup “Management 90 UD” Settings associated with vSwitch1

EVE-NG Community Cookbook
Version 5.1

EVE VM Settings

EVE VM Cloud0 is connected to Portgroup “Management 90 UD”

EVE Lab Connected to a physical device

Physical Topology

Cisco 887M device port Fastethernet 3 is physically connected to Server port eth1.

EVE Lab Topology

EVE-NG Community Cookbook
Version 5.1

EVE lab switch port G0/0 is configured as trunk and connected to Cloud0 over bridged chain
to the physical Cisco 887M Router switchport Fastethernet 3

9.5.2 VMWare workstation EVE

Similar to the ESXi connection, it is recommended to have a second ethernet interface on your
PC. It can be a USB ethernet extender as well. Not all ethernet adapters fully support a layer2
connectivity over it. MS Windows OS itself strips off any tags added to the packet. Even if your
NIC supports 802.1q VLAN tagging, Windows 10 strips these tags off. The example below will
show a Windows 10 host connected to a physical 3750G-24 switch. The Windows 10 Host has
an Intel (R) PRO/1000 PT Dual port server adapter and is bridged with VMWare workstation
(version 14) VMnets.

Virtual Network Editor Settings, Bridged VMnet interfaces with Real NIC Ports

EVE VM Settings. Network adapter is bridged to VMnet0 (ethernet Intel Pro 1), and Network
adapter 2 is bridged to VMnet1 (ethernet Intel Pro 2).

Responding cloud interfaces on EVE VM:

Cloud0→Network Adapter→VMnet0→IntelPro

Cloud1→Network Adapter 2→VMnet1→IntelPro#2

EVE-NG Community Cookbook
Version 5.1

Physical connection scheme and VMware bridging.

EVE Lab scheme.

The following solution allows Windows hosts to transmit tagged packets over ethernet. This
has been used in the example above.

EVE-NG Community Cookbook
Version 5.1

Warning. You are making changes to your Windows registry files! This is at your own
risk.

https://www.intel.co.uk/content/www/uk/en/support/articles/000005498/network-and-i-
o/ethernet-products.html

9.5.3 Bare metal server EVE

A physical server usually has more than one ethernet port, free ports
can be bridged with EVE clouds and used for external connections.
EVEs internal interface settings are already bridged in order, pnet0-9
are mapped to eth0-9. Refer to the bridging table in section 9.3

cat /etc/network/interfaces

Basically, your servers physical port eth0 is bridged to pnet0 which is Cloud0 in your labs, eth1
is bridged to pnet1 which is Cloud1 in your labs (and so on). Refer to the bridging table in
section 9.3

The example below shows how to connect a bare-metal EVE server with a physical Cisco
3750E switch.

Physical connection topology:

The EVE lab switch’s CDP neighbor is the 3750E switch’s port Gig 1/0/25: A trunk has been
configured between the EVE lab switch and the physical 3750E switch.

EVE-NG Community Cookbook
Version 5.1

10 Advanced EVE Lab features

10.1 Lab design objects
EVE Community has drawing elements integrates to add drawings and text information to the
lab topology. Objects can be placed on the topology in two ways.

Example below, EVE lab with design elements:

Option 1: Side bar -> Add an object Option 2: Right-click on a free area on the
topology canvas to add an object.

10.1.1 Custom shape

There are three custom shapes that can be added to the topology: square, round square and
circle (sphere).

Type: Square, round square or circle

Name: This field can be filled with your preferred shape’s name. If the field is left empty, EVE
will generate a name for the shape.

EVE-NG Community Cookbook
Version 5.1

Border type: Two options: line or dashed

Border width: Increase or decrease the width of the

border. This can be edited later in the “Shape Edit” menu.

Border colour: Allows you to choose a colour for the

shape’s border. This can be edited later in the “Shape
Edit” menu.

Background colour: Allows you to choose a colour to fill

your shape with. This can be edited later in the “Shape
Edit” menu.

Example: Added a circle and square on the topology. Shapes can be moved
around the topology drag and drop style (click and move with mouse).

10.1.2 Resize square or circle objects

Move your mouse over the right bottom corner of the object until a
corner symbol appears. Left click and drag your mouse to change
object size or style (rectangle, sphere)

10.1.3 Text object

It is also possible to add text to your EVE topology.

Example: text objects added to the topology.

EVE-NG Community Cookbook
Version 5.1

10.1.4 Add custom picture on the Lab using Text object feature
Sometimes you may have to add pictures, like logos on your topology. It is possible but you
need to convert your png or jpg to html format. We have tested this one as the best to achieve
result. Load your image in the web, and convert to html format.

https://www.askapache.com/online-tools/base64-image-converter/

Step 1: Load your picture jpg or png format and encode it.

Step 2: Scroll down to find HTML format

Step 3: Set your desirable size of picture.

Step 4: Mark and copy all content from HTML window above

Step 4: Copy content to EVE text object

EVE-NG Community Cookbook
Version 5.1

Step 5: Move and place your picture to the Lab.

10.1.5 Cloning objects and overlay positions

Right click on the object you want to clone and choose “Duplicate”. You can also change the
object’s overlay position using the “Send to Back” or “Send to front” options.

10.1.6 Objects Editing

Right click the object and choose “Edit” for additional options.

At the bottom of the “Topology Canvas” page, additional object options will appear

EVE-NG Community Cookbook
Version 5.1

Z-index: Used to change the object’s overlay position on the “Topology Canvas.” An object
with a higher numerically valued z-index will cover an object with a lower
numerically valued z-indexed.

Example: The blue object has a z-index of -1 and the orange object’s z-index is 0.
Orange object is top over blue object.

Border width: Used to change the object’s border width.

Border type: Used to change the border style of the object between solid and dashed.

Border colour: Used to change the colour of the object’s border

Background colour: Used to change the background colour of the object

Transparent: Turns off background colour (filling) and makes the

object transparent.

Rotate: Used to rotate the object on the topology.

Name: Used to change the object’s name.

To save the object, press Save (green button).

10.1.7 Lock objects movement

The “Lock Lab” feature prevents objects from being moved around on the canvas (among other
things). For more information about this feature, refer to section 7.1.12.

10.2 Custom design logical topology

EVE Community includes a feature to upload your own custom topology picture and map nodes
to it for easy access.

10.2.1 Custom design upload

Before you upload a custom picture in the lab, make sure it is
in .png or jpg format with resolution 130-150x130-150 pixels.

TIP: It is best is to create a topology in the MS Visio and after

convert it to the .png picture format with resolution 140x140.

EVE-NG Community Cookbook
Version 5.1

Step 1: Open “Add an Object” and then “Pictures” from the left sidebar or
right click on a free area on topology canvas and hit “Add Picture.”

Step 2: Browse your PC for a .png or .jpg file and hit “Add”.

Once the picture is added to the topology canvas, the sidebar will display a new option: “Logical
maps”

Step 3: Open the “Logical maps” menu item.

Pictures window management

Delete uploaded picture from the lab

Image Map: Map nodes to places in the

picture

Display uploaded picture. Work with lab and

custom topology

Zoom/unzoom uploaded custom topology

Makes the window transparent to see the

“Topology Canvas” behind it. Clicking again
returns to the normal view.

Close “Pictures” window.

10.2.2 Custom topology mapping

This feature allows you to map the lab nodes to your custom topology picture.

Step 1: Open the Image Map window:

Step 2: Select a node, from the dropdown menu, that you want to map to the topology.

EVE-NG Community Cookbook
Version 5.1

Step 3: Move your mouse over a node icon on the “Image Map” and click to map it. The grey
circle means that the node is mapped.

Step 4: Continue mapping the rest of the nodes.

Step 5: OPTIONAL. You can also add a mapping for a device external to your EVE server in
order to telnet, VNC, or RDP to it. This way you can open sessions to all your devices (whether
external or internal) in one place.

Select from menu:

And map with node on topology.

Change image map adding protocol, IP and port.

Step 6: Save your mapping and refresh the browser with F5.

10.2.3 Delete topology or mapping

To delete a single node mapping, right click on node mapping circle and click “Delete.”

EVE-NG Community Cookbook
Version 5.1

To delete the entire custom topology, click delete.

10.3 Configuration export feature

EVE Community includes an export configuration feature that allows you to save and manage
configurations in a lab. The "Configuration Export" and “Startup-configs” features will allow you
to set these saved configurations as startup configs for your nodes when they boot.

IMPORTANT NOTE: Before you start using the “Configuration export” feature, you
must complete at least one configuration export.

Nodes will be greyed out without the option to enable “Startup-

configs” until you complete at least one configuration export for
each node.

Node boot order:

NVRAM: NVRAM is used as writable permanent storage for the startup configuration. During
the boot process, the node will always check NVRAM for a saved configuration. Saving the
configuration to NVRAM requires a vendor specific command. Cisco: copy run startup (wr),
Juniper: commit, etc. It is MANDATORY to save a node’s configuration before you can export
it.

Exported configuration: A node configuration that has been exported from the node. It can
be used to backup configurations or to set them as startup-configs.

Wipe node: Wiping a node will erase the NVRAM (running config) or the temporary image
snapshot, depending on the type of node. Upon a successful wipe, the node will boot with the
factory default configuration or the configuration included in the base image you are using. If
you have the “Startup-config” feature enabled for the node, then it will boot with the chosen
config set. You must wipe a node after changing certain node template settings like the image
or startup-config. You also must wipe the node the first time you want to enable the “Startup-
config” feature.

Factory default configuration: The base configuration that is applied from the manufacturer.

EVE-NG Community Cookbook
Version 5.1

10.3.1 Supported nodes for configuration exports

Cisco Dynamips all nodes
Cisco IOL (IOS on Linux)
Cisco ASA
Cisco ASAv
Cisco CSR1000v
Cisco Nexus 9K
Cisco Nexus Titanium
Cisco vIOS L3
Cisco vIOS L2
Cisco XRv
Cisco XRv9K
Juniper VRR
Juniper VMX
Juniper vMX-NG
JunipervQFX
JunipervSRX
Juniper vSRX-NG
Mikrotik
PFsense FW
Timos Alcatel
vEOS Arista

10.3.2 Startup config management

10.3.2.1 Global commands

Configurations can be managed via the “Startup-configs window which can

be accessed from the sidebar menu while on the Topology page.

Topology page, More Options:

Export all CFGs – Exports all supported node configurations.

Set nodes startup-cfg to default configset- Sets all

supported nodes to boot from the default configuration set.

Set nodes startup-cfg to none - Sets all supported nodes to

boot from NVRAM configuration.

Delete default configuration set. Warning, this will delete

your exported default configuration set for all nodes.

10.3.2.2 Individual node commands

Select node, right click

EVE-NG Community Cookbook
Version 5.1

Wipe: Wipes the NVRAM for a single node

Export CFG: Exports the configuration for a single node

10.3.2.3 Multiple selected nodes commands

Wipe Selected: Wipes the NVRAM for selected nodes

Export all CFGs: Exports the configuration for selected nodes

Set nodes startup-cfg to default configs set: Set selected nodes to the default config set

Set nodes startup-cfg to none: Set nodes to boot from NVRAM or from factory default if
wiped.

Delete nodes startup cfg: Delete selected node’s startup cfg. (clean default set)

10.3.2.4 Startup-configuration window

No configuration exports or manual configs loaded for nodes

Startup-configs are exported and the “Configuration Export” feature can be used.

EVE-NG Community Cookbook
Version 5.1

10.3.2.5 Startup-config window information

Config set menu

No configuration is available for node. Grey

node

Configuration is available and can be used.

Blue node. Exported configuration persist

Configuration persist but it is disabled. Node

will boot from NVRAM or factory default if it
is wiped

Configuration persists and node will boot

from the configuration after being wiped

Ace Editor. Different vendor configuration

edit option. Just Text visual format.

10.3.3 Export configuration

Example:

Step 1: MANDATORY: Configure your nodes and make sure you applied the vendor specific
command to save the running configuration to NVRAM. If you do not save the configuration, it
will not be exported and in the notification area, you will receive an error message stating the
node cannot be exported.

In this example the nodes have been configured with hostnames only and the configurations
have been saved to NVRAM.

Step 2: In the example below a group of nodes were selected to export configurations.

EVE-NG Community Cookbook
Version 5.1

Step 3: Use “Export all CFGs” for selected nodes. Export configuration is
completed. The notification area will display “Export All: done” when complete.

10.3.4 Boot nodes from exported config set

Step 1: Stop all nodes

Step 2: Open sidebar and click Startup-configs. Make sure your config is set to ON and the
nodes config switch is green (switch on/off beside node). Press the green “Save” button (on
the bottom) and all your nodes will boot with the exported config set after wiping them.

Step 3: Wipe nodes. For more information refer to section 8.1.3

Step 4: Start nodes

10.3.5 Edit exported configurations

It is possible to edit your configurations for the nodes manually.

Step 1: Select the node you want to edit the configuration of and make your changes. Click
“Save” when you are finished.

EVE-NG Community Cookbook
Version 5.1

Step 2: Save the config for nodes with the green “Save” button on the bottom.

NOTE: you can manually copy/paste any configuration into the config set editor and
apply it to your node. Make sure your configuration interfaces match the lab node’s
interface names.

10.3.6 Set lab to boot from none

To reset your lab nodes’ configuration to factory default, follow the steps below:

Step 1: Wipe nodes. Refer to section 10.3 for information about wiping nodes and the order of
operations during boot.

Step 2: Open sidebar and click Startup-configs. Make sure your config is set to OFF and the
nodes config switch is red (switch on/off beside node). Press the green “Save” button (on the
bottom) and all your nodes will boot with no config/factory default after wiping them.

Step 3: Start nodes

10.3.7 Lab config script timeout

Lab config script timeout is used when nodes are waiting to boot from a config set. The node
will literally wait during boot until the configuration is applied from the config set.

Hit “More actions” and then “Edit lab” from the sidebar. Set the config script timeout in seconds.
By default, this timer is set to 300 seconds for new labs.

EVE-NG Community Cookbook
Version 5.1

NOTE: For heavy labs and nodes with

long configurations, you can raise this
timer to 600 seconds or higher.

EVE-NG Community Cookbook
Version 5.1

11 EVE Troubleshooting
11.1 CLI diagnostic information display commands

11.1.1 Display full EVE Community diagnostic

eve-info

11.1.2 Display the currently installed EVE Community version:

dpkg -l eve-ng

11.1.3 Display if EVEs Intel VT-x/EPT option on/off:

kvm-ok

11.1.4 Display EVEs CPU INFO:

lscpu

11.1.5 Display EVEs HDD utilization.

If the /boot only has a little space left you can refer to section 3.6.1.1. If the eve—ng—vg—root
reaches 99% or 100% then you will need to expand the HDD in order to continue using EVE.
The Solution to expand your HDD is described in section 11.1

df -h

EVE-NG Community Cookbook
Version 5.1

11.1.6 Display EVEs Bridge interface status

brctl show

11.1.7 Display EVEs system services status

systemctl list-unit-files --state=enabled

11.2 Expand EVEs System HDD

IMPORTANT NOTE: DO NOT expand your current/existing HDD on your EVE VM!

11.2.1 Expand HDD on VMware Workstation

Expanding your EVEs system HDD is achieved by adding an additional HDD to your EVE VM.

Step 1: Stop all your labs and shutdown EVE.

Use EVE CLI command: shutdown -h now

EVE-NG Community Cookbook
Version 5.1

Step 2: Go to edit VM settings and add a new Hard drive.

Then click Next.

Step 3: Leave the recommended SCSI HDD option and then

click Next

Step 4: Make sure you have selected the option “Create a

new Virtual disk.”

Step 5: Set your desirable HDD Size; example 200GB.

Step 6: Make sure you have set the option “Store Virtual disk as a single file” and then click
Next

Step 7: Optional: Specify the location of where your new HDD will be stored, then click Finish.

Step 8: Boot your EVE VM, HDD size will be expanded automatically. To verify, use the
command to verify HDD utilization referenced in section 11.1.5

11.2.2 Expand your HDD on ESXi

Expanding your EVEs system HDD is achieved by adding an additional HDD to your EVE VM.

Step 1: Stop all your labs and shutdown EVE.

Use EVE CLI command: shutdown -h now

Step 2: Go to edit VM settings and add a new Hard

drive. Then click Next

Step 3: Make sure you have selected the option “Create

a new Virtual disk.” Then click Next

Step 4: Set your desirable HDD Size; example 200GB.

Step 5: It is recommended to set the Thick Provision Lazy Zeroed HDD option.

Step 6: Specify the location of where your new HDD will be stored and then click Next

Step 7: Leave the recommended SCSI HDD option as is and click Finish.

Step 8: Boot your EVE VM, the HDD size will be expanded automatically. To verify, use the
command to verify HDD utilization referenced in section 11.1.5

11.2.3 Expand your HDD on a Bare Metal EVE Server

It is a complicated process to expand a HDD for a bare metal EVE server. Please open a ticket
in our Live chat support for advice.

http://www.eve-ng.net/live-helpdesk

Use a google account to join in the Live Chat or create new chat account.

EVE-NG Community Cookbook
Version 5.1

11.3 Reset Management IP

Type the following commands into the CLI followed by enter:

rm -f /opt/ovf/.configured

su –

http://www.eve-ng.net/documentation/installation/bare-installIP address setup wizard. Please

follow the steps in section 3.5.1 for Static IP or 3.5.2 for DHCP IP setup.

11.4 EVE Community SQL Database recovery

Starting from EVE Community version 2.0.3-95, you can recover SQL user database in case
of disaster:

unl_wrapper -a restoredb

11.5 EVE Log files

EVE log Files can be obtained from the System Logs page under the System dropdown menu

Use the menu to collect log file data you are interested in.

11.6 EVE cli diagnostic info

Use EVE cli to obtain your EVE information:

eve-info

EVE-NG Community Cookbook
Version 5.1

12 Images for EVE

Images must be uploaded and prepared before they can be used in labs. The best way to
upload images is to use the WinSCP tool for Windows environment or FileZilla for MAC OSX
and Linux.

Link to download WinSCP:

https://winscp.net/eng/download.php

Link to download FileZilla:

https://filezilla-project.org/

To access EVE, use SSH protocol (port 22).

Supported images for EVE are stored in the three locations:

• IOL (IOS on Linux), /opt/unetlab/addons/iol/bin/

• Dynamips images, /opt/unetlab/addons/dynamips

• Qemu images, /opt/unetlab/addons/qemu

12.1 Qemu image naming table

IMPORTANT NOTE: Intel VT-X/EPT must be enabled to run Qemu nodes in EVE. For
information on how to enable this option, Refer to section 3: EVE Installation.

The directory names used for QEMU images are very sensitive and must match the table below
exactly in order to work.

Ensure your image folder name starts as per the table. After the "-" you can add whatever you
like to label the image. We recommend using the version of your image.

Folder name examples:

firepower6-FTD-6.2.1
acs-5.8.1.4

The image hdd inside the folder must be named correctly:

Example: hda.qcow2 or virtioa.qcow2

Full path Example: opt/unetlab/addons/qemu/acs-5.8.1.4/hda.qcow2

The table of proper folder names is provided in our website:

https://www.eve-ng.net/index.php/documentation/qemu-image-namings/

Supported HDD formats for the EVE images:

lsi([a-z]+).qcow lsia.qcow
hd([a-z]+).qcow hda.qcow
virtide([a-z]+).qcow virtidea.qcow
virtio([a-z]+).qcow virtioa.qcow

EVE-NG Community Cookbook
Version 5.1

scsi([a-z]+).qcow scsia.qcow
sata([a-z]+).qcow sataa.qcow

12.2 How to prepare images for EVE

How to add EVE-NG images please refer to:

https://www.eve-ng.net/index.php/documentation/howtos/

12.3 How to add custom image template

12.3.1 Templates folder choice

IMPORTANT NOTE: Starting from EVE-Community Version 2.0.3-107, EVE installation is

autodetecting what kind of CPU manufacturer has your server: Intel or AMD, to choose proper
templates set. You can check it manually on EVE cli: example below, showing that EVE has
Intel CPU.

root@eve-ng:~# lsmod | grep ^kvm_

kvm_intel 212992 74
root@eve-ng:~#

• If you have Intel CPU, then your template files are in

"/opt/unetlab/html/templates/intel/"
• If you have AMD CPU, then your template files are in
"/opt/unetlab/html/templates/amd/"

12.3.2 Prepare template file

NOTE: For templates development use templates folder which is matching your EVE server
CPU manufacturer.

Example below will be based for Intel CPU EVE custom image template. Use EVE cli or
WinSCP/Filezilla to create template.

Step 1: Navigate to EVE location: /opt/unetlab/html/templates/intel/

Step 2: Choose your most suitable template from which you want to create your own image
template. (example: newimage.yml)

Step 3: Make a copy from source template newimage.yml. Example: Using CLI create template
and name it ngips.yml.

EVE-NG Community Cookbook
Version 5.1

cp /opt/unetlab/html/templates/intel/newimage.yml /opt/unetlab/html/templates/intel/ngips.yml

You can create new template using WinSCP or Filezilla as well.

IMOPRTANT: The new name of your template will be related to your image foldername. Your
image foldername must start with prefix “ngips- “

Example: image foldername under /opt/unetlab/addons/qemu/ngips-6.5.0-115

12.3.3 Prepare interface format and name lines

EVE Community has included option to create various interface names, sequences and
numbering. Please refer table below.

Formula Template line format Will

example produce

Gi1/0
eth_format: <prefix>{<first value for slot: example eth_format: Gi{1}/{0-8} Gi1/1
1>}<separator>{<first value for port>-<number of Gi1/2
port per slot: example 8>} Gi1/3
Gi1/4
Gi1/5
Gi1/6
Gi1/7
Gi2/0
Gi2/1
....

Ge0/0
eth_format: <prefix>{<first value for slot: example eth_format: Ge{0}/{0-4} Ge0/1
0>}<separator>{<first value for port>-<number of Ge0/2
port per slot: example 4>} Ge0/3
Ge1/0
Ge1/2
Ge1/3
Ge2/0
Ge2/1
Ge2/2

EVE-NG Community Cookbook
Version 5.1

....

Gi0
eth_format: <prefix>{<first value>} eth_format: Gi{0} Gi1
Gi2
Gi3
...

G0/0
eth_format: <prefix>{<first value>} eth_format: G0/{0} G0/1
G0/2
G0/3
...

eth_name: M1
eth_name: <prefix: Interface custom name> - M1 T1
- T1 T2
- T2
eth_name: MGMT
eth_name: <prefix: Interface custom name> - MGMT DATA
- DATA TRAFFIC
- TRAFFIC

Combined first named interface following by formatted interfaces Example: We have to

set first node interface name “eth0/mgmt” and next following interfaces must start from eth1
and change sequence accordingly. eth1, eth2,….,ethx

As your node first interface will be custom named (eth0/mgmt), therefore in the template
“eth_name:” must be added before “eth_format:”

eth_name:
- eth0/mgmt
eth_format: eth{1}

This adding will produce Node interfaces.

12.3.4 Edit your new template file:

For edit newly created template you can use WinSCP, FileZilla or cli. Example below shows
template edit using cli and nano editor

EVE-NG Community Cookbook
Version 5.1

cd /opt/unetlab/html/templates/intel/
nano ngips.yml

Change content, setting for various images can vary depends of vendor requirements. The
interface name lines please refer Section: 12.3.1

# Copyright (c) 2018, Alain Degreffe
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the UNetLab Ltd nor the name of EVE-NG Ltd nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
---
type: qemu
name: NGIPS
description: Cisco FirePower NGIPS
cpulimit: 1
icon: IPS.png
cpu: 4
ram: 8192
ethernet: 3
eth_name:
- eth0/mgmt
eth_format: eth{1}
console: vnc
shutdown: 1
qemu_arch: x86_64
qemu_version: 2.4.0
qemu_nic: e1000
qemu_options: -machine type=pc,accel=kvm -serial none -nographic -no-user-config
-nodefaults -display none -vga std -rtc base=utc -cpu host
...

Note: Qemu options in the line may vary per image requirements. Please check manufacturer
advice how to run KVM image

12.3.5 Prepare new icon for your template:

Step 1 Use Filezilla or Winscp to copy your custom icon IPS.png (icon filename IPS.png used
in ngips.yml)

This icon should be about 30-60 x 30-60 in the png format (switch.png is for example 65 x 33,
8-bit/color RGBA)

Step 2 Copy this new icon into /opt/unetlab/html/images/icons/

EVE-NG Community Cookbook
Version 5.1

12.3.6 Template use

Step 1 Create directory /opt/unetlab/addons/qemu/ngips-6.2.83

mkdir /opt/unetlab/addons/qemu/ngips-6.2.83

Step 4.2 Upload image NGIPS, Refer Section:

12.4 How to hide unused images in the node list

12.4.1 Creating new config.php file

If your EVE Server does not have the config.php file in the /opt/unetlab/html/includes/
directory, then it must be created.

Step 1. Use the EVE CLI. Make sure you are in the following EVE directory:
/opt/unetlab/html/includes/

Step 2. Rename config.php.distributed (the template) to config.php.

mv config.php.distribution config.php

12.4.2 Edit config.php file

Step 1. Use vi or nano file editor to edit your config.php file.

nano config.php

Step 2. Edit the config.php file, uncomment and adjust to your TEMPLATE _DISABLED settings
(see screenshot below).

“hided” will remove unloaded/empty image templates from nodes list in WEB GUI

“missed” will show you all available templates in EVE WEB nodes list

Example below will give you result:

<?php
// TEMPLATE MODE .missing or .hided
DEFINE('TEMPLATE_DISABLED','.hided') ;
?>

You are seeing only templates with loaded images.

EVE-NG Community Cookbook
Version 5.1

13 EVE Resources
For additional updated information please follow our web site: https://www.eve-ng.net

How to updates: https://www.eve-ng.net/index.php/documentation/howtos/

How to videos: https://www.eve-ng.net/index.php/documentation/howtos-video/

FAQ: https://www.eve-ng.net/index.php/faq/

Live support chat: https://www.eve-ng.net/index.php/live-helpdesk/

For access to live chat use your Google account or create new chat account.

EVE forum: https://www.eve-ng.net/forum/

To access forum resources, please create a new forum account.

EVE YouTube channel:

https://www.youtube.com/playlist?list=PLF8yvsYkPZQ0myW7aVMZ80k8FU04UUgjV

EVE Professional downloads: https://www.eve-ng.net/index.php/download/

EVE Community version downloads, free: https://www.eve-ng.net/index.php/community/

EVE Supported images: https://www.eve-ng.net/index.php/documentation/supported-images/

EVE Comm BOOK 5.0 2022
No ratings yet
EVE Comm BOOK 5.0 2022
150 pages
Eve Cook Book 4.6 2021
No ratings yet
Eve Cook Book 4.6 2021
262 pages
Eve Cook Book 5.1 2022
No ratings yet
Eve Cook Book 5.1 2022
268 pages
Eve Cook Book 4.11 2021
No ratings yet
Eve Cook Book 4.11 2021
270 pages
Eve Cook Book 3.1 2020 PDF
No ratings yet
Eve Cook Book 3.1 2020 PDF
246 pages
EVE Comm BOOK 1.07 2020 PDF
No ratings yet
EVE Comm BOOK 1.07 2020 PDF
165 pages
EVE Comm BOOK 1.09 2020 PDF
No ratings yet
EVE Comm BOOK 1.09 2020 PDF
165 pages
Eve Ce Book 5.5 2024
No ratings yet
Eve Ce Book 5.5 2024
160 pages
Eve Pe Book 5.12 2024
No ratings yet
Eve Pe Book 5.12 2024
288 pages
Eve Ce Book 5.3 2023 PDF
No ratings yet
Eve Ce Book 5.3 2023 PDF
159 pages
Eve Pe Book 5.9 2023
No ratings yet
Eve Pe Book 5.9 2023
281 pages
Eve Cook Book 1.35 2020
No ratings yet
Eve Cook Book 1.35 2020
251 pages
Eve Cook Book 1.5
No ratings yet
Eve Cook Book 1.5
213 pages
EVE-NG CE Cookbook v6.1 Guide
No ratings yet
EVE-NG CE Cookbook v6.1 Guide
146 pages
Eve Cook Book 1.0
No ratings yet
Eve Cook Book 1.0
197 pages
Eve Cook Book 1.12 PDF
No ratings yet
Eve Cook Book 1.12 PDF
237 pages
EVE COOK BOOK Chap1
No ratings yet
EVE COOK BOOK Chap1
10 pages
Eve Cook Book 1.8
No ratings yet
Eve Cook Book 1.8
226 pages
Eve C
100% (1)
Eve C
273 pages
Eve-Ng Cookbook
No ratings yet
Eve-Ng Cookbook
226 pages
Eve Cook Book 1.22 2019 PDF
No ratings yet
Eve Cook Book 1.22 2019 PDF
244 pages
PDF - Js Viewer
No ratings yet
PDF - Js Viewer
165 pages
3.1 Vmware Workstation or VM Player
No ratings yet
3.1 Vmware Workstation or VM Player
55 pages
EVE-NG Setup with Juniper Topologies
No ratings yet
EVE-NG Setup with Juniper Topologies
19 pages
Installing EVE-NG ISO
No ratings yet
Installing EVE-NG ISO
19 pages
EVE NG On Google Cloud PDF
No ratings yet
EVE NG On Google Cloud PDF
39 pages
08 Installing+EVE NG
No ratings yet
08 Installing+EVE NG
10 pages
10 Installing EVE NG
100% (1)
10 Installing EVE NG
11 pages
Operating System Installation GuideV37
No ratings yet
Operating System Installation GuideV37
3 pages
Running Multiple OcNOS VMs in EVE NG Quick Start Guide 07023
No ratings yet
Running Multiple OcNOS VMs in EVE NG Quick Start Guide 07023
30 pages
EVE COOK BOOK Chap2
No ratings yet
EVE COOK BOOK Chap2
4 pages
Install Eve-Ng On Windows
No ratings yet
Install Eve-Ng On Windows
12 pages
EVE-NG Installation & Configuration Guide
No ratings yet
EVE-NG Installation & Configuration Guide
6 pages
MS Windows Server - Deployement
No ratings yet
MS Windows Server - Deployement
8 pages
Manual OpenHPC
No ratings yet
Manual OpenHPC
52 pages
Install - Guide CentOS7 SLURM 1.3 x86 - 64
No ratings yet
Install - Guide CentOS7 SLURM 1.3 x86 - 64
45 pages
Install - Guide CentOS7 xCAT SLURM 1.3.3 x86 - 64
No ratings yet
Install - Guide CentOS7 xCAT SLURM 1.3.3 x86 - 64
48 pages
EVE - Cluster - Presentation 4.4 Pro
No ratings yet
EVE - Cluster - Presentation 4.4 Pro
14 pages
Install - Guide Rocky8 Warewulf Slurm 2.9 x86 - 64
No ratings yet
Install - Guide Rocky8 Warewulf Slurm 2.9 x86 - 64
58 pages
DevOps Pipeline Setup Guide
No ratings yet
DevOps Pipeline Setup Guide
18 pages
Ubuntu 16.04 Base Install Eve-Ng Community2.0.3-112
No ratings yet
Ubuntu 16.04 Base Install Eve-Ng Community2.0.3-112
21 pages
OpenScape Enterprise Express V9, Staging Guide, Installation Guide, Issue 20.
100% (1)
OpenScape Enterprise Express V9, Staging Guide, Installation Guide, Issue 20.
151 pages
Install - Guide CentOS7 xCAT Stateless SLURM 1.3.9 x86 - 64 1
No ratings yet
Install - Guide CentOS7 xCAT Stateless SLURM 1.3.9 x86 - 64 1
57 pages
Install - Guide CentOS7 xCAT Stateful SLURM 1.3.9 x86 - 64
No ratings yet
Install - Guide CentOS7 xCAT Stateful SLURM 1.3.9 x86 - 64
57 pages
Install - Guide Rocky9 Warewulf Slurm 3.2 Aarch64
No ratings yet
Install - Guide Rocky9 Warewulf Slurm 3.2 Aarch64
43 pages
Engine Host Runbook
No ratings yet
Engine Host Runbook
5 pages
Using EVE NG With Juniper Topologies
No ratings yet
Using EVE NG With Juniper Topologies
25 pages
Private Cloud Computing With Opennebula 1.4: C12G Labs S.L
No ratings yet
Private Cloud Computing With Opennebula 1.4: C12G Labs S.L
56 pages
Group 1 Project
No ratings yet
Group 1 Project
44 pages
Hadoop Installation: Sunday, December 13, 2020 1
No ratings yet
Hadoop Installation: Sunday, December 13, 2020 1
18 pages
EVE NG With GCP
No ratings yet
EVE NG With GCP
2 pages
EFS Systems On A Linux A Linux Base: Getting Started G Started
100% (1)
EFS Systems On A Linux A Linux Base: Getting Started G Started
120 pages
CC Record
No ratings yet
CC Record
59 pages
Winder Ai
No ratings yet
Winder Ai
10 pages
IGCSE Surds
100% (1)
IGCSE Surds
12 pages
PR App Guide
No ratings yet
PR App Guide
17 pages
Lesson 5 Python For Loops While Loops
No ratings yet
Lesson 5 Python For Loops While Loops
7 pages
A Decade of Progress in Wearable Sensors For Fall Detection (2015-2024) : A Network-Based Visualization Review
No ratings yet
A Decade of Progress in Wearable Sensors For Fall Detection (2015-2024) : A Network-Based Visualization Review
19 pages
A Three-Phase Inverter For A Standalone Distributed Generation System-Adaptive Voltage Control Design and Stability Analysis - 201403
No ratings yet
A Three-Phase Inverter For A Standalone Distributed Generation System-Adaptive Voltage Control Design and Stability Analysis - 201403
11 pages
Request For Proposal - New Subway Trains - P76PA25001
No ratings yet
Request For Proposal - New Subway Trains - P76PA25001
1,416 pages
Elc2009 Qemu Cris
No ratings yet
Elc2009 Qemu Cris
43 pages
Lighting Distribution Pricelist 1st Nov 2015 - Update
No ratings yet
Lighting Distribution Pricelist 1st Nov 2015 - Update
24 pages
FX-Service Manual en 21-02-14
No ratings yet
FX-Service Manual en 21-02-14
87 pages
JD - AI Tech Lead
No ratings yet
JD - AI Tech Lead
2 pages
(BOSE) CS Mid Sem Notes
No ratings yet
(BOSE) CS Mid Sem Notes
13 pages
Coe - PTC - Brochure - 24 06 2021 English 07 07 2021
No ratings yet
Coe - PTC - Brochure - 24 06 2021 English 07 07 2021
4 pages
74 343 Exam
No ratings yet
74 343 Exam
5 pages
DS Lab Manual 2023
No ratings yet
DS Lab Manual 2023
56 pages
EATON Circuit Breakers
No ratings yet
EATON Circuit Breakers
1 page
P 3.1.3 Hierarchical
No ratings yet
P 3.1.3 Hierarchical
30 pages
10th Social EM
No ratings yet
10th Social EM
26 pages
21-6135 Harris County Equity Guidelines
No ratings yet
21-6135 Harris County Equity Guidelines
3 pages
TRF It A LV 1ph FLT
No ratings yet
TRF It A LV 1ph FLT
1 page
7.5 Arrays, Records, Pointers
No ratings yet
7.5 Arrays, Records, Pointers
7 pages
Artificial Intelligence Machine Automation Controller: NX701-Z 00 / NY5 2-Z 00
No ratings yet
Artificial Intelligence Machine Automation Controller: NX701-Z 00 / NY5 2-Z 00
12 pages
Rexroth 4we10 Data Sheet PDF
0% (1)
Rexroth 4we10 Data Sheet PDF
10 pages
TikTok Growth for DTC Brands
100% (1)
TikTok Growth for DTC Brands
19 pages
Mello, Salim, Simões - 2022 - UAV-based Landfill Operation Monitoring A Year of Volume and Topographic Measurements
No ratings yet
Mello, Salim, Simões - 2022 - UAV-based Landfill Operation Monitoring A Year of Volume and Topographic Measurements
11 pages
Easy-PhotoPrintEditor V1.9 Win Mac TC V01
No ratings yet
Easy-PhotoPrintEditor V1.9 Win Mac TC V01
220 pages
Steam Turbines (Api 612) : Company Technical Standard
No ratings yet
Steam Turbines (Api 612) : Company Technical Standard
37 pages
Filtro Hidráulico Pi270 Mahle
No ratings yet
Filtro Hidráulico Pi270 Mahle
6 pages
BCA Scheme Syllabus 2023-24 (6-6-2023)
No ratings yet
BCA Scheme Syllabus 2023-24 (6-6-2023)
203 pages
Installation Guide: Dfmpro For Solidworks
No ratings yet
Installation Guide: Dfmpro For Solidworks
17 pages