Ubuntu Server Installation

On a Linux system, netlab uses KVM to run virtual machines and Docker to run containers. Virtual machines in KVM environment and the associated Linux bridges are created with Vagrant using libvirt API. Ansible is used to configure the network devices.

netlab-tools on Linux

The simplest way to install netlab and the whole low-level toolchain on an existing Ubuntu server (bare-metal or VM) is to use the netlab install command (see below). You could also do manual software installation.

  • If needed, install Python3 and pip3 with sudo apt-get update && sudo apt-get install -y python3-pip

  • Install Python package with sudo python3 -m pip install networklab or your preferred Python package installation procedure.


Installing Python packages as root is not the recommended best practice (but gets around the potential PATH problems). Please use your regular Python package installation process if you’re not setting up a throwaway VM/server.

  • Install additional software with netlab install ubuntu ansible libvirt containerlab command (more details).