GNS3 VYOS Summary
Now that we have GNS installed on a system we need to populate it with appliances before we can get to running simulations. Since we will need routers to move our packets around there’s no better place to start than the open source routing appliance VyOS. VyOS will run under KVM requiring either a native Linux install like we covered previously or the GNS3 VM on Window or macOS.
Gather our files
Before we can import the appliance we will need the latest appliance file from the GNS3 Appliance Registry, the appliance ISO from VyOS, and an Empty 8g QEMU disk image from the GNS sourceforge. We will want all of the files in our downloads directory for fast and easy GNS3 detection.
If you want to learn more about GNS3, you may be interested in The Book of GNS3 available on Amazon as paperback or Kindle. Check it out using our Amazon affiliate link, https://amzn.to/322eKCO.
- VyOS 1.18 Download ISO – This is the latest LTS ISO as of the writing of this article.
- 8GB Empty QCOW image – This is the image supplied by GNS3 and specified in the Appliance Template.
- VyOS Appliance Template – This is the appliance template from the GNS3 github and needs to be saved with the .gns3a extension.
Importing the new Appliance
Now that you have all the files downloaded we can launch GNS3 to proceed with the import. You will be greeted with the Project window which you can close as we will not be creating a project today.
Once closed you will the Select the Import appliance option from the File menu. This will immediately open a file explorer window in your Downloads directory where you should have the VyOS appliance file. Select the appliance file to begin the import process.
Once selected the import process starts with a description of the appliance as well as some information on its architecture.
Since we are running on a native linux install we will be running this appliance directly on the local machine. If you are running under Windows or macOS the wizard will help you import to the GNS3 VM. Additionally the wizard can import appliances to shared server instances as well.
If your GNS3 install was performed correctly then the server should meet the requirements and allow you to proceed with deployment of the appliance.
Now we can see that GNS3 has detected our files for VyOS 1.18 and lists it as ready to install. You will highlight the 1.1.8 option and click next to proceed.
GNS3 will now ask for confirmation of the appliance version you wish to import.
GNS3 should auto-detect the proper QEMU binary to emulate a VyOS system (x86_64). Ensure that this is the case and proceed with the installation.
The next page will be the summary of the newly imported appliance. These values can be modified after you’ve imported the appliance either at the template level or on a per device basis. I would advise only increasing the number of interfaces, if running large simulations, as the default options work well for most use cases.
The last screen before completion provides some details about the appliance. In this case that it is a router and the default login information is vyos/vyos (unchanged from VyOS documentation).
The wizard will notify you that VyOS is now installed and it will appear under the router category.
Using the VyOS Appliance
The VyOS appliance can be used in two ways in your GNS3 topology. If you are just running something quickly that is disposable you can configure the appliance directly from the console for immediate use, however, no persistent changes will be made. If you plan on using it for a project that needs to be saved then you will want to install the appliance to the generated disk and then you can save changes like a normal VyOS appliance.
Create a new Project
In order to use the VyOS appliance you are going to need a project to work from.
To use your 1st VyOS drag it onto the project and then click the green arrow to start all project devices. Once started you can double click the Appliance to open a terminal window.
If you wish to install VyOS to the instances HDD image for persistent then follow the VyOS steps for install image.
If you do not need persistence then you can start configuring the VyOS appliance immediately for use in your topology.
If you want to read more articles on GNS3 then click here!