Linux IPMI (ipmitool)

Description

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

hardware linux

Supersedes

This connector supersedes:

• IpmiTool

Target

Typical platform: IPMI

Operating system: Linux

Prerequisites

Leverages: IPMI

Technology and protocols: Commands

Examples

CLI

metricshub HOSTNAME -t linux -c +LinuxIpmiTool --ssh -u USER

metricshub.yaml

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

Connector Activation Criteria

The Linux IPMI (ipmitool) connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

• The command below succeeds on the monitored host:
  • Command: PATH=$PATH:/usr/local/bin:/usr/sfw/bin;export PATH;ipmitool -I open bmc info
  • Output contains: IPMI Version (regex)

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"}	id name sensor_location
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