kmod

approved
pdk
deprecated
Manage Linux kernel modules with Puppet

Camptocamp

camptocamp

3,286,368 downloads

105,047 latest version

5.0 quality score

Version information

  • 2.5.0 (latest)
  • 2.4.0
  • 2.3.1
  • 2.3.0
  • 2.2.0
  • 2.1.0
  • 2.0.11
  • 2.0.10
  • 2.0.9
  • 2.0.8
  • 2.0.7
  • 2.0.6
  • 2.0.5
  • 2.0.4
  • 2.0.3
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.0.6
  • 1.0.5
  • 1.0.4
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
  • 0.0.1
released Mar 9th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 7.0.0
  • Debian
    ,
    Ubuntu
    ,
    SLES
    ,
    RedHat
    ,
    CentOS
    ,
    OracleLinux
    , Archlinux
This module has been deprecated by its author since Jun 14th 2021.

The reason given was: Donated to Vox Pupuli

The author has suggested puppet-kmod as its replacement.

Start using this module

Documentation

camptocamp/kmod — version 2.5.0 Mar 9th 2020

Kmod Puppet module

Puppet Forge Version Puppet Forge Downloads Build Status Puppet Forge Endorsement By Camptocamp

Description

This module provides definitions to manipulate modprobe.conf (5) stanzas:

  • kmod::alias
  • kmod::install
  • kmod::blacklist

It depends on Augeas with the modprobe lens.

Usage

This module has five main defined types:

  • kmod::load
  • kmod::alias
  • kmod::option
  • kmod::install
  • kmod::blacklist

kmod::load

Loads a module using modprobe and manages persistent modules in /etc/sysconfig/modules

  kmod::load { 'mymodule': }

kmod::alias

Adds an alias to modprobe.conf, by default /etc/modprobe.d/<name>.conf is assumed for a filename.

  kmod::alias { 'bond0':
    aliasname => 'bonding',
  }

Params:

  • modulename: Name of the module to alias
  • aliasname: Name of the alias (defaults to the resource title)
  • file: File to write to (see above default)

kmod::option

Adds an option to modprobe.conf

  kmod::option { 'bond0 mode':
    module  => 'bond0',
    option  => 'mode',
    value   => '1',
  }

  kmod::option { 'bond0':
    option => 'mode',
    value  => '1',
  }

Params:

  • option: Name of the parameter to add
  • value: Value of the parameter
  • module: Name of the module (if ommited, the resource title is used)
  • file: File to write to (defaults to /etc/modprobe.d/<module name>.conf)

kmod::blacklist

Manages modprobe blacklist entries. Blacklist entries prevents module aliases from being used, but would not prevent the module from being loaded. To prevent a module from being loaded use kmod::install

  kmod::blacklist { 'foo': }

Params:

  • file: File to write to, defaults to /etc/modprobe.d/blacklist.conf

kmod::install

Manage modprobe install entries

   kmod::install { 'pcspkr': }

If you want to ensure that module can't be loaded at all you can do the following:

   kmod::install { 'dccp': command => '/bin/false' }

Params:

  • file: File to write to (defaults to /etc/modprobe.d/<module name>.conf)
  • command: (optional) command associated with the install, defaults to /bin/true

Using the module with hiera

The module makes available lists for every defined type that will create those defined types if defined as class parameters. The parameters are:

  • kmod::list_of_blacklists:
  • kmod::list_of_aliases:
  • kmod::list_of_installs:
  • kmod::list_of_loads:
  • kmod::list_of_options:

Example usage:

---
kmod::list_of_blacklists:
  'foo01': {}
  'foo02': {}
  'foo03': {}
kmod::list_of_aliases:
  'foo01':
    source: 'squashfs'
    aliasname: 'squash01'
  'foo02':
    source: 'squashfs'
    aliasname: 'squash02'
kmod::list_of_installs:
  'dccp':
    command: '/bin/false'
  'blah':
    command: '/bin/true'
kmod::list_of_loads:
  'cramfs': {}
  'vfat': {}
kmod::list_of_options:
  'bond0 mode':
    module: 'bond0'
    option: 'mode'
    value: '1'
  'bond0':
    option: 'mode'
    value: '1'

Contributing

Please report bugs and feature request using GitHub issue tracker.

For pull requests, it is very much appreciated to check your Puppet manifest with puppet-lint to follow the recommended Puppet style guidelines from the Puppet Labs style guide.