Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated for v2.0.2 vagrant which is the current recommendation.


You must install Vagrant after you install libvirt. Vagrant might not properly detect the necessary files if it is installed before libvirt. Cumulus VX requires version 1.7 or later. Version 12.90.1 2 or later is recommended. 

  1. Install Vagrant from the deb package. Cumulus Networks cannot guarantee the functionality of any version of Vagrant. In this guide, Vagrant version 12.90.3 2 is used.

    Code Block
    user@ubuntubox:~$ wget
    --20172018-0605-2304 2009:0136:4322--
    Resolving ( 151.101.12957.183,,, ...
    Connecting to (|151.101.12957.183|:443... connected.
    HTTP request sent, awaiting response... 200 OK
    Length: 8766654443678320 (84M42M) [application/x-debian-package]
    Saving to: ‘vagrant_12.90.32_x86_64.deb’
    vagrant_12.90.32_x86_64.deb                                            6 100%[===================================================================================================================================================================>]  8341.60M65M  133.31MB1MB/s    in 78s1.3s    
    20172018-0605-2304 2009:0336:0223 (33.1.07 MB/s) - ‘vagrant_12.90.32_x86_64.deb’ saved [8766654443678320/8766654443678320]
  2. Install Vagrant using dpkg:

    Code Block
    user@ubuntubox:~$ sudo dpkg -i vagrant_12.90.32_x86_64.deb 
    Selecting previously unselected package vagrant.
    (Reading database ... 99162387062 files and directories currently installed.)
    Preparing to unpack vagrant_12.90.32_x86_64.deb ...
    Unpacking vagrant (1:12.90.32) ...
    Setting up vagrant (1:12.90.32) ...
  3. Verify the Vagrant version:

    Code Block
    user@ubuntubox:~$ vagrant --version
    Vagrant 12.90.32
  4. Install the necessary plugins for Vagrant:

    Code Block
    user@ubuntubox# vagrant plugin install vagrant-mutatelibvirt
    Installing the 'vagrant-mutatelibvirt' plugin. This can take a few minutes...
    Installed the plugin 'vagrant-mutatelibvirt (10.20.043)'!
    user@ubuntubox# vagrant plugin install vagrant-libvirtmutate
    Installing the 'vagrant-libvirtmutate' plugin. This can take a few minutes...
    Installed the plugin 'vagrant-libvirtmutate ('!

    Vagrant plugin installation is unique to each user; make sure to install plugins as the user who will run the simulations.

  5. Install the CumulusCommunity/cumulus-vx box image:

    Code Block
    vagrant box add CumulusCommunity/cumulus-vx --provider=libvirt

    Vagrant box image installation is unique to each user; make sure to install images as the user who will run the simulations.

  6. Test that everything is working:

    Code Block
    user@ubuntubox:~$ mkdir ./testdir ; cd ./testdir
    user@ubuntubox:~/testdir$ vagrant init CumulusCommunity/cumulus-vx
    A `Vagrantfile` has been placed in this directory. You are now ready to `vagrant up` your first virtual environment! Please readthe comments in the Vagrantfile as well as documentation on`` for more information on using Vagrant.
    user@ubuntubox:~/testdir$ vagrant up --provider=libvirt
    user@ubuntubox:~/testdir$ vagrant status
    (eric@xenial1)-(12:07 PM Tue Jun 07)->-(1 files, 16Kb)--> vagrant status
    Current machine states:
            default running (libvirt)
  7. To show all running KVM/libvirt VMs:

    Code Block
    user@ubuntubox:~/testdir$ virsh list --all 
    Id    Name                           State 
    2     test_default                   running 
    #Look at libvirt's XML definition of the VM used to create the VM:
    user@ubuntubox:~/testdir$ virsh dumpxml [name of domain]
  8. The libvirt domain is running. To stop this machine, you can run vagrant halt. To destroy the machine, you can run vagrant destroy.

    Code Block
    user@ubuntubox:~/testdir$ vagrant destroy -f