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

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

# RedFish (REST)

## Description

This connector enables hardware monitoring for Redfish Systems via the Redfish REST API. It monitors the enclosures and physical disks as well as various environment sensors (CPUs, temperatures, fans, power supplies, memory modules and network cards).

This connector supersedes: 

- [IpmiTool](ipmitool.html)
- [LinuxIpmiTool](linuxipmitool.html)
- [WindowsIpmiTool](windowsipmitool.html)

[community](tags/community.html) [hardware](tags/hardware.html) [network](tags/network.html) [raid](tags/raid.html) [storage](tags/storage.html)

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

## Target

Typical platform: **[RedFish](platforms/red-fish.html)**

Operating system: **Out-Of-Band**

## Prerequisites

Leverages: **RedFish REST API**

Technology and protocols: **HTTP/REST**

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

## Examples

### CLI

```batch
metricshub HOSTNAME -t management -c +Redfish --https --http-port 443 -u USERNAME
```

### metricshub.yaml

```yaml
resourceGroups:
  <RESOURCE_GROUP>:
    resources:
      <HOSTNAME-ID>:
        attributes:
          host.name: <HOSTNAME> # Change with actual host name
          host.type: management
        connectors: [ +Redfish ] # Optional, to load only this connector
        protocols:
          http:
            https: true
            port: 443 # or probably something else
            username: <USERNAME> # Change with actual credentials
            password: <PASSWORD> # Encrypted using metricshub-encrypt
```

## Connector Activation Criteria

The **RedFish (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`
    - Request Header:  
      `Authorization: Basic %{BASIC_AUTH_BASE64}`
    - The response body contains: `redfish` (regex)

## Metrics

| Type | Collected Metrics | Specific Attributes |
| --- | --- | --- |
| **cpu** | - `hw.cpu.speed.limit{limit_type="max"}` - `hw.status{hw.type="cpu", state="degraded\|failed\|ok"}` - `hw.status{hw.type="cpu", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `model` - `name` - `vendor` |
| **enclosure** | - `hw.status{hw.type="enclosure", state="degraded\|failed\|ok"}` - `hw.status{hw.type="enclosure", state="present"}` | - `id` - `model` - `name` - `serial_number` - `type` - `vendor` |
| **fan** | - `hw.fan.speed` - `hw.fan.speed.limit{limit_type="low.critical"}` - `hw.fan.speed.limit{limit_type="low.degraded"}` - `hw.fan.speed_ratio` - `hw.status{hw.type="fan", state="degraded\|failed\|ok"}` - `hw.status{hw.type="fan", state="present"}` | - `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` - `model` - `name` - `serial_number` - `type` - `vendor` |
| **network** | - `hw.network.bandwidth.limit` - `hw.network.up` - `hw.status{hw.type="network", state="degraded\|failed\|ok"}` - `hw.status{hw.type="network", state="present"}` | - `hw.parent.id` - `hw.parent.type` - `id` - `name` - `physical_address` |
| **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` - `model` - `name` - `vendor` |
| **power_supply** | - `hw.power_supply.limit` - `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` - `power_supply_type` |
| **temperature** | - `hw.status{hw.type="temperature", state="degraded\|failed\|ok"}` - `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` |
| **voltage** | - `hw.status{hw.type="voltage", state="degraded\|failed\|ok"}` - `hw.status{hw.type="voltage", state="present"}` - `hw.voltage` | - `hw.parent.id` - `hw.parent.type` - `id` - `name` |