Manual:KVM
Applies to RouterOS: v4.3+ on x86
Overview
Kernel-based Virtual Machine (KVM) is the method to run multiple guest operating systems on one RouterOS host. KVM can be used only on x86 machines that have CPU with virtualization support .
Requirements
KVM requires Intel VT-x or AMD-V CPU virtualization support. Here you can find a list of supported CPUs, for more detailed information look on vendor's web site.
Each guest requires at least 16 MB of RAM and sufficient storage space on image file. Once image file have been created, its size cannot be increased.
KVM support in RouterOS is enabled if kvm package is installed.
Where it can be used?
Virtual Router is useful to allow clients or lower-privilege users access their own 'router' and adjust configure as they like without the need for a second hardware.
For example; a WISP can create a virtual router for the clients ethernet port allowing them to define their own firewall settings, while leaving the WISP's wireless settings untouched.
Another useful method is to run guest OS that supports functionality which is not available in RouterOS, for example, Intrusion detection (SNORT), Asterisk or Squid web proxy.
It can also be used as test environment. it is possible to create virtual network within one x86 machine very similar to real network and test how RouterOS behaves before implementing the setup in your production network.
Creating KVM Guest
Before creating KVM guest we need image file. RouterOS has built in commands to make and modify RouterOS image easily without external tools.
/kvm make-routeros-image file-name=ros1.img file-size=128
We can proceed with Guest configuration when disk image is created.
/kvm add name=ROS memory=128MiB cpu-count=2 disabled=no disk-images=hda:ros1.img \
initrd="" kernel="' kernel-cmdline="console=ttyS0"
As you noticed initrd and kernel properties are empty, which means that hosts kernel and initrd is used.
For example, to add guest without SMP support we can explicitly set initrd and kernel:
/kvm add name=ROS memory=128MiB cpu-count=2 disabled=no disk-images=hda:ros1.img \
initrd=/boot/initrd.rgz kernel=/boot/vmlinuz kernel-cmdline="console=ttyS0"
Note: Leaving initrd and kernel properties empty is dangerous if Host and Guest will be running different RouterOS versions . Guests other than RouterOS also can break if you leave these values empty.
KVM Guests when created are not automatically started. We must start it manually
[admin@proxy] /kvm> start ROS;
[admin@proxy] /kvm> print
Flags: X - disabled
0 name="ROS" cpu-count=2 memory=128MiB disk-images=hda:ros1.img kernel="/boot/vmlinuz"
kernel-cmdline="" initrd="/boot/initrd.rgz" vnc-server=0.0.0.0:0 snapshot=no state=running
[admin@proxy] /kvm>
Adding Interfaces
Lets add to our previously created Virtual Router one interface.
[admin@proxy] /kvm interface> add virtual-machine=ROS type=dynamic [admin@proxy] /kvm interface> print Flags: X - disabled, A - active # VIRTUAL-MACHINE INTERFACE TYPE VM-MAC-ADDRESS 0 ROS dynamic 02:D9:52:31:11:CC [admin@proxy] /kvm interface>
In this case dynamic type is used which creates dynamic virtual interface on the host:
[admin@proxy] /interface virtual-ethernet> print Flags: D - dynamic, X - disabled, R - running # NAME MTU ARP MAC-ADDRESS 0 D R tap1 1500 enabled 02:3F:9F:AE:10:34 [admin@proxy] /interface virtual-ethernet>
Note: Add and remove interfaces only when KVM guest is shut-down, stopped or disabled. Making changes to running guest may lead to host system crash.
If mac addresses are not specified when creating virtual interfaces, addresses are generated automatically. Generate MAC addresses will be in form of 02:XX:XX:XX:XX:XX. For static interfaces this address will not change during use of guest, for dynamic interface will change every time dynamic interface is created.
Connecting to the virtual machine
Configuring a virtual network
Reference
General
Interface
KVM Commands
KVM commands
Sub-menu: /kvm
Sub-menu allows to manage KVM guests on RouterOS host.
| Command | Desciption |
|---|---|
| add | Create new KVM guest entry |
| comment | Set comment for KVM guest entry |
| console | to connect to KVM guest console display |
| continue | resume KVM guest if it was paused |
| disable | change global state of KVM guest. If enabled KVM guest will be started when RouterOS boots. KVM guest cannot change |
| edit | edit selected value of KVM guest entry |
| enable | change KVM guest global state to enable operation of KVM guest. If guest where disabled before - KVM guest is automatically started. |
| export | Print or save an export script that can be used to restore configuration of current sub-menu, KVM guest configuration, image files will not be saved |
| find | Find items by value |
| get | Gets value of item's property |
| make-routeros-image | creates RouterOS image from current installation installed on the router with no configuration. It is advised to create Image file larger than minimal, so you are able to upload new package files and upgrade/update RouterOS installation. Also, all the additional files created in KVM guest will be stored in file image. This image file is not connected to host RouterOS and user is able to run different RouterOS versions on host and guest. This command will create RAW image file containing RouterOS installation.
parameters:
|
| pause | suspend operation of KVM guest |
| Print values of item properties | |
| reboot | issue ACPI shut-down command to KVM guest, if guest does not support ACPI, command have no effect. After KVM guest is shut-downed it will be automatically started by host when shut down is complete. |
| reconfigure-routeros-image | sets up default configuration for RouterOS image.
Parameters:
|
| remove | Remove item |
| set | Change item properties |
| shut-down | issue ACPI shut-down command to KVM guest, if guest does not support ACPI, command have no effect. |
| start | to start KVM guest |
Create KVM guest
Expansion of command: /kvm add
To add new KVM guest you will have to issue command add under /kvm menu with attributes as follows:
| Property | Desciption |
|---|---|
| comment (text, default: ') | to add simple text description of the KVM guest |
| cpu-count (1 .. 32, default: 1) | available count of processing cores for guest. Allowed values are [1..32] |
| disabled (yes | no, default: no) | to set guest state after creation, values: yes or no |
| disk-images ( list of images used in guest) | list of image assignment to drives for guest OS. If type will be set to cdrom then guest will automatically boot from that, instead of any other drive configured in this field. It can be single drive specified
disk-images=hda:ros.img or it can be comma seperated list: disk-images=hda:system.img,hdb:swap.img |
| initrd (path) | path to initrd file, can be left empty if running RouterOS as guest |
| kernel (path) | path to kernel image file, if using RouterOS image created on host this field can be left empty |
| kernel-cmdline (text) | parameters that are passed to kernel, it is space separated string. |
| memory (integer default:32) | to set up amount of memory that is available to KVM guest |
| name (text) | name of KVM guest that it will be accessible though the system |
| snapshot (yes | no) | will try to run virtual machine with image file in read-only mode. |
| vnc-server (IP address:number) | if it is allowed to connect to this virtual machine using vnc client. Field value is <listen IP address>:<display number> where listen IP address - is ip address where vnc can connect to, by default 0.0.0.0 - listening on all interfaces, display number - independent positive integer value, if this number is set to 0 vnc is connections are not enabled for virtual machine. any value other than 0 will enable vnc connections to this virtual machine. If enabled, then VNC connection port will be 5900 + <display number>. For example, if <display number> = 5 then connection port will be port #5905 if port is busy starting of guest will fail. |
| copy-from (number) | use configuration from already existing KVM guest |
KVM guest interfaces
Menu: /kvm interface
| Property | Desciption |
|---|---|
| comment (text) | description of interface |
| disabled (yes|no, default: no) | state of interface after creation |
| host-mac-address (MAC Address, default: generated) | MAC address of virtual interface that host will use |
| model (virto | e1000 | pcnet, default: virtio) | mode of virtual interface. Available options are:
|
| vm-mac-address (MAC Address, default: generated) | MAC address of virtual interface that guest will use |
| copy-from (number) | use configuration from existing virtual interface |
| dynamic-bridge (interface name, default: none) | if set, dynamic interface will be automatically added as port to bridge interface |
| interface | is set for static interface, to assign it to already created virtual-ethernet interface |
| type (dynamic | static, default: static) | to set if interface is either static or dynamic.
|
| virtual-machine (KVM machine name, must be set) | name of virtual machine this interface will be assigned to |
States of KVM guest
This field is read-only and is set by RouterOS. These are possible values that can be set:
- stopped - KVM guest is not running, either successful shut-down or disabled.
- stopping - KVM guest is shutting down
- starting - KVM guest is starting
- running - KVM guest has started successfully and is executing guest operating system
- restarting - KVM guest is reloading its guest operating system
- failed - KVM guest has encountered an error and is not operational.
- image-busy - image file set in configuration is already in use by other KVM guest entry
- no-kernel-or-initrd - initrd or kernel was not found in files set in configuration, mentioned files could not be found or no values in those fields where set
- no-disk-image - either disk image was not found or disk image was not set in configuration.
- kernel-extract-failed - when in guest configuration field kernel is left empty and and KVM cannot extract kernel from image file supplied