Forge Home


A Puppet module that installs and configures Netplan.


117 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.3 (latest)
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Nov 22nd 2023
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.21.0 < 8.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'itmage-netplan', '0.1.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add itmage-netplan
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install itmage-netplan --version 0.1.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.



itmage/netplan — version 0.1.3 Nov 22nd 2023


Table of Contents

  1. Description
  2. Setup - The basics of getting started with netplan
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module


The module is under development.

A Puppet module that installs and configures Netplan.


Setup Requirements

The following dependencies are required to use the module:

  • concat >= '7.4.0'

Beginning with netplan

To start using the module, you need to add it to the manifest. Then, create resources with a description of the interfaces and routes. For example:

include netplan
netplan::interface { 'ens3': addresses => [''] }
netplan::route { 'Added new route for Office net': dev => 'ens3', to => '', via => '' }


The module can create interfaces for bonds and for VLANs. Here are examples of different configurations.

If you need to reset all the addresses from the interface before applying the new configuration

netplan::interface { 'ens3':
  flush     => true,
  addresses => ['']

Any additional parameters can be added through the $opts key

netplan::interface { 'ens3':
  opts      => {'mtu' => 1500},
  addresses => ['']

Example of Bond interface configuration

netplan::interface { 'bond0':
  type      => 'bonds',
  opts      => {
    'interfaces' => ['ens3', 'ens4'],
    'parameters' => {
      'mode'      => '802.3ad',
      'lacp-rate' => 'fast'
  addresses => ['']

Similarly, you can build a VLAN interface

netplan::interface { 'vlan20':
  type      => 'vlan',
  opts      => {
    'link' => 'bond0',
    'id'   => 20
  addresses => ['']


  • There are no tests to check the module works


  • I need help adding snippets for working with different tunnels, such as Wireguard. TODO: Initialize basic wireguard support