Puppet ipmi Module

Overview

Manages BMC using ipmitool with optional Foreman integration.

Description

Forked from jhoblitt-ipmi with much thanks to the original author.

• Installs the OpemIPMI package and service
• Provides IPMI LAN and user facts
• Adding/updating/disabling of IPMI users
• Purging users beyond those wanted
• Setting of IPMI LAN network settings
• LAN facts automatically will add/update BMC NIC interface in Foreman
• User credentials from Foreman BMC interface can be applied to an IPMI user

Usage

Examples

include ipmi

Manage IPMI users:

class { ipmi:
    purge_users => true,
    foreman_user => true,
    users => [
        {
            username => 'ADMIN',
            password => 'secret',            
        }, 
    ],    
}

Reference

Table of Contents

Classes

• ipmi: == Class: ipmi Please refer to https://github.com/jhoblitt/puppet-ipmi#usage for parameter documentation.
• ipmi::params: == Class: ipmi::params This class should be considered private.

Defined types

• ipmi::network: == Defined resource type: ipmi::network
• ipmi::snmp: == Defined resource type: ipmi::snmp
• ipmi::user: == Defined resource type: ipmi::user

Classes

ipmi

== Class: ipmi

Please refer to https://github.com/jhoblitt/puppet-ipmi#usage for parameter documentation.

Parameters

The following parameters are available in the ipmi class.

ensure

Data type: Enum[present, absent]

Default value: present

ipmievd_service_ensure

Data type: Enum[running, stopped]

Default value: stopped

watchdog

Data type: Boolean

Default value: false

users

Data type: Array[Hash]

Default value: []

purge_users

Data type: Boolean

Default value: false

foreman_user

Data type: Variant[Boolean, Enum[optional]]

Default value: false

foreman_user_privilege

Data type: Integer[1, 4]

Default value: 4

network

Data type: Optional[Hash]

Default value: undef

snmp

Data type: Optional[String]

Default value: undef

ipmi::params

== Class: ipmi::params

This class should be considered private.

Defined types

ipmi::network

== Defined resource type: ipmi::network

Parameters

The following parameters are available in the ipmi::network defined type.

ip

Data type: Stdlib::IP::Address::V4::Nosubnet

Default value: '0.0.0.0'

netmask

Data type: Stdlib::IP::Address::V4::Nosubnet

Default value: '255.255.255.0'

gateway

Data type: Stdlib::IP::Address::V4::Nosubnet

Default value: '0.0.0.0'

type

Data type: Enum[dhcp, static]

Default value: dhcp

channel

Data type: Integer[1]

Default value: 1

ipmi::snmp

== Defined resource type: ipmi::snmp

Parameters

The following parameters are available in the ipmi::snmp defined type.

snmp

Data type: String

Default value: 'public'

channel

Data type: Integer[1]

Default value: 1

ipmi::user

== Defined resource type: ipmi::user

Parameters

The following parameters are available in the ipmi::user defined type.

id

Data type: Integer[1]

ensure

Data type: Enum[present, enabled, absent, disabled]

Default value: present

username

Data type: String

Default value: $title

password

Data type: Optional[String]

Default value: undef

privilege

Data type: Integer[1, 4]

Default value: 4

channel

Data type: Integer[1]

Default value: 1

Changelog

All notable changes after forking will be documented in this file.

Release 4.5.0

Features

• Full typing for users and network on ipmi

Release 4.4.0

Features

• Allow stdlib up to version < 9.0.0

Release 4.3.0

Features

• Allow Puppet 7

Release 4.1.0

Features

• Use ensure_packages to avoid package conflicts

Release 4.0.0

Features

• Simplify sub-resources passed to ipmi class
• users passed to ipmi can have their id allocated:
  • to an existing id if username's match
  • otherwise, a new, unused id

Release 3.0.0

Features

• Apply user specified in Foreman BMC interface
• Purge (disable) unspecified users
• ensure => disabled to disable users
• ensure => absent to remove packages

Internal

• Converted to PDK
• Allow stdlib up to version < 7.0.0

Limitations

• Simplifying by restricting to channel 1 only