Forge Home


Manage ethernet interfaces with ethtool


9,923 latest version

3.8 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.0.6 (latest)
  • 0.0.5
  • 0.0.3
  • 0.0.2
  • 0.0.1
released Sep 16th 2014

Start using this module

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

Add this module to your Puppetfile:

mod 'bobtfish-ethtool', '0.0.6'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bobtfish-ethtool
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bobtfish-ethtool --version 0.0.6

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.



bobtfish/ethtool — version 0.0.6 Sep 16th 2014

####Table of Contents

  1. Overview
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with ethtool
    • [What ethtool affects](#what-<%= %>-affects)
    • Setup requirements
    • [Beginning with ethtool](#beginning-with-<%= %>)
  4. Usage - Configuration options and additional functionality
  5. Limitations - OS compatibility, etc.
  6. Development - Guide for contributing to the module


This module enables you to set settings on your ethernet interfaces using the ethtool command.


You must turn pluginsync on to use this module as it is implemented as a custom type and provider

###What ethtool affects

  • This module will only call the ethtool utility, so will only affect settings on already configured network interfaces. It will not adjust the settings which interfaces are brought up with.

  • This can be DANGEROUS you can use this module to break the networking on your servers.

###Beginning with ethtool

ethtool { 'eth0': .. put options here .. }

Type Usage

Example usage with the most commonly used options:

ethtool { 'eth0': speed => '100', duplex => 'full', tso => 'disabled', autonegotiate_tx => 'disabled', autonegotiate_rx => 'disabled', }

Class Usage

You can use the puppet class to (optionally) install ethtool for your, and enforce ordering so that the ethtool type is only used after the ethtool package is available:

include ethtool

For when you don't want it to install ethtool for you:

class { 'ethtool': ensure_installed => false }

All supported properties

Note that not all interfaces support the querying or setting of all of these properties! Which settings and properties are available will depend on your ethernet card and driver!


The speed of the interface: auto/10/100/1000. Note that not all speeds are supported on every interface


If duplex transmission should be enabled on the interface. Possible values are full half or auto.


If TCP segment offload is enabled or disabled for this interface


Specifies whether large receive offload should be enabled or disabled


Specifies whether UDP fragmentation offload should be enabled or disabled


Specifies whether generic segmentation offload should be enabled


Specifies whether generic receive offload should be enabled


Specifies whether scatter_gather should be enabled


Specifies whether RX checksumming should be enabled


Specifies whether TX checksumming should be enabled


If autonegotiation (PAUSE frames) are enabled or disabled


If autonegotiation is enabled or disabled for transmitting


If autonegotiation is enabled or disabled for receiving


This defaults to true. If your ethernet card doesn't appear to support a setting then we don't try to set it, which means that you can set the settings you want generally, but they'll be ignored on NICs which don't support those settings.

If you'd like puppet to try to set settings which can't be read anyway (and throw an error if this fails), then you can set this parameter to true.


Only works on Linux.

Currently only manages a subset of the whole ethtool functionality.

Doesn't support puppet resource querying of resource state.

Doesn't cache properties or use the flush interface, so makes one call to ethtool per property..


This module works for what it does, but will not fulfil everyone's needs.

Please feel free to patch and send pull requests