Cumulus on a Stick

Get your switch up and running in minutes

Switch

Simplifying installation of Cumulus Linux binaries and licenses

Although many large data center operators choose to install and configure Cumulus Linux using automation, there are several use cases where you need a simpler solution. Cumulus on a Stick packages Cumulus Linux images with your license, allowing you to use a USB thumb drive to bring your new switches to life.

Leveraging industry-standard Open Network Install Environment (ONIE) and Cumulus Linux zero touch provisioning, Cumulus on a Stick provides a "plug it in and turn it on" experience to imaging bare metal switches. Download your personalized ZIP file, transfer it to a USB thumb drive, insert the drive into your newly arrived switch, apply power, and you are ready to go. As your interest and experience in open networking increases, the contents of your Cumulus on a Stick thumb drive will give you insight into how to scale out your experience.

Note: Cumulus on a Stick does not work with the following platforms:
Dell SN4810-ON, Edge-Core AS5600-52X, Edge-Core AS6701-32X, HPE Altoline 6700-32QSFP+, Penguin Arctica 4804X, QCT QuantaMesh BMS T1048-LB9, QCT QuantaMesh BMS T3048-LY2. See the hardware compatibility list for more information.

For detailed setup instructions, select your OS below:

Insert USB thumb drive

Insert your USB thumb drive into your computer and check the format.

Windows 10

Make sure the drive is formatted for “FAT32”

If the USB stick is formatted for FAT32, you're good to go and can skip ahead to Step 2 – Copy files; otherwise, you'll need to format the USB drive as described below.

Windows 10

Erase and format

To format the USB thumb drive, in File Explorer, right click on the USB thumb drive icon and select Format.

Windows 10

In the Format USB Drive dialog, in the File system list, select the “FAT32 (Default)” option. In the Volume label field, name the USB thumb drive.

Windows 10

Click Start then click OK to accept the warning about erasing all the data on the USB thumb drive. Once the formatting finishes, you are ready to copy the Cumulus on a Stick files onto it.

Windows 10

Copy files

Go to your Downloads folder, or wherever you downloaded the Cumulus on a Stick files, and expand the Cumulus on a Stick ZIP file by right clicking it and selecting Extract All.

Windows 10

Select the directory where you want to extract the files, then click Extract. In this example, they’ve been extracted into the Downloads folder.

Windows 10

Select the contents of the expanded ZIP file and drag them to your USB thumb drive.

Windows 10

Check files

Once the copying is complete, check that your USB thumb drive has the expected files.

Windows 10

Eject the USB drive

Right click the USB thumb drive and select Eject.

Windows 10

You're ready to begin imaging the switch.

Connect your switch to a console

Connect your console cable to the switch (follow these instructions if you need to install a console).

Plug USB drive into switch USB port

Place the USB thumb drive into the USB port, then power on the switch (or reboot the switch with sudo reboot if it was already powered on). ONIE starts its discovery process and locates the USB thumb drive.

Windows 10

In about a minute, you should see the status and progress bar for the Cumulus Linux installer.

Windows 10

When the Cumulus Linux installer completes, you’ll see a login prompt for Cumulus Linux.

Enter the default username cumulus and the default password CumulusLinux!.

Windows 10

Insert USB thumb drive

Insert your USB thumb drive into your computer and check the format.

OSX

Make sure the drive is formatted for “MS-DOS (FAT32)”

If the USB stick is formatted for MS-DOS (FAT32), you're good to go and can skip ahead to Step 2 – Copy files; otherwise, you'll need to format the USB drive as described below.

OSX

Erase and format

To format the USB thumb drive, open the Disk Utility app. In Disk Utility, right click the USB thumb drive icon and select Erase.

OSX

In the dialog, in the Name field, name the USB thumb drive. In the Format list, select the “MS-DOS (FAT)” option.

OSX

Click Erase. Once the formatting finishes, you are ready to copy the Cumulus on a Stick files onto it.

Copy files

Go to your Downloads folder, or wherever you downloaded the Cumulus on a Stick files, and select the contents of the expanded ZIP file and drag them to your USB thumb drive.

OSX

Check files

Once the copying is complete, check that your USB thumb drive has the expected files.

OSX

Eject USB

Click the eject icon next to the USB thumb drive.

You're ready to begin imaging the switch.

Connect your switch to a console

Connect your console cable to the switch (follow these instructions if you need to install a console).

Plug USB drive into switch USB port

Place the USB thumb drive into the USB port, then power on the switch (or reboot the switch with sudo reboot if it was already powered on). ONIE starts its discovery process and locates the USB thumb drive.

OSX

In about a minute, you should see the status and progress bar for the Cumulus Linux installer.

OSX

When the Cumulus Linux installer completes, you’ll see a login prompt for Cumulus Linux.

Enter the default username cumulus and the default password CumulusLinux!.

OSX

Insert USB thumb drive

Insert your USB thumb drive into your computer and check the format.

Linux

Make sure the drive is formatted for “FAT32”

If the USB stick is formatted for FAT32, you're good to go and can skip ahead to Step 2 – Copy files; otherwise, you'll need to format the USB drive as described below.

Linux

Erase and format

To format the USB thumb drive, first unmount the USB thumb drive:

$ sudo umount /dev/sdb1

Then format the USB thumb drive with "vfat" and name it "Cumulus":

$ sudo mkfs.vfat -n Cumulus /dev/sdb1

Once the formatting finishes, mount the drive again:

sudo mount /dev/sdb1 /media/jrrivers

Now you are ready to copy the Cumulus on a Stick files onto the thumb drive.

Linux

Copy files

Go to your Downloads folder, or wherever you downloaded the Cumulus on a Stick files:

$ cd ~/Downloads/

Unzip the Cumulus on a Stick ZIP file to the USB drive:

$ sudo unzip cumulus-on-a-stick.zip -d /media/jrrivers

Linux

Check files

Once the copying is complete, check that your USB thumb drive has the expected files:

$ ls /media/jrrivers

Eject the USB drive

$ sudo sync

$ sudo umount /dev/sdb1

$ sudo eject /dev/sdb1

Linux

Connect your switch to a console

Connect your console cable to the switch (follow these instructions if you need to install a console).

Plug USB drive into switch USB port

Place the USB thumb drive into the USB port, then power on the switch (or reboot the switch with sudo reboot if it was already powered on). ONIE starts its discovery process and locates the USB thumb drive.

Linux

In about a minute, you should see the status and progress bar for the Cumulus Linux installer.

Linux

When the Cumulus Linux installer completes, you’ll see a login prompt for Cumulus Linux.

Enter the default username cumulus and the default password CumulusLinux!.

Linux

Insert USB thumb drive

Insert your USB thumb drive into your computer and check the format.

Ubuntu

Make sure the drive is formatted for "msdos”

If the USB stick is formatted for msdos, you're good to go and can skip ahead to Step 2 – Copy files; otherwise, you'll need to format the USB drive as described below.

Ubuntu

Erase and format

To format the USB thumb drive, right click on the USB thumb drive icon and select Format.

Ubuntu

In the Format Volume dialog, in the Type list, select the “Compatible with all systems and devices (FAT)” option. In the Name field, name the USB thumb drive.

Ubuntu

Click Format then click Format again to accept the warning about losing all the data on the USB thumb drive. Once the formatting finishes, you are ready to copy the Cumulus on a Stick files onto it.

Ubuntu

Copy files

Go to your Downloads folder, or wherever you downloaded the Cumulus on a Stick files, and expand the Cumulus on a Stick ZIP file by right clicking on it and selecting Extract Here.

Ubuntu

Select the contents of the expanded ZIP file and drag them to your USB thumb drive.

Ubuntu

Check files

Once the copying is complete, check that your USB thumb drive has the expected files.

Ubuntu

Eject the USB drive

Click the eject icon next to the USB thumb drive.

You're ready to begin imaging the switch.

Connect your switch to a console

Connect your console cable to the switch (follow these instructions if you need to install a console).

Plug USB drive into switch USB port

Place the USB thumb drive into the USB port, then power on the switch (or reboot the switch with sudo reboot if it was already powered on). ONIE starts its discovery process and locates the USB thumb drive.

Ubuntu

In about a minute, you should see the status and progress bar for the Cumulus Linux installer.

Ubuntu

When the Cumulus Linux installer completes, you’ll see a login prompt for Cumulus Linux.

Enter the default username cumulus and the default password CumulusLinux!.

Ubuntu