ironic/doc/source/drivers/ipmitool.rst

IPMITool driver

Overview

The IPMI (Intelligent Platform Management Interface) drivers manage nodes by using IPMI protocol versions 2.0 or 1.5. They use the IPMItool utility which is an open-source command-line interface (CLI) for controlling IPMI-enabled devices.

The following hardware types and classic drivers use IPMItool for power and management:

• hardware types:
  • ipmi
• classic drivers:
  • agent_ipmitool
  • pxe_ipmitool
  • agent_ipmitool_socat
  • pxe_ipmitool_socat

Glossary

• IPMI - Intelligent Platform Management Interface.
• IPMB - Intelligent Platform Management Bus/Bridge.
• BMC - Baseboard Management Controller.
• RMCP - Remote Management Control Protocol.

Enabling the IPMITool driver(s)

Please see IPMI configuration guide for the required dependencies.

1. The ipmi hardware type is enabled by default starting with the Ocata release. To enable it explicitly, add the following to your ironic.conf:

   [DEFAULT]
   enabled_hardware_types = ipmi

2. The pxe_ipmitool classic driver is enabled by default. To enable one or more of the other ipmitool classic drivers, add them to the enabled_drivers configuration option in your ironic.conf. The following enables pxe_ipmitool and agent_ipmitool drivers:

   [DEFAULT]
   enabled_drivers = pxe_ipmitool,agent_ipmitool

3. Restart the Ironic conductor service.

Please see documentation on enabling drivers for more details.

Registering a node with the IPMItool driver

Nodes configured to use the IPMItool drivers should have the driver field set to ipmi (hardware type) or to the name of one of the classic drivers that support ipmitool.

The following configuration value is required and has to be added to the node's driver_info field:

• ipmi_address: The IP address or hostname of the BMC.

Other options may be needed to match the configuration of the BMC, the following options are optional, but in most cases, it's considered a good practice to have them set:

• ipmi_username: The username to access the BMC; defaults to NULL user.
• ipmi_password: The password to access the BMC; defaults to NULL.
• ipmi_port: The remote IPMI RMCP port. By default ipmitool will use the port 623.

Note

It is highly recommend that you setup a username and password for your BMC.

The ironic node-create command can be used to enroll a node with an IPMITool-based driver. For example:

ironic node-create -d ipmi -i ipmi_address=<address> \
    -i ipmi_username=<username> -i ipmi_password=<password>

Advanced configuration

When a simple configuration such as providing the address, username and password is not enough, the IPMItool driver contains many other options that can be used to address special usages.

Single/Double bridging functionality

Note

A version of IPMItool higher or equal to 1.8.12 is required to use the bridging functionality.

There are two different bridging functionalities supported by the IPMITool-based drivers: single bridge and dual bridge.

The following configuration values need to be added to the node's driver_info field so bridging can be used:

• ipmi_bridging: The bridging type; default is no; other supported values are single for single bridge or dual for double bridge.

• ipmi_local_address: The local IPMB address for bridged requests.

  Required only if ipmi_bridging is set to single or dual. This configuration is optional, if not specified it will be auto discovered by IPMItool.

• ipmi_target_address: The destination address for bridged requests. Required only if ipmi_bridging is set to single or dual.
• ipmi_target_channel: The destination channel for bridged requests. Required only if ipmi_bridging is set to single or dual.

Double bridge specific options:

• ipmi_transit_address: The transit address for bridged requests. Required only if ipmi_bridging is set to dual.
• ipmi_transit_channel: The transit channel for bridged requests. Required only if ipmi_bridging is set to dual.

The parameter ipmi_bridging should specify the type of bridging required: single or dual to access the bare metal node. If the parameter is not specified, the default value will be set to no.

The ironic node-update command can be used to set the required bridging information to the Ironic node enrolled with the IPMItool driver. For example:

• Single Bridging:

  ironic node-update add <UUID or name> driver_info/ipmi_local_address=<address> \
      driver_info/ipmi_bridging=single driver_info/ipmi_target_channel=<channel> \
      driver_info/ipmi_target_address=<target address>

• Double Bridging:

  ironic node-update add <UUID or name> driver_info/ipmi_local_address=<address> \
      driver_info/ipmi_bridging=dual driver_info/ipmi_transit_channel=<transit channel> \
      driver_info/ipmi_transit_address=<transit address> driver_info/ipmi_target_channel=<target channel> \
      driver_info/ipmi_target_address=<target address>

Changing the version of the IPMI protocol

The IPMItool-based drivers works with the versions 2.0 and 1.5 of the IPMI protocol. By default, the version 2.0 is used.

In order to change the IPMI protocol version in the bare metal node, the following option needs to be set to the node's driver_info field:

• ipmi_protocol_version: The version of the IPMI protocol; default is 2.0. Supported values are 1.5 or 2.0.

The ironic node-update command can be used to set the desired protocol version:

ironic node-update add <UUID or name> driver_info/ipmi_protocol_version=<version>

Warning

Version 1.5 of the IPMI protocol does not support encryption. Therefore, it is highly recommended that version 2.0 is used.