1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
---
lastproofread: '2026-02-02'
---
(vyos-on-gns3)=
# Run VyOS on GNS3
You may want to test VyOS in a lab environment.
[GNS3](http://www.gns3.com) is a network emulation software that you
can use for this purpose.
This guide will provide the necessary steps for installing
and setting up VyOS on GNS3.
## Requirements
The following items are required:
- A VyOS installation image (.iso file). You
can find how to get it on the {ref}`installation` page
- A working GNS3 installation. For further information see the
[GNS3 documentation](https://docs.gns3.com/).
(vm-setup)=
## VM setup
First, a virtual machine (VM) for the VyOS installation must be created
in GNS3.
Go to the GNS3 **File** menu, click **New template**, and select
**Manually create a new Template**.
:::{figure} /_static/images/gns3-01.webp
:::
Select **Qemu VMs** and then click the `New` button.
:::{figure} /_static/images/gns3-02.webp
:::
Write a name for your VM, such as "VyOS", and click `Next`.
:::{figure} /_static/images/gns3-03.webp
:::
Select **qemu-system-x86_64** as Quemu binary, then **512MB** of RAM
and click `Next`.
:::{figure} /_static/images/gns3-04.webp
:::
Select **telnet** as your console type and click `Next`.
:::{figure} /_static/images/gns3-05.webp
:::
Select **New image** for the base disk image of your VM and click
`Create`.
:::{figure} /_static/images/gns3-06.webp
:::
Use the defaults in the **Binary and format** window and click
`Next`.
:::{figure} /_static/images/gns3-07.webp
:::
Use the defaults in the **Qcow2 options** window and click `Next`.
:::{figure} /_static/images/gns3-08.webp
:::
Set the disk size to 2000 MiB, and click `Finish` to end the **Quemu
image creator**.
:::{figure} /_static/images/gns3-09.webp
:::
Click `Finish` to end the **New QEMU VM template** wizard.
:::{figure} /_static/images/gns3-10.webp
:::
Now you need to edit the VM settings.
In the **Preferences** window, with **Qemu VMs** selected and your new VM
selected, click the `Edit` button.
:::{figure} /_static/images/gns3-11.webp
:::
In the **General settings** tab of your **QEMU VM template
configuration**, do the following:
- Click on the `Browse...` button to choose the **Symbol** you want to
have representing your VM.
- In **Category** select in which group you want to find your VM.
- Set the **Boot priority** to **CD/DVD-ROM**.
:::{figure} /_static/images/gns3-12.webp
:::
At the **HDD** tab, change the Disk interface to **sata** to speed up
the boot process.
:::{figure} /_static/images/gns3-13.webp
:::
At the **CD/DVD** tab click on `Browse...` and locate the VyOS image
you want to install.
:::{figure} /_static/images/gns3-14.webp
:::
:::{note}
You probably will want to accept to copy the .iso file to your
default image directory when you are asked.
:::
In the **Network** tab, set the number of adapters to **0**, set the
**Name format** to **eth\{0}**, and set the **Type** to **Paravirtualized
Network I/O (virtio-net-pci)**.
:::{figure} /_static/images/gns3-15.webp
:::
In the **Advanced** tab, unmark the checkbox **Use as a linked base
VM** and click `OK`, which will save and close the **QEMU VM template
configuration** window.
:::{figure} /_static/images/gns3-16.webp
:::
At the general **Preferences** window, click `OK` to save and close.
:::{figure} /_static/images/gns3-17.webp
:::
(vyos-installation)=
## VyOS installation
- Create a new project.
- Drag the newly created VyOS VM into it.
- Start the VM.
- Open a console.
The console displays the system booting. It prompts for login
credentials. You're now at the VyOS live system.
- {ref}`Install VyOS <installation>`
as normal (that is, using the `install image` command).
- After successful installation, shut down the VM with the `poweroff`
command.
- **Delete the VM** from the GNS3 project.
The *VyOS-hda.qcow2* file now contains a working VyOS image and can be
used as a template. But it still needs some fixes before we can deploy
VyOS in our labs.
(vyos-vm-configuration)=
## VyOS VM configuration
To turn the template into a working VyOS machine, further steps are
necessary as outlined below:
**General settings** tab: Set the boot priority to **HDD**
:::{figure} /_static/images/gns3-20.webp
:::
**CD/DVD** tab: Clear the **Image** entry field to unmount the installation
image.
:::{figure} /_static/images/gns3-21.webp
:::
Set the number of required network adapters. For example, set it to **4**.
:::{figure} /_static/images/gns3-215.webp
:::
**Advanced** settings tab: Check the **Use as a linked
base VM** checkbox and click `OK` to save the changes.
:::{figure} /_static/images/gns3-22.webp
:::
The VyOS VM is now ready to be deployed.
|
