Back to the list of connectors

IPMI

Description

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

Connector ID: IpmiTool

This connector is superseded by:

Target

Typical platform: Any system with IPMI

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

Prerequisites

Leverages: IPMI

Technology and protocols: IPMI

This connector requires advanced privileges on the managed host for the command below:

  • ipmitool

This connector therefore needs to run as root or you need to configure a privilege-escalation mechanism like sudo on the managed host to allow the monitoring account to run the command listed above.

Sample of /etc/sudoers to allow the above command to be run as root by the hwsagent account:

hwsagent ALL=(root) NOPASSWD: ipmitool

Examples

CLI

hws HOSTNAME -t management -f IpmiTool --ipmi -u USER

hws-config.yaml

hosts:
- host:
    hostname: <HOSTNAME> # Change with actual host name
    type: management
  selectedConnectors: [ IpmiTool ] # Optional, to load only this connector
  ipmi:
    username: <USERNAME> # Change with actual credentials
    password: <PASSWORD> # Encrypted using hws-encrypt

# IPMI on Windows is accessed through WMI:
- target:
    hostname: <WIN_HOSTNAME>
    type: win
  wmi:
    username: <USERNAME>
    password: <PASSWORD>

# IPMI on Linux is accessed through SSH:
- target:
    hostname: <LINUX_HOSTNAME>
    type: linux
  ssh:
    username: <USERNAME>
    password: <PASSWORD>
    useSudo: true

Connector Activation Criteria

The IPMI 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 (Labels)
Enclosure
  • hw.enclosure.energy
  • hw.status{hw.type="enclosure",state="ok|degraded|failed"}
  • hw.status{hw.type="enclosure",state="present"}
  • info
  • model
  • serial_number
  • vendor
Battery
  • hw.status{hw.type="battery",state="ok|degraded|failed"}
  • hw.status{hw.type="battery",state="present"}
  • info
  • model
Blade
  • hw.status{hw.type="blade",state="ok|degraded|failed"}
  • hw.status{hw.type="blade",state="present"}
  • info
  • model
  • serial_number
Processor
  • hw.status{hw.type="cpu",state="ok|degraded|failed"}
  • hw.status{hw.type="cpu",state="present"}
  • info
  • model
  • vendor
Fan
  • hw.fan.limit{limit_type="high.critical"}
  • hw.fan.limit{limit_type="high.degraded"}
  • hw.fan.speed
  • hw.status{hw.type="fan",state="ok|degraded|failed"}
  • hw.status{hw.type="fan",state="present"}
  • info
  • sensor_location
LED
  • hw.status{hw.type="led",state="ok|degraded|failed"}
  • hw.status{hw.type="led",state="present"}
    Memory Module
    • hw.memory.limit
    • hw.status{hw.type="memory",state="ok|degraded|failed"}
    • hw.status{hw.type="memory",state="present"}
    • info
    • model
    • serial_number
    • vendor
    Other Device
    • hw.status{hw.type="other_device",state="ok|degraded|failed"}
    • hw.status{hw.type="other_device",state="present"}
    • info
    • device_type
    Physical Disk
    • hw.status{hw.type="physical_disk",state="ok|degraded|failed"}
    • hw.status{hw.type="physical_disk",state="present"}
    • info
    • model
    • serial_number
    • vendor
    Power Supply
    • hw.status{hw.type="power_supply",state="ok|degraded|failed"}
    • hw.status{hw.type="power_supply",state="present"}
    • info
    Temperature Sensor
    • hw.status{hw.type="temperature",state="present"}
    • hw.temperature
    • hw.temperature.limit{limit_type="high.critical"}
    • hw.temperature.limit{limit_type="high.degraded"}
    • sensor_location
    Voltage Sensor
    • hw.status{hw.type="voltage",state="present"}
    • hw.voltage
    • hw.voltage.limit{limit_type="high.critical"}
    • hw.voltage.limit{limit_type="low.critical"}
    • sensor_location
    No results.