REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• ipmi: Manages OpenIPMI

Private Classes

• ipmi::config
• ipmi::install
• ipmi::service::ipmi
• ipmi::service::ipmievd

Defined types

• ipmi::network: Manage BMC network configuration
• ipmi::snmp: Manage SNMP community strings
• ipmi::user: Manage BMC users

Classes

ipmi

Manages OpenIPMI

Parameters

The following parameters are available in the ipmi class:

• packages
• config_file
• service_name
• service_ensure
• ipmievd_service_name
• ipmievd_service_ensure
• watchdog
• snmps
• users
• networks
• default_channel

packages

Data type: Array[String]

List of packages to install.

config_file

Data type: Stdlib::Absolutepath

Absolute path to the ipmi service config file.

service_name

Data type: String

Name of IPMI service.

service_ensure

Data type: Stdlib::Ensure::Service

Controls the state of the ipmi service. Possible values: running, stopped

ipmievd_service_name

Data type: String

Name of ipmievd service.

ipmievd_service_ensure

Data type: Stdlib::Ensure::Service

Controls the state of the ipmievd service. Possible values: running, stopped

watchdog

Data type: Boolean

Controls whether the IPMI watchdog is enabled.

snmps

Data type: Optional[Hash]

ipmi::snmp resources to create.

users

Data type: Optional[Hash]

ipmi::user resources to create.

networks

Data type: Optional[Hash]

ipmi::network resources to create.

default_channel

Data type: Integer[0]

Default channel to use for IPMI commands.

Default value: Integer(fact('ipmi.default.channel') or 1)

Defined types

ipmi::network

Manage BMC network configuration

Parameters

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

• ip
• netmask
• gateway
• type
• lan_channel

ip

Data type: Stdlib::IP::Address

Controls the IP of the IPMI network.

Default value: '0.0.0.0'

netmask

Data type: Stdlib::IP::Address

Controls the subnet mask of the IPMI network.

Default value: '255.255.255.0'

gateway

Data type: Stdlib::IP::Address

Controls the gateway of the IPMI network.

Default value: '0.0.0.0'

type

Data type: Enum['dhcp', 'static']

Controls the if IP will be from DHCP or Static.

Default value: 'dhcp'

lan_channel

Data type: Optional[Integer]

Controls the lan channel of the IPMI network to be configured. Defaults to the first detected lan channel, starting at 1 ending at 11

Default value: undef

ipmi::snmp

Manage SNMP community strings

Parameters

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

• snmp
• lan_channel

snmp

Data type: String

Controls the snmp string of the IPMI network interface.

Default value: 'public'

lan_channel

Data type: Optional[Integer]

Controls the lan channel of the IPMI network on which snmp is to be configured. Defaults to the first detected lan channel, starting at 1 ending at 11

Default value: undef

ipmi::user

Manage BMC users

Parameters

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

• user
• priv
• enable
• user_id
• password
• channel

user

Data type: String

Controls the username of the user to be created.

Default value: 'root'

priv

Data type: Integer

Possible values: 4 - ADMINISTRATOR, 3 - OPERATOR, 2 - USER, 1 - CALLBACK

Controls the rights of the user to be created.

Default value: 4

enable

Data type: Boolean

Should this user be enabled?

Default value: true

user_id

Data type: Integer

The user id of the user to be created. Should be unique from existing users. On SuperMicro IPMI, user id 2 is reserved for the 'ADMIN' username. On ASUS IPMI, user id 2 is reserved for the 'admin' username.

Default value: 3

password

Data type: Optional[Variant[Sensitive[String[1]], String[1]]]

Controls the password of the user to be created.

Default value: undef

channel

Data type: Optional[Integer]

Controls the channel of the IPMI user to be configured. Defaults to the first detected lan channel, starting at 1 ending at 11

Default value: undef