Forge Home


Module for managing Cumulus Linux ports.conf


1,648 latest version

4.0 quality score

Version information

  • 1.0.3 (latest)
released Apr 7th 2020
This version is compatible with:
  • CumulusLinux

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'c2devel-cumulus_ports', '1.0.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add c2devel-cumulus_ports
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install c2devel-cumulus_ports --version 1.0.3

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.



c2devel/cumulus_ports — version 1.0.3 Apr 7th 2020

This is a fork of Cumulus Network repo (

Actual puppet forge page:

Feel free to send patches to

cumulus_ports for Puppet

Table of Contents


This Puppet module provides a simple interface for managing initial port configuration on Cumulus Linux.

Module Description

The cumulus_ports module is responsible for setting the initial speed of a 10G or 40G port. On some bare metal switches, it is possible to take a 40G port and split it up into four 10G ports using a breakout cable. For more details, read the Cumulus Linux User Guide and search for "Switch Port Attributes".


What cumulus_ports affects

  • This module affects the /etc/cumulus/ports.conf file.
  • To activate the changes in the file, the switchd daemon must be restarted.

NOTE: Restarting the switchd daemon is disruptive.

Beginning with cumulus_ports

This module does not use any default parameters. Support for default parameters is on the roadmap.


The module currently supports one define, cumulus_ports::speeds:

node default {
  cumulus_ports { 'speeds':
    speed_40g_div_4 => ["swp1-4"],
    speed_10g => ["swp5-48"],
    speed_4_by_10g => ["swp49-50"],
    speed_40g => ["swp51-52"]




Generates a custom /etc/cumulus/ports.conf based on the following variables:

  • speed_10g: speed_10g => 'swp1-2' produces the following text in /etc/cumulus/ports.conf:

  • speed_40g : speed_40g => 'swp1-2' produces the following text in /etc/cumulus/ports.conf:

  • speed_40g_div_4: speed_40g_div_4 => ['swp1', 'swp4'] produces the following text in /etc/cumulus/ports.conf:

  • speed_4_by_10g: speed_4_by_10g => 'swp1-2' produces the following text in /etc/cumulus/ports.conf:



This module only works on Cumulus Linux.

The module does not currently do any error checking. Ensure that the whole configuration is thoroughly tested, or the switch can behave in unpredictable ways.

puppet resource cumulus_ports doesn't currently work. This will be implemented in a later version.


  1. Fork it.
  2. Create your feature branch (git checkout -b my-new-feature).
  3. Commit your changes (git commit -am 'Add some feature').
  4. Push to the branch (git push origin my-new-feature).
  5. Create new Pull Request.

Cumulus Linux

Cumulus icon

Cumulus Linux is a software distribution that runs on top of industry-standard networking hardware. It enables the latest Linux applications and automation tools on networking gear while delivering new levels of innovation and flexibility to the data center.

For further details please see