Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

network

Manage non-volatile network configuration
Project URLRSS FeedReport issues

456,730 downloads

300 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

  • 2.2.1 (latest)
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.1.0
  • 1.0.2-rc0 (pre-release)
  • 1.0.1
  • 1.0.0
  • 0.10.1
  • 0.10.0
  • 0.9.0
  • 0.8.0
  • 0.7.0
  • 0.6.1
  • 0.6.0
  • 0.5.0
released Oct 21st 2024
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 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
  • Puppet >= 7.0.0 < 9.0.0
  • , , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppet-network', '2.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppet-network
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppet-network --version 2.2.1

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.

Download
Tags: network, voxpupuli

Documentation

puppet/network — version 2.2.1 Oct 21st 2024

Network module for Puppet

Build Status Release Puppet Forge Puppet Forge - downloads Puppet Forge - endorsement Puppet Forge - scores puppetmodule.info docs Apache-2 License

Overview

Manage non-volatile network and route configuration.

Usage

Interface configuration

network_config { 'eth0':
  ensure  => 'present',
  family  => 'inet',
  method  => 'dhcp',
  onboot  => 'true',
  hotplug => 'true',
  options => {'pre-up' => 'sleep 2'},
}

network_config { 'lo':
  ensure => 'present',
  family => 'inet',
  method => 'loopback',
  onboot => 'true',
}

network_config { 'eth1':
  ensure    => 'present',
  family    => 'inet',
  ipaddress => '169.254.0.1',
  method    => 'static',
  netmask   => '255.255.0.0',
  onboot    => 'true',
}

Route configuration

Route resources should be named in CIDR notation. If not, they will not be properly mapped to existing routes and puppet will apply them on every run. Default routes should be named 'default'.

For Debian:

# default route
network_route { 'default':
  ensure    => 'present',
  network   => 'default',
  netmask   => '0.0.0.0',
  gateway   => '172.18.6.2',
  interface => 'enp3s0f0',
}

# specific route
network_route { '172.17.67.0/24':
  ensure    => 'present',
  gateway   => '172.18.6.2',
  interface => 'vlan200',
  netmask   => '255.255.255.0',
  options   => 'table 200',
}

For RedHat Enterprise:

network_route { '172.17.67.0/24':
  ensure    => 'present',
  gateway   => '10.0.2.2',
  interface => 'eth0',
  netmask   => '255.255.255.0',
  network   => '172.17.67.0',
  options   => 'table 200',
}
network_route { 'default':
  ensure    => 'present',
  gateway   => '10.0.2.2',
  interface => 'eth0',
  netmask   => '0.0.0.0',
  network   => 'default'
}
network_route { '10.0.0.2':
  ensure    => 'present',
  network   => 'local',
  interface => 'eth0',
  options   => 'proto 66 scope host table local',
}

For SLES:

network_route { 'default':
  ensure    => 'present',
  gateway   => '10.0.2.2',
  interface => 'eth0',
  netmask   => '0.0.0.0',
  network   => 'default'
}

Create resources on the fly with the puppet resource command:

root@debian-6:~# puppet resource network_config eth1 ensure=present family=inet method=static ipaddress=169.254.0.1 netmask=255.255.0.0
notice: /Network_config[eth1]/ensure: created
network_config { 'eth1':
  ensure    => 'present',
  family    => 'inet',
  ipaddress => '169.254.0.1',
  method    => 'static',
  netmask   => '255.255.0.0',
  onboot    => 'true',
}

# puppet resource network_route 23.23.42.0 ensure=present netmask=255.255.255.0 interface=eth0 gateway=192.168.1.1
notice: /Network_route[23.23.42.0]/ensure: created
network_route { '23.23.42.0':
  ensure    => 'present',
  gateway   => '192.168.1.1',
  interface => 'eth0',
  netmask   => '255.255.255.0',
  options   => 'table 200',
}

Dependencies

This module requires the FileMapper mixin, available at https://github.com/voxpupuli/puppet-filemapper. The network_config type requires the Boolean mixin, available at https://github.com/adrienthebo/puppet-boolean.

The debian routes provider requires the package ifupdown-extra. ifupdown-extra can be installed automatically using the network class. To use it, include it like so in your manifests:

include 'network'

This class also provides fine-grained control over which packages to install and how to install them. The documentation for the parameters exposed can be found here.

Bonding on Debian requires the package ifenslave, which is installed automatically when a bond is defined. This package was renamed in Debian 9, and therefore bonding does not work on Debian versions prior to 9.

Note: you may also need to update your master's plugins (run on your puppet master):

puppet agent -t --noop

Or on puppet 3.8.7/4.x:

puppet plugin download

Contact