This documentation is for an older version of the software. If you are using the current version of Cumulus Linux, this content may not be up to date. The current version of the documentation is available here. If you are redirected to the main page of the user guide, then this page may have been renamed; please search for it there.

Cumulus VX Getting Started Guide

Cumulus VX is a free virtual environment for cloud and network administrators to test the latest technology from Cumulus Networks, removing all organizational and economic barriers to getting started with open networking in your own time, at your own pace, and within your own environment.

The environment can be used to learn about, and evaluate, Cumulus Linux, anytime and anywhere, producing sandbox environments for prototype assessment, pre-production rollouts, and script development.

What’s New

Major enhancements have been made for Cumulus VX 3.0 with the goal of producing a true learning, testing, and pre-production tool. These enhancements include:

  • Cumulus VX now includes ONIE with onie-nos-install support to show the installation steps.
  • The VX image comes with a GRUB Menu containing ONIE and Cumulus Linux. To simulate the install process on real hardware, Cumulus Linux binaries can be installed from ONIE.
  • Cumulus VX is being treated as a “platform”; most monitoring tools that would be run on hardware can now be run on VX (for example, sensors, decode-syseeprom, smonctl and platform-detect).
  • Cumulus VX now runs the same packages as Cumulus Linux, excluding those that are specific to the networking ASIC. This is as close as things can be to software parity with Cumulus Linux.

The goal for Cumulus VX is to create an environment that feels and behaves like a real switch. For that reason, tools like platform-detect, decode-syseeprom, smonctl, sensors, pwmd, and ledmgrd will report real world data. In addition, Cumulus VX will now be built alongside Cumulus Linux, rather than with a staggered delay, to allow for testing ahead of a production upgrade.

Supported Platforms

About the Virtual Machine

Cumulus VX runs in a virtual machine (VM) on a standard x86 environment. The VM is a 64-bit operating system, built on the same foundation as Cumulus Linux, running the Linux 3.2.65-1+deb7u2+cl2.5+2 kernel, using virtio drivers for network and HDD interfaces as well as the logical volume manager (LVM).

Four versions of the virtual disk image are available for use across various hypervisors:

  • An OVA disk image for use with VirtualBox.
  • A VMware-specific OVA disk image.
  • A qcow2 disk image for use with KVM.
  • A Box image for use with Vagrant.

Comparisons with Other Cumulus Networks Products

Cumulus VX is a virtual appliance that simulates a Cumulus Linux or Cumulus RMP environment. To see how these systems compare, read this article.

Community Support

Cumulus VX is a community-supported product. Join the Cumulus Networks community and ask for or offer help.

Downloading the Cumulus VX Image

To get started, you need to download some software as well as the Cumulus VX disk image (qcow2 or OVA) that runs with the hypervisor you plan to use with Cumulus VX. Each disk image contains a single VM for a standalone switch. You can clone this virtual machine to build out your test network. For more information, read the appropriate steps below:

Logging in to the VM

The Cumulus VX VM has these default login credentials:

  • User name: cumulus
  • Password: CumulusLinux!

The cumulus user has sudo privileges, just like a Cumulus Linux switch.

For more information about Cumulus VX, Cumulus Linux and supported environments, visit these links: