GNS3

https://docs.gns3.com/docs/
Admin
GNS3 is an open-source network software emulator that allows network engineers to design, build, and...
Tokens:32,652
Snippets:508
Trust Score:9.3
Update:3 months ago
Show doc for...
Tokens:
Raw
### Build and install GNS3 server

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Install the GNS3 server daemon using the Python setup script.

```bash
sudo python3 setup.py install
```

--------------------------------

### Install and run GNS3 Web UI

Source: https://docs.gns3.com/docs/contribute/how-to-debug-web-ui-guide

Commands to install dependencies, start the development server, or build the application.

```bash
yarn install
```

```bash
yarn ng serve
```

```bash
yarn ng build
```

--------------------------------

### Install yay from binary

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs the pre-built binary version of the yay AUR helper.

```bash
pacman -S --needed git base-devel  

git clone https://aur.archlinux.org/yay-bin.git  

cd yay-bin  

makepkg -si  
```

--------------------------------

### Install yay from source

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Compiles and installs the yay AUR helper from source.

```bash
pacman -S --needed git base-devel  

git clone https://aur.archlinux.org/yay.git  

cd yay  

makepkg -si  
```

--------------------------------

### Install GNS3 prerequisites on Arch

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs necessary emulation and virtualization packages via yay.

```bash
yay -S qemu docker vpcs dynamips libvirt ubridge inetutils  
```

--------------------------------

### Start Systemd daemon

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Start the GNS3 service using systemctl.

```bash
sudo systemctl start gns3
```

--------------------------------

### Install GNS3 Server and GUI on Arch

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs GNS3 components using the AUR helper.

```bash
yay -S gns3-server gns3-gui   
```

--------------------------------

### Install System Dependencies on macOS

Source: https://docs.gns3.com/docs/contribute/development-of-gns3

Commands to install Python and PyQt5 using Homebrew.

```bash
brew install python3  

brew install PyQt5  
```

--------------------------------

### Install GNS3 on Remote Server

Source: https://docs.gns3.com/docs/getting-started/installation/remote-server

Run these commands as root on a fresh Ubuntu 18.04 LTS installation to install GNS3 and configure the VPN.

```bash
cd /tmp  

curl https://raw.githubusercontent.com/GNS3/gns3-server/master/scripts/remote-install.sh > gns3-remote-install.sh  

bash gns3-remote-install.sh --with-openvpn --with-iou --with-i386-repository  
```

--------------------------------

### Add license via terminal

Source: https://docs.gns3.com/docs/how-to-guides/importing-vmx-and-vqfx-into-gns3

Installs a trial license key directly through the CLI.

```text
> request system add license terminal
```

--------------------------------

### Install Kernel Packages

Source: https://docs.gns3.com/docs/getting-started/setup-wizard-gns3-vm

Install the downloaded deb packages using dpkg.

```bash
sudo dpkg -i *.deb
```

--------------------------------

### TinyCore Network Configuration Settings

Source: https://docs.gns3.com/docs/emulators/adding-vmware-vms-to-gns3-topologies

Example network configuration parameters for a TinyCore Linux virtual machine.

```text
Interface: eth0  

IP address: 10.1.1.2  

Mask: 255.255.255.0  

Broadcast: 10.1.1.255  

Gateway: 10.1.1.1  

DNS: 8.8.8.8  
```

--------------------------------

### Install Development Dependencies

Source: https://docs.gns3.com/docs/contribute/development-of-gns3

Commands to install project dependencies for development environments.

```bash
sudo pip3 install -r dev-requirements.txt  
```

```bash
python.exe -m pip install -r dev-requirements.txt  
```

```bash
pip3 install -r dev-requirements.txt  
```

--------------------------------

### Enable GNS3 on boot

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Configure the GNS3 service to start automatically when the system boots.

```bash
sudo systemctl enable gns3
```

--------------------------------

### Install Dynamips build tools

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs build-essential and CMake for compiling Dynamips.

```bash
sudo apt update  

sudo apt install build-essential  

sudo apt install cmake  
```

--------------------------------

### Install Dynamips dependencies

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs required libraries for building Dynamips.

```bash
sudo apt update  

sudo apt install libelf-dev libpcap0.8-dev  
```

--------------------------------

### Install GNS3 via pipx

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs GNS3 server and GUI using pipx.

```bash
pipx install gns3-server  

pipx install gns3-gui  
```

--------------------------------

### GNS3 Server Configuration File Example

Source: https://docs.gns3.com/docs/using-gns3/administration/gns3-server-configuration-file

An example of the gns3_server.conf/ini file structure, including sections for Server, VPCS, Dynamips, IOU, VirtualBox, and VMware settings.

```ini
[Server]  

; IP where the server listen for connection  

host = 127.0.0.1  

; HTTP port for controlling the servers  

port = 3080  

; Path where images of devices are stored  

images_path = /home/gns3/GNS3/images  

; Path where user project are stored  

projects_path = /home/gns3/GNS3/projects  

; Send crash to the GNS3 team  

report_errors = True  

; First port of the range allocated to devices telnet console  

console_start_port_range = 2001  

; Last port of the range allocated to devices telnet console  

console_end_port_range = 5000  

; First port of the range allocated to communication between devices. You need two port by link  

udp_start_port_range = 10000  

; Last port of the range allocated to communication between devices. You need two port by link  

udp_end_port_range = 20000  

; Path of the ubridge program  

ubridge_path = /Applications/GNS3.app/Contents/Resources/ubridge  

; Boolean for enabling HTTP auth  

auth = True  

; Username for HTTP auth  

user = bob  

; Password for HTTP auth  

password = alice  

  

[VPCS]  

; Path of the VPCS binary  

vpcs_path = /usr/local/bin/vpcs  

  

[Dynamips]  

allocate_aux_console_ports = False  

mmap_support = True  

; Path of the dynamips path  

dynamips_path = /usr/local/bin/dynamips  

sparse_memory_support = True  

ghost_ios_support = True  

  

[IOU]  

; Path of the iouyap binary  

iouyap_path = /usr/local/bin/iouyap  

; Path of your .iourc file. If empty we search in $HOME/.iourc  

iourc_path = /home/gns3/.iourc  

; Validate if the iourc is correct. If you turn off and your licence is invalid iou will crash without errors  

license_check = True  

  

[VirtualBox]  

; Path of the VBoxManage command  

vboxmanage_path = /usr/local/bin/VBoxManage  

; Run VirtualBox with sudo as vbox_user  

vbox_user =  

  

[VMware]  

; Type of Virtualization product (fusion, player, workstation)  

host_type = fusion  

; First vmnet adapter controlled by GNS3  

vmnet_start_range = 2  

; Last vmnet adapter controlled by GNS3  

vmnet_end_range = 50  

; Path of the vmrun executable  

vmrun_path = /Applications/VMware Fusion.app/Contents/Library/vmrun
```

--------------------------------

### Install IOU support on Ubuntu

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Adds i386 architecture support and installs the GNS3 IOU package.

```bash
sudo dpkg --add-architecture i386  

sudo apt update  

sudo apt install gns3-iou  
```

--------------------------------

### Start GNS3 GUI

Source: https://docs.gns3.com/docs/contribute/development-of-gns3

Commands to launch the GNS3 GUI application.

```bash
python3 -m gns3  
```

```bash
python3.exe -m gns3  
```

--------------------------------

### Install GNS3 on Ubuntu-based distributions

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Adds the GNS3 PPA and installs the GUI and server packages.

```bash
sudo add-apt-repository ppa:gns3/ppa  

sudo apt update                                  

sudo apt install gns3-gui gns3-server  
```

--------------------------------

### Start Upstart daemon

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Launch the GNS3 service using the Upstart service manager.

```bash
sudo service gns3 start
```

--------------------------------

### Example iourc license file format

Source: https://docs.gns3.com/docs/emulators/non-native-iou-for-windows-and-osx

The iourc file must contain a valid license key provided by Cisco. This is a placeholder example and will not function as a real license.

```text
[license]  

gns3vm = 42aa42bb42cc84ff;  
```

--------------------------------

### Install Docker dependencies

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs required packages for Docker CE installation.

```bash
sudo apt-get install apt-transport-https ca-certificates curl software-properties-common  
```

--------------------------------

### Install Docker-CE

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Updates package lists and installs the Docker Community Edition.

```bash
sudo apt update  

sudo apt install docker-ce  
```

--------------------------------

### Create VLANs in vlan database

Source: https://docs.gns3.com/docs/using-gns3/beginners/switching-and-gns3

Example of creating VLANs 10 and 20 using the vlan database mode on an Etherswitch router.

```text
vlan database
vlan 10
vlan 20
exit
```

--------------------------------

### Launch GNS3 Server

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Starts the GNS3 server process.

```bash
gns3server  
```

--------------------------------

### Install GNS3 dependencies on Debian

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Installs Python and required emulation/GUI packages.

```bash
sudo apt install python3 python3-pip pipx python3-pyqt6 python3-pyqt6.qtwebsockets python3-pyqt6.qtsvg qemu-kvm qemu-utils libvirt-clients libvirt-daemon-system virtinst dynamips software-properties-common ca-certificates curl gnupg2   
```

```bash
sudo apt install python3 python3-pip pipx python3-pyqt6 python3-pyqt6.qtwebsockets python3-pyqt6.qtsvg qemu-kvm qemu-utils libvirt-clients libvirt-daemon-system virtinst ca-certificates curl gnupg2   
```

--------------------------------

### Install GNS3 server dependencies

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Install the necessary Python and system packages required to build the GNS3 server daemon.

```bash
python3-setuptools

python3-aiohttp

python3-psutil

python3-jsonschema

git
```

--------------------------------

### Build and install Dynamips

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Clones the Dynamips repository and compiles it from source.

```bash
git clone https://github.com/GNS3/dynamips.git  

cd dynamips  

mkdir build  

cd build  

cmake ..  

make install  
```

--------------------------------

### Start GNS3 Server

Source: https://docs.gns3.com/docs/contribute/development-of-gns3

Commands to launch the GNS3 server in debug and local mode.

```bash
python3 -m gns3server --debug --local  
```

```bash
python.exe -m gns3server --debug --local  
```

--------------------------------

### Execute NMAP Command

Source: https://docs.gns3.com/docs/emulators/create-a-docker-container-for-gns3

Example command to test SSH algorithm support on a target device.

```bash
nmap --script ssh2-enum-algos  target_ip
```

--------------------------------

### Start GNS3 server in SSL mode via CLI

Source: https://docs.gns3.com/docs/using-gns3/administration/client-server-ssl-encryption

Use this command to launch the GNS3 server with SSL enabled, specifying the paths to the certificate and key files.

```bash
gns3server --certfile ~/.config/GNS3/ssl/server.cert --certkey ~/.config/GNS3/ssl/server.key --ssl
```

--------------------------------

### Configure Systemd daemon

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Install the Systemd service file and reload the system manager configuration.

```bash
sudo cp gns3.service.systemd /etc/systemd/system/gns3.service

sudo systemctl daemon-reload
```

--------------------------------

### Launch GNS3 with a specific profile

Source: https://docs.gns3.com/docs/using-gns3/advanced/settings-profiles

Use the --profile flag to specify a profile name when starting the GNS3 client from the command line.

```bash
gns3 --profile work
```

--------------------------------

### Accessing the VPCS Console

Source: https://docs.gns3.com/docs/emulators/vpcs

Displays the initial output upon starting a VPCS node.

```text

Welcome to Virtual PC Simulator, version 0.6.1  

Dedicated to Daling.  

Build time: Feb 25 2016 00:35:23  

Copyright (c) 2007-2015, Paul Meng (mirnshi@gmail.com)  

All rights reserved.  

  

VPCS is free software, distributed under the terms of the "BSD" licence.  

Source code and license can be found at vpcs.sf.net.  

For more information, please visit wiki.freecode.com.cn.  

  

Press '?' to get help.  

  

Executing the startup file  

  

PC1>  



```

--------------------------------

### Create Dockerfile

Source: https://docs.gns3.com/docs/emulators/create-a-docker-container-for-gns3

Initialize a new Dockerfile using the nano text editor.

```bash
nano Dockerfile  
```

--------------------------------

### Configure Upstart daemon

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Copy and set permissions for the Upstart configuration file on older Ubuntu systems.

```bash
sudo cp gns3.conf.upstart /etc/init/gns3.conf

sudo chown root /etc/init/gns3.conf
```

--------------------------------

### Configure R1 Interfaces

Source: https://docs.gns3.com/docs/getting-started/your-first-cisco-topology

Initial configuration of FastEthernet0/0 and Loopback0 on router R1.

```text

R1# conf t  

Enter configuration commands, one per line.  End with CNTL/Z.  

R1(config)# int fa0/0  

R1(config-if)#ip add 10.1.1.1 255.255.255.0  

R1(config-if)#int loop 0  

R1(config-if)#ip add  

*Mar  1 00:03:42.663: %LINEPROTO-5-UPDOWN: Line protocol on Interface Loopback0, changed state to up  

R1(config-if)#ip add 1.1.1.1 255.255.255.255  

R1(config-if)# end  

R1#sh ip int br  

Interface                  IP-Address      OK? Method Status                Protocol  

FastEthernet0/0            10.1.1.1        YES manual administratively down down  

Serial0/0                  unassigned      YES unset  administratively down down  

FastEthernet0/1            unassigned      YES unset  administratively down down  

Serial0/1                  unassigned      YES unset  administratively down down  

Serial0/2                  unassigned      YES unset  administratively down down  

Serial0/3                  unassigned      YES unset  administratively down down  

Serial0/4                  unassigned      YES unset  administratively down down  

Serial0/5                  unassigned      YES unset  administratively down down  

FastEthernet1/0            unassigned      YES unset  administratively down down  

FastEthernet2/0            unassigned      YES unset  administratively down down  

Loopback0                  1.1.1.1         YES manual up                    up  

R1#  


```

--------------------------------

### Remove old Docker versions

Source: https://docs.gns3.com/docs/getting-started/installation/linux

Cleans up existing Docker installations before installing Docker CE.

```bash
sudo apt remove docker docker-engine docker.io  

sudo snap remove docker  
```

--------------------------------

### Navigate to server directory

Source: https://docs.gns3.com/docs/using-gns3/administration/running-gns3-server-as-daemon

Change the current working directory to the cloned GNS3 server folder.

```bash
cd gns3-server
```

--------------------------------

### Save Device Configuration

Source: https://docs.gns3.com/docs/getting-started/your-first-gns3-topology

Persists the current virtual PC configuration to the startup file.

```text
PC-1> save  

Saving startup configuration to startup.vpc  

.  done  

PC-1>  

PC-2> save  

Saving startup configuration to startup.vpc  

.  done  

PC-2>  

PC-3> save  

Saving startup configuration to startup.vpc  

.  done  

PC-3>  
```

--------------------------------

### Define Dockerfile Content

Source: https://docs.gns3.com/docs/emulators/create-a-docker-container-for-gns3

Basic configuration for an Ubuntu-based container with nmap installed.

```dockerfile
FROM ubuntu:16.04  

RUN apt-get update && apt-get install -y nmap  
```

--------------------------------

### Add and delete VLANs using macros

Source: https://docs.gns3.com/docs/using-gns3/beginners/switching-and-gns3

Using global configuration macros to manage VLANs on the Etherswitch router.

```text
va 10
# or
vd 10
```

--------------------------------

### Run Tests

Source: https://docs.gns3.com/docs/contribute/development-of-gns3

Commands to execute the test suite for the project.

```bash
py.test  
```

```bash
python.exe -m py.test  
```

--------------------------------

### Enable R1 Interface

Source: https://docs.gns3.com/docs/getting-started/your-first-cisco-topology

Use the 'no shut' command to bring the FastEthernet0/0 interface up on R1.

```text

R1(config)#int fa0/0  

R1(config-if)#no shut  

R1(config-if)#end  

R1#  

*Mar  1 00:06:52.391: %SYS-5-CONFIG_I: Configured from console by console  

R1#sh  

*Mar  1 00:06:52.667: %LINK-3-UPDOWN: Interface FastEthernet0/0, changed state to up  

*Mar  1 00:06:53.667: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet0/0, changed state to up  


```

--------------------------------

### Upgrade System Packages

Source: https://docs.gns3.com/docs/getting-started/setup-wizard-gns3-vm

Update the package list and upgrade installed packages within the GNS3 VM shell.

```bash
sudo apt update  

sudo apt upgrade
```

--------------------------------

### Saving Configuration

Source: https://docs.gns3.com/docs/emulators/vpcs

Persists the current configuration to the startup file to prevent data loss on restart.

```text

PC1> save  

Saving startup configuration to startup.vpc  

.  done  



```

--------------------------------

### Update Dockerfile with CMD

Source: https://docs.gns3.com/docs/emulators/create-a-docker-container-for-gns3

Modified Dockerfile to include htop and set it as the default startup command.

```dockerfile
FROM ubuntu:16.04  

RUN apt-get update && apt-get install -y nmap  

RUN apt-get install -y htop  

CMD htop  
```

--------------------------------

### Enable Nested Virtualization on ESXi

Source: https://docs.gns3.com/docs/getting-started/installation/esxi

Configuration settings to add to the .vmx file to enable hardware-assisted virtualization on older ESXi versions.

```text
hypervisor.cpuid.v0 = "FALSE"  

vhv.enable= "TRUE"  
```

--------------------------------

### Accessing the PFE Shell

Source: https://docs.gns3.com/docs/how-to-guides/importing-vmx-and-vqfx-into-gns3

Use this command within the vCP VM to open the PFE shell for troubleshooting the virtualized Trio chipset components.

```bash
> start shell pfe network fpc0
```

--------------------------------

### Fix tiny icons on Linux

Source: https://docs.gns3.com/docs/troubleshooting-faq/troubleshoot-gns3

Use this command to launch GNS3 with a specific Qt scale factor to resolve display issues with tiny icons.

```bash
QT_SCALE_FACTOR=1 gns3
```

--------------------------------

### Save Configuration Changes

Source: https://docs.gns3.com/docs/getting-started/your-first-cisco-topology

Commands to persist the running configuration to the startup configuration to ensure changes survive a project reload.

```text
R1#copy running-config startup-config  

Destination filename [startup-config]?  

Building configuration...  

[OK]
```

```text
R1#wr  

Building configuration...  

[OK]  

R1#
```

--------------------------------

### Connect to VPN on Linux

Source: https://docs.gns3.com/docs/getting-started/installation/remote-server

Use OpenVPN to establish a secure connection to the remote GNS3 server.

```bash
# sudo apt-get install openvpn  

# sudo openvpn client.ovpn  

Tue Apr 25 17:12:48 2017 [OpenVPN] Peer Connection Initiated with [AF_INET]X.X.X.X:1194  

Tue Apr 25 17:12:51 2017 TUN/TAP device tun0 opened  

Tue Apr 25 17:12:51 2017 Initialization Sequence Completed  
```

--------------------------------

### Build Docker Container

Source: https://docs.gns3.com/docs/emulators/create-a-docker-container-for-gns3

Build the container image from the current directory.

```bash
docker build -t joe/nmap .  
```
Tokens:
Raw