---
date_published: 2026-08-13
date_modified: 2026-08-13
canonical_url: https://metricshub.org/community-connectors/connectors/ipmitool.html
---

 [Supported Platforms](../supported-platforms.html)   [Connectors Directory](../connectors-directory.html)

# IPMI Over-Lan

## Description

This connector provides environmental information on several IPMI-enabled servers in-band and out-of-band (temperatures, fans, etc.).

This connector is superseded by: 

- [Redfish](redfish.html)
- [WindowsIpmiTool](windowsipmitool.html)
- [LinuxIpmiTool](linuxipmitool.html)

This connector supersedes: 

- [lmsensors](lmsensors.html)

[community](tags/community.html) [hardware](tags/hardware.html) [linux](tags/linux.html) [solaris](tags/solaris.html) [windows](tags/windows.html)

[Source](https://github.com/metricshub/community-connectors/tree/main/src/main/connector/hardware/IpmiTool/IpmiTool.yaml)

## Target

Typical platform: **[IPMI](platforms/ipmi.html)**

Operating systems: **Linux, Oracle Solaris, Microsoft Windows, Out-Of-Band**

## Prerequisites

Leverages: **IPMI**

Technology and protocols: **IPMI**

## Examples

### CLI

```batch
metricshub HOSTNAME -t management -c +IpmiTool --ipmi -u USER
```

### metricshub.yaml

```yaml
resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: management
        connectors: [ +IpmiTool ] # Optional, to load only this connector
        protocols:
          ipmi:
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt

      # IPMI on Windows is accessed through WMI:
      <WIN_HOSTNAME-ID>:
        attributes:
          host.name: <WIN_HOSTNAME>
          type: win
        protocols:
          wmi:
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt

      # IPMI on Linux is accessed through SSH:
      <LINUX_HOSTNAME-ID>:
        attributes:
          host.name: <LINUX_HOSTNAME>
          type: linux
        protocols:
          ssh:
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt
            userSudo: true
```

## Connector Activation Criteria

The **IPMI Over-Lan** connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

- The IPMI-related WMI classes are populated on Windows,
- **OR** `ipmitool` works properly with the local IPMI driver on Linux and Solaris,
- **OR** IPMI-over-LAN has been enabled as an out-of-band interface

## Metrics

| Type | Collected Metrics | Specific Attributes |
| --- | --- | --- |
| **battery** | - `hw.status{hw.type="battery", state="degraded\|failed\|ok"}` - `hw.status{hw.type="battery", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `info` - `model` |
| **blade** | - `hw.status{hw.type="blade", state="degraded\|failed\|ok"}` - `hw.status{hw.type="blade", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `info` - `model` - `name` - `serial_number` |
| **cpu** | - `hw.status{hw.type="cpu", state="degraded\|failed\|ok"}` - `hw.status{hw.type="cpu", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `info` - `model` - `vendor` |
| **enclosure** | - `hw.enclosure.energy` - `hw.enclosure.power` - `hw.status{hw.type="enclosure", state="degraded\|failed\|ok"}` - `hw.status{hw.type="enclosure", state="present"}` | - `id` - `info` - `model` - `serial_number` - `vendor` |
| **fan** | - `hw.fan.speed` - `hw.fan.speed.limit{limit_type="low.critical"}` - `hw.fan.speed.limit{limit_type="low.degraded"}` - `hw.status{hw.type="fan", state="degraded\|failed\|ok"}` - `hw.status{hw.type="fan", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `info` - `sensor_location` |
| **led** | - `hw.status{hw.type="led", state="degraded\|failed\|ok"}` - `hw.status{hw.type="led", state="present"}` | - `color` - `hw.parent.id` - `hw.parent.type` - `id` - `name` |
| **memory** | - `hw.memory.limit` - `hw.status{hw.type="memory", state="degraded\|failed\|ok"}` - `hw.status{hw.type="memory", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `info` - `model` - `name` - `serial_number` - `vendor` |
| **other_device** | - `hw.status{hw.type="other_device", state="degraded\|failed\|ok"}` - `hw.status{hw.type="other_device", state="present"}` | - `additional_label` - `device_type` - `hw.parent.id` - `hw.parent.type` - `id` - `info` |
| **physical_disk** | - `hw.status{hw.type="physical_disk", state="degraded\|failed\|ok"}` - `hw.status{hw.type="physical_disk", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `info` - `model` - `serial_number` - `vendor` |
| **power_supply** | - `hw.status{hw.type="power_supply", state="degraded\|failed\|ok"}` - `hw.status{hw.type="power_supply", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `info` - `name` |
| **temperature** | - `hw.status{hw.type="temperature", state="present"}` - `hw.temperature` - `hw.temperature.limit{limit_type="high.critical"}` - `hw.temperature.limit{limit_type="high.degraded"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `name` - `sensor_location` |
| **voltage** | - `hw.status{hw.type="voltage", state="present"}` - `hw.voltage` - `hw.voltage.limit{limit_type="high.critical"}` - `hw.voltage.limit{limit_type="low.critical"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `name` - `sensor_location` |