Back to the list of connectors

SuperMicro REST

Description

This connector provides hardware monitoring for SuperMicro Systems via Redfish REST API. It monitors the Enclosure and Physical Disks as well as the various environment sensors (CPUs, temperatures, fans, power supplies, Memory and Network cards).

Connector ID: SuperMicro

Target

Typical platform: SuperMicro

Operating system: Out-of-Band

Prerequisites

Leverages:

Technology and protocols: HTTP/REST

This connector is not available for the local host (it is applicable to remote hosts only).

Examples

CLI

hws HOSTNAME -t management -f SuperMicro --https --http-port 443 -u USERNAME

hws-config.yaml

hosts:
- host:
    hostname: <HOSTNAME> # Change with actual host name
    type: management
  selectedConnectors: [ SuperMicro ] # Optional, to load only this connector
  http:
    https: true
    port: 443 # or probably something else
    username: <USERNAME> # Change with actual credentials
    password: <PASSWORD> # Encrypted using hws-encrypt

Connector Activation Criteria

The SuperMicro REST connector will be automatically activated, and its status will be reported as OK if all the below criteria are met:

  • The HTTP Request below to the managed host succeeds:
    • GET /redfish/v1/Systems/1
    • The response body contains: Supermicro (regex)

Metrics

Type Collected Metrics Specific Attributes (Labels)
Enclosure
  • hw.status{hw.type="enclosure",state="ok|degraded|failed"}
  • hw.status{hw.type="enclosure",state="present"}
  • model
  • serial_number
  • type
  • vendor
Processor
  • hw.cpu.speed.limit{limit_type="max"}
  • hw.status{hw.type="cpu",state="ok|degraded|failed"}
  • hw.status{hw.type="cpu",state="present"}
  • model
  • vendor
Fan
  • hw.fan.limit{limit_type="high.critical"}
  • hw.fan.limit{limit_type="high.degraded"}
  • hw.fan.speed
  • hw.fan.speed_ratio
  • hw.status{hw.type="fan",state="ok|degraded|failed"}
  • hw.status{hw.type="fan",state="present"}
    Memory Module
    • hw.memory.limit
    • hw.status{hw.type="memory",state="ok|degraded|failed"}
    • hw.status{hw.type="memory",state="present"}
    • model
    • serial_number
    • type
    • vendor
    Network Card, FC Port
    • hw.network.bandwidth.limit
    • hw.network.up
    • hw.status{hw.type="network",state="ok|degraded|failed"}
    • hw.status{hw.type="network",state="present"}
    • physical_address
    Physical Disk
    • hw.status{hw.type="physical_disk",state="ok|degraded|failed"}
    • hw.status{hw.type="physical_disk",state="present"}
    • model
    • vendor
    Power Supply
    • hw.power_supply.limit{limit_type="max"}
    • hw.status{hw.type="power_supply",state="ok|degraded|failed"}
    • hw.status{hw.type="power_supply",state="present"}
    • info
    • power_supply_type
    Temperature Sensor
    • hw.status{hw.type="temperature",state="ok|degraded|failed"}
    • hw.status{hw.type="temperature",state="present"}
    • hw.temperature
      Voltage Sensor
      • hw.status{hw.type="voltage",state="ok|degraded|failed"}
      • hw.status{hw.type="voltage",state="present"}
      • hw.voltage
        No results.