Redfish
Plugin: go.d.plugin Module: redfish
Overview
Monitor server hardware through the DMTF Redfish API of a baseboard management controller (BMC). One job covers the health, environmental readings, and inventory of everything behind a single BMC endpoint.
The collector reads these areas. Each component reports its own readings alongside the health and state the BMC publishes for it.
| Area | Components |
|---|---|
| Base | ServiceRoot, systems, chassis, managers. Always collected. |
| Compute | Processors and processor metrics. |
| Memory | Memory modules and memory metrics. |
| Thermal | Fans, pumps, coolant connectors, filters, heaters, leak detection, environmental readings. |
| Power | Power subsystem, power supplies, batteries. |
| Storage | Storage subsystems, controllers, drives, volumes. |
| Network | Network adapters, ports, interfaces, device functions. |
| PCIe | PCIe devices and functions. |
| Sensors | Individual sensor readings: thermal, electrical, rotational, and quantities derived from them. |
| Firmware | Firmware and software inventory, update service, assemblies. |
Every system the endpoint exposes appears on this job's virtual node, or on the collecting Agent when the job has no virtual node.
The collector connects to the Redfish ServiceRoot over HTTP or HTTPS and reads the standard resource types,
following links within the same origin. It walks the endpoint once per collection interval, sending several
requests at a time up to max_concurrent_requests.
Authentication is set by auth_method:
| Mode | Behavior |
|---|---|
auto | Uses a Redfish session when the BMC advertises one, otherwise HTTP Basic. The default. |
session | Always uses a session. The BMC must publish an origin-relative Links.Sessions endpoint. |
basic | Sends HTTP Basic credentials with every request. |
none | Sends no credentials. |
The only writes it makes are creating and deleting its own Redfish sessions. Everything else is read-only: it changes no setting on the BMC and touches nothing on the systems behind it.
This collector is supported on all platforms.
This collector supports collecting metrics from multiple instances of this integration, including remote instances.
A read-only Redfish account on the BMC. No elevated privileges are needed on the Agent host.
Default Behavior
Auto-Detection
Endpoints are not auto-detected. Configure each BMC as a static or DynCfg job.
Limits
Only standard Redfish properties are collected. Vendor-specific OEM extensions are not.
A reading the endpoint does not return leaves a gap on the chart rather than a zero. Each request must
finish within timeout (15 seconds by default) and the whole walk within update_every (60 seconds by
default); when a walk runs out of time the collector publishes what it finished and starts fresh at the
next interval, so some charts skip that cycle.
Performance Impact
On the Agent host the cost is negligible — HTTP requests and JSON parsing.
On the BMC it scales with how many components the endpoint exposes, since one collection walks every
selected resource. The collector sends up to max_concurrent_requests at a time (3 by default, or one
when the ServiceRoot declares it cannot serve concurrent requests). BMCs are frequently slow and serialize
work internally, so a large chassis can keep the controller busy for much of the interval.
If the BMC struggles, raise update_every, lower max_concurrent_requests, or narrow collect to the
areas you need.
Setup
You can configure the redfish collector in two ways:
| Method | Best for | How to |
|---|---|---|
| UI | Fast setup without editing files | Go to Nodes → Configure this node → Collectors → Jobs, search for redfish, then click + to add a job. |
| File | If you prefer configuring via file, or need to automate deployments (e.g., with Ansible) | Edit go.d/redfish.conf and add a job. |
UI configuration requires paid Netdata Cloud plan.
Prerequisites
Enable and authorize Redfish
Enable the BMC's Redfish service and create a least-privilege monitoring account that can read the desired systems, chassis, managers, sensors, and storage.
Establish network and TLS trust
Ensure the Netdata Agent can reach the BMC. Prefer HTTPS with a trusted BMC certificate or configure tls_ca.
tls_skip_verify is available for legacy/self-signed deployments but permits machine-in-the-middle attacks.
Configuration
Options
The following options apply per Redfish endpoint job. Credentials and private-key fields support Netdata secret
references such as ${env:VARIABLE} and ${file:/path}.
Config options
| Group | Option | Description | Default | Required |
|---|---|---|---|---|
| Collection | update_every | Data collection interval, in seconds. | 60 | no |
| autodetection_retry | How often to retry the initial connection when the job fails to start, in seconds. Zero disables retries. | 0 | no | |
| Target | url | URL of the Redfish service. Accepts the origin or the full ServiceRoot path, over HTTP or HTTPS. Use HTTPS when the job sends credentials; over HTTP they travel in clear text, and the job logs a warning. | yes | |
| Virtual Node | vnode | Associates this job with a Virtual Node. | no | |
| Authentication | auth_method | How to authenticate with the BMC: auto, session, basic, or none. auto prefers a Redfish session and falls back to HTTP Basic. | auto | no |
| username | Username of the BMC account. Required unless the authentication method is none. | no | ||
| password | Password of the BMC account. Required unless the authentication method is none. | no | ||
| HTTP | timeout | HTTP request timeout, in seconds. | 15 | no |
| max_concurrent_requests | Maximum number of requests sent to this BMC at the same time. Lower it for controllers that rate-limit or respond slowly. | 3 | no | |
| proxy_url | Proxy to use for the BMC requests. Leave empty to use the proxy settings from the environment. | no | ||
| TLS | tls_ca | Path to a CA bundle file used to verify the BMC certificate. Leave empty to use the system trust store. | no | |
| tls_cert | Path to a client certificate file for mutual TLS. Requires a client key. | no | ||
| tls_key | Path to the client key file for mutual TLS. Requires a client certificate. | no | ||
| tls_skip_verify | Accept any certificate the BMC presents, including self-signed and expired ones. | no | no | |
| Collection | collect | Simple pattern selecting which component areas to collect: base, compute, memory, thermal, power, storage, network, pcie, sensors, firmware. Base is always collected. | * | no |
via UI
Configure the redfish collector from the Netdata web interface:
- Go to Nodes.
- Select the node where you want the redfish data-collection job to run and click the ⚙ (Configure this node). That node will run the data collection.
- The Collectors → Jobs view opens by default.
- In the Search box, type redfish (or scroll the list) to locate the redfish collector.
- Click the + next to the redfish collector to add a new job.
- Fill in the job fields, then click Test to verify the configuration and Submit to save.
- Test runs the job with the provided settings and shows whether data can be collected.
- If it fails, an error message appears with details (for example, connection refused, timeout, or command execution errors), so you can adjust and retest.
via File
The configuration file name for this integration is go.d/redfish.conf.
The file format is YAML. Generally, the structure is:
update_every: 1
autodetection_retry: 0
jobs:
- name: some_name1
- name: some_name2
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config go.d/redfish.conf
Examples
Monitor a BMC
Collect hardware readings and health from one Redfish endpoint.
Config
jobs:
- name: bmc
url: https://192.0.2.1/redfish/v1/
username: monitoring
password: ${file:/etc/netdata/redfish-password}
tls_ca: /etc/netdata/redfish-ca.pem
Attach to a configured virtual node
Define a virtual node in vnodes.conf, then attach this endpoint job to it.
Config
jobs:
- name: remote-bmc
vnode: server-one
url: https://192.0.2.1/redfish/v1/
username: monitoring
password: ${file:/etc/netdata/redfish-password}
Alerts
The following alerts are available:
| Alert name | On metric | Description |
|---|---|---|
| redfish_assembly_conditions | redfish.assembly.conditions | Redfish ${label:resource_name} reports a non-healthy state for Assembly Conditions |
| redfish_assembly_health | redfish.assembly.health | Redfish ${label:resource_name} reports a non-healthy state for Assembly Health |
| redfish_assembly_health_rollup | redfish.assembly.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Assembly Health Rollup |
| redfish_battery_conditions | redfish.battery.conditions | Redfish ${label:resource_name} reports a non-healthy state for Battery Conditions |
| redfish_battery_health | redfish.battery.health | Redfish ${label:resource_name} reports a non-healthy state for Battery Health |
| redfish_battery_health_rollup | redfish.battery.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Battery Health Rollup |
| redfish_chassis_conditions | redfish.chassis.conditions | Redfish ${label:resource_name} reports a non-healthy state for Chassis Conditions |
| redfish_chassis_health | redfish.chassis.health | Redfish ${label:resource_name} reports a non-healthy state for Chassis Health |
| redfish_chassis_health_rollup | redfish.chassis.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Chassis Health Rollup |
| redfish_chassis_intrusion_state | redfish.chassis.intrusion_state | Redfish ${label:resource_name} reports a non-healthy state for Chassis Intrusion State |
| redfish_collection_status | redfish.collection.status | Redfish endpoint ${label:_collect_job} reports a non-healthy state for Redfish Collection Status |
| redfish_control_conditions | redfish.control.conditions | Redfish ${label:resource_name} reports a non-healthy state for Control Conditions |
| redfish_control_health | redfish.control.health | Redfish ${label:resource_name} reports a non-healthy state for Control Health |
| redfish_control_health_rollup | redfish.control.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Control Health Rollup |
| redfish_coolant_connector_conditions | redfish.coolant_connector.conditions | Redfish ${label:resource_name} reports a non-healthy state for Coolant Connector Conditions |
| redfish_coolant_connector_health | redfish.coolant_connector.health | Redfish ${label:resource_name} reports a non-healthy state for Coolant Connector Health |
| redfish_coolant_connector_health_rollup | redfish.coolant_connector.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Coolant Connector Health Rollup |
| redfish_drive_conditions | redfish.drive.conditions | Redfish ${label:resource_name} reports a non-healthy state for Drive Conditions |
| redfish_drive_failure_predicted | redfish.drive.failure_predicted | Redfish ${label:resource_name} reports a non-healthy state for Drive Failure Prediction |
| redfish_drive_health | redfish.drive.health | Redfish ${label:resource_name} reports a non-healthy state for Drive Health |
| redfish_drive_health_rollup | redfish.drive.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Drive Health Rollup |
| redfish_drive_status_indicator | redfish.drive.status_indicator | Redfish ${label:resource_name} reports a non-healthy state for Drive Status Indicator |
| redfish_ethernet_interface_conditions | redfish.ethernet_interface.conditions | Redfish ${label:resource_name} reports a non-healthy state for Ethernet Interface Conditions |
| redfish_ethernet_interface_health | redfish.ethernet_interface.health | Redfish ${label:resource_name} reports a non-healthy state for Ethernet Interface Health |
| redfish_ethernet_interface_health_rollup | redfish.ethernet_interface.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Ethernet Interface Health Rollup |
| redfish_fan_conditions | redfish.fan.conditions | Redfish ${label:resource_name} reports a non-healthy state for Fan Conditions |
| redfish_fan_health | redfish.fan.health | Redfish ${label:resource_name} reports a non-healthy state for Fan Health |
| redfish_fan_health_rollup | redfish.fan.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Fan Health Rollup |
| redfish_filter_conditions | redfish.filter.conditions | Redfish ${label:resource_name} reports a non-healthy state for Filter Conditions |
| redfish_filter_health | redfish.filter.health | Redfish ${label:resource_name} reports a non-healthy state for Filter Health |
| redfish_filter_health_rollup | redfish.filter.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Filter Health Rollup |
| redfish_firmware_conditions | redfish.firmware.conditions | Redfish ${label:resource_name} reports a non-healthy state for Firmware Conditions |
| redfish_firmware_health | redfish.firmware.health | Redfish ${label:resource_name} reports a non-healthy state for Firmware Health |
| redfish_firmware_health_rollup | redfish.firmware.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Firmware Health Rollup |
| redfish_heater_conditions | redfish.heater.conditions | Redfish ${label:resource_name} reports a non-healthy state for Heater Conditions |
| redfish_heater_health | redfish.heater.health | Redfish ${label:resource_name} reports a non-healthy state for Heater Health |
| redfish_heater_health_rollup | redfish.heater.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Heater Health Rollup |
| redfish_leak_detection_conditions | redfish.leak_detection.conditions | Redfish ${label:resource_name} reports a non-healthy state for Leak Detection Conditions |
| redfish_leak_detection_health | redfish.leak_detection.health | Redfish ${label:resource_name} reports a non-healthy state for Leak Detection Health |
| redfish_leak_detection_health_rollup | redfish.leak_detection.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Leak Detection Health Rollup |
| redfish_leak_detector_conditions | redfish.leak_detector.conditions | Redfish ${label:resource_name} reports a non-healthy state for Leak Detector Conditions |
| redfish_leak_detector_detector_state | redfish.leak_detector.detector_state | Redfish ${label:resource_name} reports a non-healthy state for Leak Detector State |
| redfish_leak_detector_health | redfish.leak_detector.health | Redfish ${label:resource_name} reports a non-healthy state for Leak Detector Health |
| redfish_leak_detector_health_rollup | redfish.leak_detector.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Leak Detector Health Rollup |
| redfish_leak_detector_group_conditions | redfish.leak_detector_group.conditions | Redfish ${label:resource_name} reports a non-healthy state for Leak Detector Group Conditions |
| redfish_leak_detector_group_health | redfish.leak_detector_group.health | Redfish ${label:resource_name} reports a non-healthy state for Leak Detector Group Health |
| redfish_leak_detector_group_health_rollup | redfish.leak_detector_group.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Leak Detector Group Health Rollup |
| redfish_manager_conditions | redfish.manager.conditions | Redfish ${label:resource_name} reports a non-healthy state for Manager Conditions |
| redfish_manager_health | redfish.manager.health | Redfish ${label:resource_name} reports a non-healthy state for Manager Health |
| redfish_manager_health_rollup | redfish.manager.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Manager Health Rollup |
| redfish_memory_conditions | redfish.memory.conditions | Redfish ${label:resource_name} reports a non-healthy state for Memory Module Conditions |
| redfish_memory_health | redfish.memory.health | Redfish ${label:resource_name} reports a non-healthy state for Memory Module Health |
| redfish_memory_health_rollup | redfish.memory.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Memory Module Health Rollup |
| redfish_network_adapter_conditions | redfish.network_adapter.conditions | Redfish ${label:resource_name} reports a non-healthy state for Network Adapter Conditions |
| redfish_network_adapter_health | redfish.network_adapter.health | Redfish ${label:resource_name} reports a non-healthy state for Network Adapter Health |
| redfish_network_adapter_health_rollup | redfish.network_adapter.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Network Adapter Health Rollup |
| redfish_network_device_function_conditions | redfish.network_device_function.conditions | Redfish ${label:resource_name} reports a non-healthy state for Network Device Function Conditions |
| redfish_network_device_function_health | redfish.network_device_function.health | Redfish ${label:resource_name} reports a non-healthy state for Network Device Function Health |
| redfish_network_device_function_health_rollup | redfish.network_device_function.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Network Device Function Health Rollup |
| redfish_network_interface_conditions | redfish.network_interface.conditions | Redfish ${label:resource_name} reports a non-healthy state for Network Interface Conditions |
| redfish_network_interface_health | redfish.network_interface.health | Redfish ${label:resource_name} reports a non-healthy state for Network Interface Health |
| redfish_network_interface_health_rollup | redfish.network_interface.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Network Interface Health Rollup |
| redfish_network_port_conditions | redfish.network_port.conditions | Redfish ${label:resource_name} reports a non-healthy state for Network Port Conditions |
| redfish_network_port_health | redfish.network_port.health | Redfish ${label:resource_name} reports a non-healthy state for Network Port Health |
| redfish_network_port_health_rollup | redfish.network_port.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Network Port Health Rollup |
| redfish_pcie_device_conditions | redfish.pcie_device.conditions | Redfish ${label:resource_name} reports a non-healthy state for PCIe Device Conditions |
| redfish_pcie_device_health | redfish.pcie_device.health | Redfish ${label:resource_name} reports a non-healthy state for PCIe Device Health |
| redfish_pcie_device_health_rollup | redfish.pcie_device.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for PCIe Device Health Rollup |
| redfish_pcie_function_conditions | redfish.pcie_function.conditions | Redfish ${label:resource_name} reports a non-healthy state for PCIe Function Conditions |
| redfish_pcie_function_health | redfish.pcie_function.health | Redfish ${label:resource_name} reports a non-healthy state for PCIe Function Health |
| redfish_pcie_function_health_rollup | redfish.pcie_function.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for PCIe Function Health Rollup |
| redfish_port_conditions | redfish.port.conditions | Redfish ${label:resource_name} reports a non-healthy state for Port Conditions |
| redfish_port_health | redfish.port.health | Redfish ${label:resource_name} reports a non-healthy state for Port Health |
| redfish_port_health_rollup | redfish.port.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Port Health Rollup |
| redfish_power_subsystem_conditions | redfish.power_subsystem.conditions | Redfish ${label:resource_name} reports a non-healthy state for Power Subsystem Conditions |
| redfish_power_subsystem_health | redfish.power_subsystem.health | Redfish ${label:resource_name} reports a non-healthy state for Power Subsystem Health |
| redfish_power_subsystem_health_rollup | redfish.power_subsystem.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Power Subsystem Health Rollup |
| redfish_power_supply_conditions | redfish.power_supply.conditions | Redfish ${label:resource_name} reports a non-healthy state for Power Supply Conditions |
| redfish_power_supply_health | redfish.power_supply.health | Redfish ${label:resource_name} reports a non-healthy state for Power Supply Health |
| redfish_power_supply_health_rollup | redfish.power_supply.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Power Supply Health Rollup |
| redfish_power_supply_line_input_status | redfish.power_supply.line_input_status | Redfish ${label:resource_name} reports a non-healthy state for Power Supply Line Input Status |
| redfish_processor_conditions | redfish.processor.conditions | Redfish ${label:resource_name} reports a non-healthy state for Processor Conditions |
| redfish_processor_health | redfish.processor.health | Redfish ${label:resource_name} reports a non-healthy state for Processor Health |
| redfish_processor_health_rollup | redfish.processor.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Processor Health Rollup |
| redfish_processor_throttling_state | redfish.processor.throttling_state | Redfish ${label:resource_name} reports a non-healthy state for Processor Throttling State |
| redfish_pump_conditions | redfish.pump.conditions | Redfish ${label:resource_name} reports a non-healthy state for Pump Conditions |
| redfish_pump_health | redfish.pump.health | Redfish ${label:resource_name} reports a non-healthy state for Pump Health |
| redfish_pump_health_rollup | redfish.pump.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Pump Health Rollup |
| redfish_reading_alarm | redfish.reading.alarm | Redfish ${label:resource_name} reading ${label:reading_key} reports a non-healthy state for Redfish Reading Source Health State |
| redfish_redundancy_conditions | redfish.redundancy.conditions | Redfish ${label:resource_name} reports a non-healthy state for Redundancy Conditions |
| redfish_redundancy_health | redfish.redundancy.health | Redfish ${label:resource_name} reports a non-healthy state for Redundancy Health |
| redfish_redundancy_health_rollup | redfish.redundancy.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Redundancy Health Rollup |
| redfish_sensor_conditions | redfish.sensor.conditions | Redfish ${label:resource_name} reports a non-healthy state for Sensor Conditions |
| redfish_sensor_health | redfish.sensor.health | Redfish ${label:resource_name} reports a non-healthy state for Sensor Health |
| redfish_sensor_health_rollup | redfish.sensor.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Sensor Health Rollup |
| redfish_software_conditions | redfish.software.conditions | Redfish ${label:resource_name} reports a non-healthy state for Software Conditions |
| redfish_software_health | redfish.software.health | Redfish ${label:resource_name} reports a non-healthy state for Software Health |
| redfish_software_health_rollup | redfish.software.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Software Health Rollup |
| redfish_storage_conditions | redfish.storage.conditions | Redfish ${label:resource_name} reports a non-healthy state for Storage Conditions |
| redfish_storage_health | redfish.storage.health | Redfish ${label:resource_name} reports a non-healthy state for Storage Health |
| redfish_storage_health_rollup | redfish.storage.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Storage Health Rollup |
| redfish_storage_controller_conditions | redfish.storage_controller.conditions | Redfish ${label:resource_name} reports a non-healthy state for Storage Controller Conditions |
| redfish_storage_controller_health | redfish.storage_controller.health | Redfish ${label:resource_name} reports a non-healthy state for Storage Controller Health |
| redfish_storage_controller_health_rollup | redfish.storage_controller.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Storage Controller Health Rollup |
| redfish_system_conditions | redfish.system.conditions | Redfish ${label:resource_name} reports a non-healthy state for System Conditions |
| redfish_system_health | redfish.system.health | Redfish ${label:resource_name} reports a non-healthy state for System Health |
| redfish_system_health_rollup | redfish.system.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for System Health Rollup |
| redfish_thermal_subsystem_conditions | redfish.thermal_subsystem.conditions | Redfish ${label:resource_name} reports a non-healthy state for Thermal Subsystem Conditions |
| redfish_thermal_subsystem_health | redfish.thermal_subsystem.health | Redfish ${label:resource_name} reports a non-healthy state for Thermal Subsystem Health |
| redfish_thermal_subsystem_health_rollup | redfish.thermal_subsystem.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Thermal Subsystem Health Rollup |
| redfish_volume_conditions | redfish.volume.conditions | Redfish ${label:resource_name} reports a non-healthy state for Volume Conditions |
| redfish_volume_health | redfish.volume.health | Redfish ${label:resource_name} reports a non-healthy state for Volume Health |
| redfish_volume_health_rollup | redfish.volume.health_rollup | Redfish ${label:resource_name} reports a non-healthy state for Volume Health Rollup |
| redfish_volume_write_cache_state | redfish.volume.write_cache_state | Redfish ${label:resource_name} reports a non-healthy state for Volume Write Cache State |
Metrics
Metrics grouped by scope.
The scope defines the instance that the metric belongs to. An instance is uniquely identified by a set of labels.
Charts appear when the endpoint exposes their source properties. Resource health includes BMC-provided HealthRollup.
Per endpoint
Collection state for one configured Redfish endpoint job.
Labels:
| Label | Description |
|---|---|
| endpoint_key | Stable canonical endpoint key. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| redfish.collection.duration | Redfish Collection Duration | duration | seconds |
| redfish.collection.failures | Redfish Collection Failures | auth, tls, transport, timeout, protocol, limit, internal | failures |
| redfish.collection.http_requests | Redfish Collection HTTP Requests | started, redirected | requests/cycle |
| redfish.collection.operations | Redfish Collection Operations | successful, failed | operations/cycle |
| redfish.collection.resources | Redfish Collection Resources | discovered, readable, unreadable, unknown | resources |
| redfish.collection.status | Redfish Collection Status | success, partial, unavailable | state |
| redfish.collection.traffic | Redfish Collection Traffic | received | bytes/cycle |
Per resource
Measurements and health states for each supported resource exposed by the endpoint.
Labels:
| Label | Description |
|---|---|
| endpoint_key | Stable canonical endpoint key. |
| resource_key | Stable resource identity within the endpoint. |
| resource_kind | Redfish resource kind. |
| resource_name | Current resource display name. |
| slot | Slot, device locator, or socket, when the resource reports one. |
| location | Service label of the physical location, when the resource reports one. |
| manufacturer | Manufacturer, when the resource reports one. |
| model | Model, when the resource reports one. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| redfish.chassis.acquisition_state | Chassis Acquisition State | readable, unreadable, unknown | state |
| redfish.chassis.conditions | Chassis Conditions | ok, warning, critical, unknown | conditions |
| redfish.chassis.health | Chassis Health | ok, warning, critical, unknown | state |
| redfish.chassis.health_rollup | Chassis Health Rollup | ok, warning, critical, unknown | state |
| redfish.chassis.intrusion_state | Chassis Intrusion State | normal, hardware_intrusion, tampering_detected, unknown | state |
| redfish.chassis.power_state | Chassis Power State | on, off, powering_on, powering_off, paused, unknown | state |
| redfish.chassis.state | Chassis State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.redundancy.acquisition_state | Redundancy Acquisition State | readable, unreadable, unknown | state |
| redfish.redundancy.conditions | Redundancy Conditions | ok, warning, critical, unknown | conditions |
| redfish.redundancy.enabled | Redundancy Enabled | disabled, enabled, unknown | state |
| redfish.redundancy.health | Redundancy Health | ok, warning, critical, unknown | state |
| redfish.redundancy.health_rollup | Redundancy Health Rollup | ok, warning, critical, unknown | state |
| redfish.redundancy.members | Redundancy Members | active, total | members |
| redfish.redundancy.mode | Redundancy Mode | failover, n_plus_m, sharing, sparing, not_redundant, unknown | state |
| redfish.redundancy.state | Redundancy State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.sensor.acquisition_state | Sensor Acquisition State | readable, unreadable, unknown | state |
| redfish.sensor.conditions | Sensor Conditions | ok, warning, critical, unknown | conditions |
| redfish.sensor.health | Sensor Health | ok, warning, critical, unknown | state |
| redfish.sensor.health_rollup | Sensor Health Rollup | ok, warning, critical, unknown | state |
| redfish.sensor.state | Sensor State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.service.acquisition_state | Redfish Service Acquisition State | readable, unreadable, unknown | state |
| redfish.system.memory_bandwidth | System Memory Bandwidth | bandwidth | percentage |
| redfish.system.memory_summary_health | System Memory Summary Health | ok, warning, critical, unknown | state |
| redfish.system.memory_summary_health_rollup | System Memory Summary Health Rollup | ok, warning, critical, unknown | state |
| redfish.system.memory_summary_state | System Memory Summary State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.system.memory_utilization | System Memory Utilization | capacity | percentage |
| redfish.system.processor_bandwidth | System Processor Bandwidth | bandwidth | percentage |
| redfish.system.processor_summary_health | System Processor Summary Health | ok, warning, critical, unknown | state |
| redfish.system.processor_summary_health_rollup | System Processor Summary Health Rollup | ok, warning, critical, unknown | state |
| redfish.system.processor_summary_state | System Processor Summary State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.system.processor_utilization | System Processor Utilization | kernel, user | percentage |
| redfish.system.acquisition_state | System Acquisition State | readable, unreadable, unknown | state |
| redfish.system.conditions | System Conditions | ok, warning, critical, unknown | conditions |
| redfish.system.health | System Health | ok, warning, critical, unknown | state |
| redfish.system.health_rollup | System Health Rollup | ok, warning, critical, unknown | state |
| redfish.system.power_state | System Power State | on, off, powering_on, powering_off, paused, unknown | state |
| redfish.system.state | System State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.processor.pcie_error_rate | Processor PCIe Error Rate | bad_dllp, bad_tlp, correctable, fatal, flow_control_timeout, l0_to_recovery, nak_received, nak_sent, non_fatal, replay, replay_rollover, unsupported_request | errors/s |
| redfish.processor.acquisition_state | Processor Acquisition State | readable, unreadable, unknown | state |
| redfish.processor.bandwidth_utilization | Processor Bandwidth Utilization | bandwidth | percentage |
| redfish.processor.clock_speed | Processor Clock Speed | operating | MHz |
| redfish.processor.conditions | Processor Conditions | ok, warning, critical, unknown | conditions |
| redfish.processor.error_rate | Processor Error Rate | correctable_core, correctable_other, uncorrectable_core, uncorrectable_other | errors/s |
| redfish.processor.frequency_ratio | Processor Frequency Ratio | ratio | ratio |
| redfish.processor.health | Processor Health | ok, warning, critical, unknown | state |
| redfish.processor.health_rollup | Processor Health Rollup | ok, warning, critical, unknown | state |
| redfish.processor.power_state | Processor Power State | on, off, powering_on, powering_off, paused, unknown | state |
| redfish.processor.state | Processor State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.processor.thermal_headroom | Processor Thermal Headroom | headroom | Celsius |
| redfish.processor.throttle_time | Processor Throttle Time | power_limit, thermal_limit | percentage |
| redfish.processor.throttling_state | Processor Throttling State | clear, throttled, unknown | state |
| redfish.processor.utilization | Processor Utilization | user, kernel | percentage |
| redfish.processor_core.acquisition_state | Processor Core Acquisition State | readable, unreadable, unknown | state |
| redfish.processor_core.cycle_rate | Processor Core Cycle Rate | io_stall, memory_stall, unhalted | cycles/s |
| redfish.processor_core.error_rate | Processor Core Error Rate | correctable_core, correctable_other, uncorrectable_core, uncorrectable_other | errors/s |
| redfish.processor_core.instructions_per_cycle | Processor Core Instructions per Cycle | instructions | instructions/cycle |
| redfish.memory.acquisition_state | Memory Module Acquisition State | readable, unreadable, unknown | state |
| redfish.memory.bandwidth_utilization | Memory Module Bandwidth Utilization | utilization | percentage |
| redfish.memory.capacity_utilization | Memory Module Capacity Utilization | utilization | percentage |
| redfish.memory.conditions | Memory Module Conditions | ok, warning, critical, unknown | conditions |
| redfish.memory.dirty_shutdown_rate | Memory Module Dirty Shutdown Rate | shutdowns | shutdowns/s |
| redfish.memory.error_rate | Memory Module Error Rate | correctable, indeterminate_correctable, uncorrectable, indeterminate_uncorrectable | errors/s |
| redfish.memory.health | Memory Module Health | ok, warning, critical, unknown | state |
| redfish.memory.health_flags | Memory Module Health Flags | data_loss, last_shutdown_failed, performance_degraded, address_parity, correctable_ecc, spare_block, temperature, uncorrectable_ecc | flags |
| redfish.memory.health_rollup | Memory Module Health Rollup | ok, warning, critical, unknown | state |
| redfish.memory.io | Memory Module I/O | read, written | bytes/s |
| redfish.memory.media_health | Memory Module Media Health | life_left, spare_remaining | percentage |
| redfish.memory.state | Memory Module State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.control.acquisition_state | Control Acquisition State | readable, unreadable, unknown | state |
| redfish.control.conditions | Control Conditions | ok, warning, critical, unknown | conditions |
| redfish.control.frequency | Control Frequency | sensor, setpoint, setpoint_error | hertz |
| redfish.control.health | Control Health | ok, warning, critical, unknown | state |
| redfish.control.health_rollup | Control Health Rollup | ok, warning, critical, unknown | state |
| redfish.control.linear_acceleration | Control Linear Acceleration | sensor, setpoint, setpoint_error | meters/second2 |
| redfish.control.linear_position | Control Linear Position | sensor, setpoint, setpoint_error | meters |
| redfish.control.linear_velocity | Control Linear Velocity | sensor, setpoint, setpoint_error | meters/second |
| redfish.control.liquid_flow | Control Liquid Flow | sensor, setpoint, setpoint_error | liters/minute |
| redfish.control.percentage | Control Percentage | sensor, setpoint, setpoint_error | percentage |
| redfish.control.power | Control Power | sensor, setpoint, setpoint_error | watts |
| redfish.control.pressure | Control Pressure | sensor, setpoint, setpoint_error | pascals |
| redfish.control.rotational_acceleration | Control Rotational Acceleration | sensor, setpoint, setpoint_error | radians/second2 |
| redfish.control.rotational_position | Control Rotational Position | sensor, setpoint, setpoint_error | radians |
| redfish.control.rotational_velocity | Control Rotational Velocity | sensor, setpoint, setpoint_error | radians/second |
| redfish.control.state | Control State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.control.temperature | Control Temperature | sensor, setpoint, setpoint_error | Celsius |
| redfish.control.valve_position | Control Valve Position | sensor, setpoint, setpoint_error | percentage |
| redfish.coolant_connector.acquisition_state | Coolant Connector Acquisition State | readable, unreadable, unknown | state |
| redfish.coolant_connector.conditions | Coolant Connector Conditions | ok, warning, critical, unknown | conditions |
| redfish.coolant_connector.health | Coolant Connector Health | ok, warning, critical, unknown | state |
| redfish.coolant_connector.health_rollup | Coolant Connector Health Rollup | ok, warning, critical, unknown | state |
| redfish.coolant_connector.state | Coolant Connector State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.fan.acquisition_state | Fan Acquisition State | readable, unreadable, unknown | state |
| redfish.fan.conditions | Fan Conditions | ok, warning, critical, unknown | conditions |
| redfish.fan.health | Fan Health | ok, warning, critical, unknown | state |
| redfish.fan.health_rollup | Fan Health Rollup | ok, warning, critical, unknown | state |
| redfish.fan.state | Fan State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.filter.acquisition_state | Filter Acquisition State | readable, unreadable, unknown | state |
| redfish.filter.conditions | Filter Conditions | ok, warning, critical, unknown | conditions |
| redfish.filter.health | Filter Health | ok, warning, critical, unknown | state |
| redfish.filter.health_rollup | Filter Health Rollup | ok, warning, critical, unknown | state |
| redfish.filter.state | Filter State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.heater.acquisition_state | Heater Acquisition State | readable, unreadable, unknown | state |
| redfish.heater.conditions | Heater Conditions | ok, warning, critical, unknown | conditions |
| redfish.heater.health | Heater Health | ok, warning, critical, unknown | state |
| redfish.heater.health_rollup | Heater Health Rollup | ok, warning, critical, unknown | state |
| redfish.heater.heating_time | Heater Heating Time | pre_power_on, runtime | percentage |
| redfish.heater.state | Heater State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.leak_detection.acquisition_state | Leak Detection Acquisition State | readable, unreadable, unknown | state |
| redfish.leak_detection.conditions | Leak Detection Conditions | ok, warning, critical, unknown | conditions |
| redfish.leak_detection.health | Leak Detection Health | ok, warning, critical, unknown | state |
| redfish.leak_detection.health_rollup | Leak Detection Health Rollup | ok, warning, critical, unknown | state |
| redfish.leak_detection.state | Leak Detection State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.leak_detector.acquisition_state | Leak Detector Acquisition State | readable, unreadable, unknown | state |
| redfish.leak_detector.conditions | Leak Detector Conditions | ok, warning, critical, unknown | conditions |
| redfish.leak_detector.detector_state | Leak Detector State | ok, warning, critical, unavailable, absent, unknown | state |
| redfish.leak_detector.health | Leak Detector Health | ok, warning, critical, unknown | state |
| redfish.leak_detector.health_rollup | Leak Detector Health Rollup | ok, warning, critical, unknown | state |
| redfish.leak_detector.state | Leak Detector State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.leak_detector_group.acquisition_state | Leak Detector Group Acquisition State | readable, unreadable, unknown | state |
| redfish.leak_detector_group.conditions | Leak Detector Group Conditions | ok, warning, critical, unknown | conditions |
| redfish.leak_detector_group.health | Leak Detector Group Health | ok, warning, critical, unknown | state |
| redfish.leak_detector_group.health_rollup | Leak Detector Group Health Rollup | ok, warning, critical, unknown | state |
| redfish.leak_detector_group.state | Leak Detector Group State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.pump.acquisition_state | Pump Acquisition State | readable, unreadable, unknown | state |
| redfish.pump.conditions | Pump Conditions | ok, warning, critical, unknown | conditions |
| redfish.pump.health | Pump Health | ok, warning, critical, unknown | state |
| redfish.pump.health_rollup | Pump Health Rollup | ok, warning, critical, unknown | state |
| redfish.pump.state | Pump State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.thermal_subsystem.acquisition_state | Thermal Subsystem Acquisition State | readable, unreadable, unknown | state |
| redfish.thermal_subsystem.conditions | Thermal Subsystem Conditions | ok, warning, critical, unknown | conditions |
| redfish.thermal_subsystem.health | Thermal Subsystem Health | ok, warning, critical, unknown | state |
| redfish.thermal_subsystem.health_rollup | Thermal Subsystem Health Rollup | ok, warning, critical, unknown | state |
| redfish.thermal_subsystem.state | Thermal Subsystem State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.battery.acquisition_state | Battery Acquisition State | readable, unreadable, unknown | state |
| redfish.battery.c_rate | Battery C-rate | rate | ratio |
| redfish.battery.charge_capacity | Battery Charge Capacity | actual | ampere-hours |
| redfish.battery.charge_state | Battery Charge State | idle, charging, discharging, unknown | state |
| redfish.battery.conditions | Battery Conditions | ok, warning, critical, unknown | conditions |
| redfish.battery.e_rate | Battery E-rate | rate | ratio |
| redfish.battery.energy_capacity | Battery Energy Capacity | actual | watt-hours |
| redfish.battery.health | Battery Health | ok, warning, critical, unknown | state |
| redfish.battery.health_rollup | Battery Health Rollup | ok, warning, critical, unknown | state |
| redfish.battery.metrics_health | Battery Metrics Health | ok, warning, critical, unknown | state |
| redfish.battery.metrics_health_rollup | Battery Metrics Health Rollup | ok, warning, critical, unknown | state |
| redfish.battery.metrics_state | Battery Metrics State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.battery.state | Battery State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.power_subsystem.acquisition_state | Power Subsystem Acquisition State | readable, unreadable, unknown | state |
| redfish.power_subsystem.capacity | Power Subsystem Capacity | allocated, requested | watts |
| redfish.power_subsystem.conditions | Power Subsystem Conditions | ok, warning, critical, unknown | conditions |
| redfish.power_subsystem.health | Power Subsystem Health | ok, warning, critical, unknown | state |
| redfish.power_subsystem.health_rollup | Power Subsystem Health Rollup | ok, warning, critical, unknown | state |
| redfish.power_subsystem.state | Power Subsystem State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.power_supply.acquisition_state | Power Supply Acquisition State | readable, unreadable, unknown | state |
| redfish.power_supply.conditions | Power Supply Conditions | ok, warning, critical, unknown | conditions |
| redfish.power_supply.health | Power Supply Health | ok, warning, critical, unknown | state |
| redfish.power_supply.health_rollup | Power Supply Health Rollup | ok, warning, critical, unknown | state |
| redfish.power_supply.line_input_status | Power Supply Line Input Status | normal, loss_of_input, out_of_range, unknown | state |
| redfish.power_supply.metrics_health | Power Supply Metrics Health | ok, warning, critical, unknown | state |
| redfish.power_supply.metrics_health_rollup | Power Supply Metrics Health Rollup | ok, warning, critical, unknown | state |
| redfish.power_supply.metrics_state | Power Supply Metrics State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.power_supply.state | Power Supply State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.drive.acquisition_state | Drive Acquisition State | readable, unreadable, unknown | state |
| redfish.drive.conditions | Drive Conditions | ok, warning, critical, unknown | conditions |
| redfish.drive.error_rate | Drive Error Rate | correctable_read, correctable_write, uncorrectable_read, uncorrectable_write, bad_blocks | errors/s |
| redfish.drive.failure_predicted | Drive Failure Prediction | clear, predicted, unknown | state |
| redfish.drive.health | Drive Health | ok, warning, critical, unknown | state |
| redfish.drive.health_rollup | Drive Health Rollup | ok, warning, critical, unknown | state |
| redfish.drive.io | Drive I/O | read, written | bytes/s |
| redfish.drive.link_speed | Drive Link Speed | negotiated | bit/s |
| redfish.drive.media_life | Drive Media Life | remaining | percentage |
| redfish.drive.nvme.busy_time | Drive NVMe Busy Time | busy | percentage |
| redfish.drive.nvme.commands | Drive NVMe Commands | read, written | commands/s |
| redfish.drive.nvme.critical_warnings | Drive NVMe Critical Warnings | media_read_only, subsystem_degraded, pmr_unreliable, power_backup_failed, spare_capacity_worn_out, namespaces_read_only, reliability_degraded, spare_capacity_under_threshold | flags |
| redfish.drive.nvme.error_rate | Drive NVMe Error Rate | media_integrity, error_log_entries | errors/s |
| redfish.drive.nvme.event_rate | Drive NVMe Event Rate | unsafe_shutdowns, power_cycles | events/s |
| redfish.drive.nvme.io | Drive NVMe I/O | read, written | bytes/s |
| redfish.drive.nvme.spare | Drive NVMe Spare | available | percentage |
| redfish.drive.nvme.temperature | Drive NVMe Temperature | composite | Celsius |
| redfish.drive.nvme.thermal_time | Drive NVMe Thermal Time | warning, critical, management_1, management_2 | percentage |
| redfish.drive.nvme.thermal_transition_rate | Drive NVMe Thermal Transition Rate | management_1, management_2 | transitions/s |
| redfish.drive.nvme.wear | Drive NVMe Wear | used | percentage |
| redfish.drive.queue_depth | Drive Queue Depth | commands | commands |
| redfish.drive.state | Drive State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.drive.status_indicator | Drive Status Indicator | ok, fail, rebuild, predictive_failure_analysis, hotspare, in_a_critical_array, in_a_failed_array, unknown | state |
| redfish.storage.acquisition_state | Storage Acquisition State | readable, unreadable, unknown | state |
| redfish.storage.conditions | Storage Conditions | ok, warning, critical, unknown | conditions |
| redfish.storage.health | Storage Health | ok, warning, critical, unknown | state |
| redfish.storage.health_rollup | Storage Health Rollup | ok, warning, critical, unknown | state |
| redfish.storage.io | Storage I/O | read, written | bytes/s |
| redfish.storage.iops | Storage IOPS | read, written, read_hit, write_hit, non_io | requests/s |
| redfish.storage.state | Storage State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.storage.state_change_rate | Storage State Change Rate | changes | changes/s |
| redfish.storage_controller.acquisition_state | Storage Controller Acquisition State | readable, unreadable, unknown | state |
| redfish.storage_controller.cache_health | Storage Controller Cache Health | ok, warning, critical, unknown | state |
| redfish.storage_controller.cache_health_rollup | Storage Controller Cache Health Rollup | ok, warning, critical, unknown | state |
| redfish.storage_controller.cache_state | Storage Controller Cache State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.storage_controller.conditions | Storage Controller Conditions | ok, warning, critical, unknown | conditions |
| redfish.storage_controller.error_rate | Storage Controller Error Rate | correctable_ecc, correctable_parity, uncorrectable_ecc, uncorrectable_parity | errors/s |
| redfish.storage_controller.health | Storage Controller Health | ok, warning, critical, unknown | state |
| redfish.storage_controller.health_rollup | Storage Controller Health Rollup | ok, warning, critical, unknown | state |
| redfish.storage_controller.nvme.busy_time | Storage Controller NVMe Busy Time | busy | percentage |
| redfish.storage_controller.nvme.commands | Storage Controller NVMe Commands | read, written | commands/s |
| redfish.storage_controller.nvme.critical_warnings | Storage Controller NVMe Critical Warnings | media_read_only, subsystem_degraded, pmr_unreliable, power_backup_failed, spare_capacity_worn_out, namespaces_read_only, reliability_degraded, spare_capacity_under_threshold | flags |
| redfish.storage_controller.nvme.error_rate | Storage Controller NVMe Error Rate | media_integrity, error_log_entries | errors/s |
| redfish.storage_controller.nvme.event_rate | Storage Controller NVMe Event Rate | unsafe_shutdowns, power_cycles | events/s |
| redfish.storage_controller.nvme.io | Storage Controller NVMe I/O | read, written | bytes/s |
| redfish.storage_controller.nvme.spare | Storage Controller NVMe Spare | available | percentage |
| redfish.storage_controller.nvme.temperature | Storage Controller NVMe Temperature | composite | Celsius |
| redfish.storage_controller.nvme.thermal_time | Storage Controller NVMe Thermal Time | warning, critical, management_1, management_2 | percentage |
| redfish.storage_controller.nvme.thermal_transition_rate | Storage Controller NVMe Thermal Transition Rate | management_1, management_2 | transitions/s |
| redfish.storage_controller.nvme.wear | Storage Controller NVMe Wear | used | percentage |
| redfish.storage_controller.pcie_lanes | Storage Controller PCIe Lanes | active | lanes |
| redfish.storage_controller.state | Storage Controller State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.storage_controller.state_change_rate | Storage Controller State Change Rate | changes | changes/s |
| redfish.volume.acquisition_state | Volume Acquisition State | readable, unreadable, unknown | state |
| redfish.volume.conditions | Volume Conditions | ok, warning, critical, unknown | conditions |
| redfish.volume.error_rate | Volume Error Rate | correctable_read, correctable_write, uncorrectable_read, uncorrectable_write, consistency_check, rebuild | errors/s |
| redfish.volume.event_rate | Volume Event Rate | consistency_checks, state_changes | events/s |
| redfish.volume.health | Volume Health | ok, warning, critical, unknown | state |
| redfish.volume.health_rollup | Volume Health Rollup | ok, warning, critical, unknown | state |
| redfish.volume.io | Volume I/O | read, written | bytes/s |
| redfish.volume.io_time | Volume I/O Time | read, written, non_io | percentage |
| redfish.volume.iops | Volume IOPS | read, written, read_hit, write_hit, non_io | requests/s |
| redfish.volume.remaining_capacity | Volume Remaining Capacity | remaining | percentage |
| redfish.volume.space_savings | Volume Space Savings | compression, deduplication, thin_provisioning | bytes |
| redfish.volume.state | Volume State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.volume.write_cache_state | Volume Write Cache State | unprotected, protected, degraded, unknown | state |
| redfish.ethernet_interface.acquisition_state | Ethernet Interface Acquisition State | readable, unreadable, unknown | state |
| redfish.ethernet_interface.conditions | Ethernet Interface Conditions | ok, warning, critical, unknown | conditions |
| redfish.ethernet_interface.health | Ethernet Interface Health | ok, warning, critical, unknown | state |
| redfish.ethernet_interface.health_rollup | Ethernet Interface Health Rollup | ok, warning, critical, unknown | state |
| redfish.ethernet_interface.link_speed | Ethernet Interface Link Speed | speed | bit/s |
| redfish.ethernet_interface.link_status | Ethernet Interface Link Status | link_up, no_link, link_down, unknown | state |
| redfish.ethernet_interface.state | Ethernet Interface State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.network_adapter.acquisition_state | Network Adapter Acquisition State | readable, unreadable, unknown | state |
| redfish.network_adapter.conditions | Network Adapter Conditions | ok, warning, critical, unknown | conditions |
| redfish.network_adapter.cpu_utilization | Network Adapter CPU Utilization | cpu | percentage |
| redfish.network_adapter.frames | Network Adapter Frame Rate | received_unicast, received_multicast, sent_unicast, sent_multicast | frames/s |
| redfish.network_adapter.health | Network Adapter Health | ok, warning, critical, unknown | state |
| redfish.network_adapter.health_rollup | Network Adapter Health Rollup | ok, warning, critical, unknown | state |
| redfish.network_adapter.host_bus_utilization | Network Adapter Host Bus Utilization | received, sent | percentage |
| redfish.network_adapter.ncsi_frames | Network Adapter NCSI Frame Rate | received, sent | frames/s |
| redfish.network_adapter.ncsi_traffic | Network Adapter NCSI Traffic | received, sent | bytes/s |
| redfish.network_adapter.state | Network Adapter State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.network_adapter.traffic | Network Adapter Traffic | received, sent | bytes/s |
| redfish.network_device_function.acquisition_state | Network Device Function Acquisition State | readable, unreadable, unknown | state |
| redfish.network_device_function.conditions | Network Device Function Conditions | ok, warning, critical, unknown | conditions |
| redfish.network_device_function.frames | Network Device Function Frame Rate | received, sent, received_unicast, sent_unicast, received_multicast, sent_multicast | frames/s |
| redfish.network_device_function.health | Network Device Function Health | ok, warning, critical, unknown | state |
| redfish.network_device_function.health_rollup | Network Device Function Health Rollup | ok, warning, critical, unknown | state |
| redfish.network_device_function.queue_depth | Network Device Function Queue Depth | received, sent | percentage |
| redfish.network_device_function.queue_empty_state | Network Device Function Empty Queue State | received, sent | flags |
| redfish.network_device_function.queue_full | Network Device Function Full Queues | received, sent | queues |
| redfish.network_device_function.state | Network Device Function State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.network_device_function.traffic | Network Device Function Traffic | received, sent | bytes/s |
| redfish.network_interface.acquisition_state | Network Interface Acquisition State | readable, unreadable, unknown | state |
| redfish.network_interface.conditions | Network Interface Conditions | ok, warning, critical, unknown | conditions |
| redfish.network_interface.health | Network Interface Health | ok, warning, critical, unknown | state |
| redfish.network_interface.health_rollup | Network Interface Health Rollup | ok, warning, critical, unknown | state |
| redfish.network_interface.state | Network Interface State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.network_port.acquisition_state | Network Port Acquisition State | readable, unreadable, unknown | state |
| redfish.network_port.conditions | Network Port Conditions | ok, warning, critical, unknown | conditions |
| redfish.network_port.health | Network Port Health | ok, warning, critical, unknown | state |
| redfish.network_port.health_rollup | Network Port Health Rollup | ok, warning, critical, unknown | state |
| redfish.network_port.link_speed | Network Port Link Speed | speed | bit/s |
| redfish.network_port.link_status | Network Port Link Status | down, up, starting, training, unknown | state |
| redfish.network_port.signal_detected | Network Port Signal Detected | clear, detected, unknown | state |
| redfish.network_port.state | Network Port State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.pcie_device.acquisition_state | PCIe Device Acquisition State | readable, unreadable, unknown | state |
| redfish.pcie_device.conditions | PCIe Device Conditions | ok, warning, critical, unknown | conditions |
| redfish.pcie_device.health | PCIe Device Health | ok, warning, critical, unknown | state |
| redfish.pcie_device.health_rollup | PCIe Device Health Rollup | ok, warning, critical, unknown | state |
| redfish.pcie_device.link_width | PCIe Device Link Width | active | lanes |
| redfish.pcie_device.state | PCIe Device State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.pcie_function.acquisition_state | PCIe Function Acquisition State | readable, unreadable, unknown | state |
| redfish.pcie_function.conditions | PCIe Function Conditions | ok, warning, critical, unknown | conditions |
| redfish.pcie_function.health | PCIe Function Health | ok, warning, critical, unknown | state |
| redfish.pcie_function.health_rollup | PCIe Function Health Rollup | ok, warning, critical, unknown | state |
| redfish.pcie_function.state | PCIe Function State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.port.acquisition_state | Port Acquisition State | readable, unreadable, unknown | state |
| redfish.port.conditions | Port Conditions | ok, warning, critical, unknown | conditions |
| redfish.port.error_rate | Port Error Rate | received, sent | errors/s |
| redfish.port.frames | Port Frame Rate | received, sent, received_unicast, sent_unicast, received_multicast, sent_multicast, received_broadcast, sent_broadcast | frames/s |
| redfish.port.health | Port Health | ok, warning, critical, unknown | state |
| redfish.port.health_rollup | Port Health Rollup | ok, warning, critical, unknown | state |
| redfish.port.link_speed | Port Link Speed | speed | bit/s |
| redfish.port.link_state | Port Link State | enabled, disabled, unknown | state |
| redfish.port.link_status | Port Link Status | link_up, starting, training, link_down, no_link, unknown | state |
| redfish.port.link_width | Port Link Width | active | lanes |
| redfish.port.network_error_rate | Port Network Error Rate | received_discards, sent_discards, received_fcs, received_false_carrier, received_alignment, received_oversize, received_undersize, sent_excessive_collisions, sent_late_collisions, sent_multiple_collisions, sent_single_collisions | errors/s |
| redfish.port.pcie_drop_rate | Port PCIe Drop Rate | completion_credit, non_posted_credit, tag_unavailable | drops/s |
| redfish.port.pcie_error_rate | Port PCIe Error Rate | bad_dllp, bad_tlp, correctable, fatal, flow_control_timeout, l0_to_recovery, nak_received, nak_sent, non_fatal, replay, replay_rollover, unsupported_request | errors/s |
| redfish.port.pcie_tlp_rate | Port PCIe TLP Rate | completion, read, write | packets/s |
| redfish.port.pcie_traffic | Port PCIe Traffic | completion, read, write | bytes/s |
| redfish.port.rdma_error_rate | Port RDMA Error Rate | protection, protocol | errors/s |
| redfish.port.rdma_traffic | Port RDMA Traffic | received, sent | bytes/s |
| redfish.port.signal_detected | Port Signal Detected | clear, detected, unknown | state |
| redfish.port.state | Port State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.port.traffic | Port Traffic | received, sent | bytes/s |
| redfish.assembly.acquisition_state | Assembly Acquisition State | readable, unreadable, unknown | state |
| redfish.assembly.conditions | Assembly Conditions | ok, warning, critical, unknown | conditions |
| redfish.assembly.health | Assembly Health | ok, warning, critical, unknown | state |
| redfish.assembly.health_rollup | Assembly Health Rollup | ok, warning, critical, unknown | state |
| redfish.assembly.state | Assembly State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.firmware.acquisition_state | Firmware Acquisition State | readable, unreadable, unknown | state |
| redfish.firmware.conditions | Firmware Conditions | ok, warning, critical, unknown | conditions |
| redfish.firmware.health | Firmware Health | ok, warning, critical, unknown | state |
| redfish.firmware.health_rollup | Firmware Health Rollup | ok, warning, critical, unknown | state |
| redfish.firmware.state | Firmware State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.manager.acquisition_state | Manager Acquisition State | readable, unreadable, unknown | state |
| redfish.manager.clock_offset | Manager Clock Offset | offset | seconds |
| redfish.manager.conditions | Manager Conditions | ok, warning, critical, unknown | conditions |
| redfish.manager.health | Manager Health | ok, warning, critical, unknown | state |
| redfish.manager.health_rollup | Manager Health Rollup | ok, warning, critical, unknown | state |
| redfish.manager.power_state | Manager Power State | on, off, powering_on, powering_off, paused, unknown | state |
| redfish.manager.state | Manager State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
| redfish.software.acquisition_state | Software Acquisition State | readable, unreadable, unknown | state |
| redfish.software.conditions | Software Conditions | ok, warning, critical, unknown | conditions |
| redfish.software.health | Software Health | ok, warning, critical, unknown | state |
| redfish.software.health_rollup | Software Health Rollup | ok, warning, critical, unknown | state |
| redfish.software.state | Software State | enabled, disabled, standby_offline, standby_spare, in_test, starting, absent, unavailable_offline, deferring, quiesced, updating, qualified, degraded, unknown | state |
Per reading
One physical sensor reading or source-provided measurement excerpt.
Labels:
| Label | Description |
|---|---|
| endpoint_key | Stable canonical endpoint key. |
| resource_key | Stable identity of the resource supplying the reading. |
| resource_kind | Kind of the resource supplying the reading. |
| resource_name | Resource supplying the reading. |
| slot | Slot, device locator, or socket of the supplying resource, when reported. |
| location | Service label of the supplying resource's physical location, when reported. |
| manufacturer | Manufacturer of the supplying resource, when reported. |
| model | Model of the supplying resource, when reported. |
| reading_key | Stable reading identity within the endpoint. |
| reading_type | Reading type, such as temperature or voltage. |
| physical_context | Redfish physical context of the sensor, when reported. |
| physical_subcontext | Redfish physical sub-context of the sensor, when reported. |
| reading_basis | Zero, delta, or headroom measurement basis. |
| reading_role | Current, average, minimum, or peak reading. |
Metrics:
| Metric | Description | Dimensions | Unit |
|---|---|---|---|
| redfish.reading.percentage | Percentage Readings | value | percentage |
| redfish.reading.alarm | Redfish Reading Source Health State | clear, warning, critical | state |
| redfish.reading.derived_health | Redfish Reading Derived Health (Thresholds) | ok, warning, critical | state |
| redfish.reading.absolute_humidity | Absolute Humidity Readings | value | grams/cubic-meter |
| redfish.reading.air_flow | Air Flow Readings | value | cubic-meters/minute |
| redfish.reading.altitude | Altitude Readings | value | meters |
| redfish.reading.barometric_pressure | Barometric Pressure Readings | value | pascals |
| redfish.reading.heat | Heat Readings | value | watts |
| redfish.reading.humidity | Relative Humidity Readings | value | percentage |
| redfish.reading.linear_acceleration | Linear Acceleration Readings | value | meters/second2 |
| redfish.reading.linear_position | Linear Position Readings | value | meters |
| redfish.reading.linear_velocity | Linear Velocity Readings | value | meters/second |
| redfish.reading.liquid_flow | Liquid Flow Readings | value | liters/minute |
| redfish.reading.liquid_level | Liquid Level Readings | value | meters |
| redfish.reading.pressure | Pressure Readings | value | pascals |
| redfish.reading.rotational_acceleration | Rotational Acceleration Readings | value | radians/second2 |
| redfish.reading.rotational_position | Rotational Position Readings | value | radians |
| redfish.reading.rotational_speed | Rotational Speed Readings | value | RPM |
| redfish.reading.rotational_velocity | Rotational Velocity Readings | value | radians/second |
| redfish.reading.temperature | Temperature Readings | value | Celsius |
| redfish.reading.valve_position | Valve Position Readings | value | percentage |
| redfish.reading.apparent_energy | Apparent Energy Readings | value | joule-equivalent |
| redfish.reading.apparent_power | Apparent Power Readings | value | volt-amperes |
| redfish.reading.charge | Charge Readings | value | ampere-hours |
| redfish.reading.crest_factor | Crest Factor Readings | value | ratio |
| redfish.reading.current | Current Readings | value | amperes |
| redfish.reading.energy | Energy Readings | value | joules |
| redfish.reading.frequency | Frequency Readings | value | hertz |
| redfish.reading.harmonic_distortion | Harmonic Distortion Readings | value | percentage |
| redfish.reading.phase_angle | Phase Angle Readings | value | degrees |
| redfish.reading.power | Power Readings | value | watts |
| redfish.reading.power_factor | Power Factor Readings | value | ratio |
| redfish.reading.reactive_energy | Reactive Energy Readings | value | joule-equivalent |
| redfish.reading.reactive_power | Reactive Power Readings | value | vars |
| redfish.reading.stored_energy | Stored Energy Readings | value | watt-hours |
| redfish.reading.voltage | Voltage Readings | value | volts |
Live Data
Inspect one configured endpoint's latest sensor readings, hardware health, and BMC-retained events, selected with
the Instance parameter. Sensors and Hardware show the latest completed collection and do not query the BMC when
you open them, so a row can be up to one update_every (60 seconds by default) plus that collection's duration
old; the Observed column is the start time of that collection and is the same for every row. Logs queries the
BMC on demand.
Redfish Sensors
Inspect current sensor readings beside the health the BMC reports and an independently derived threshold health, so a crossed limit can be told apart from a fault the BMC has declared. The table holds one row per sensor with its current reading; the average, peak, and threshold values a sensor also publishes are not rows here (they appear on the charts), and power derived from energy is labeled as such. Derived health reads OK when none of that sensor's own upper and lower limits is active (the BMC may still report other faults), Not applicable when the sensor publishes no limits, and Unavailable when the published limits cannot be used, the reading itself is unavailable, or too few readings have arrived to decide.
| Aspect | Description |
|---|---|
| Name | Redfish:sensors |
| Require Cloud | no |
| Performance | Reads data already collected by the job; no additional BMC requests. Response size grows with the number of rows. |
| Security | Exposes device identity, health and source resource addresses to authorized operators. Does not expose credentials or session tokens. |
| Availability | Available after collection produces usable data. Returns HTTP 503 before the first collection and after a total failure. Partial collections retain current rows and mark gaps. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| Instance | select | Select the configured Redfish endpoint job. | no | First available job |
Returns
One row per supported primary reading from the current collection. Missing or invalid values are blank; missing health is Not reported.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| Key | string | hidden | Stable row identity. | |
| Sort | string | hidden | Attention, name and identity ordering. | |
| Sensor | string | Sensor or component reading. | ||
| Type | string | Measured quantity. | ||
| Reading | float | Current value; blank when unavailable. | ||
| Units | string | Reading units. | ||
| Health | string | BMC-reported health of this reading; not inherited component health. | ||
| Derived health (thresholds) | string | Locally evaluated threshold status; OK does not imply overall hardware health. | ||
| Data availability | string | Whether this reading has a usable value. | ||
| Observed | timestamp | Collection observation time; not the BMC's internal sampling time. | ||
| Resource | string | hidden | Resource supplying this reading. | |
| Resource URI | string | hidden | Source resource address. | |
| Source property | string | hidden | Source reading property. | |
| Location | string | hidden | BMC-reported physical context. | |
| Source | string | hidden | Whether this value was reported or calculated. | |
| rowOptions | none | hidden | Row presentation. |
Redfish Hardware
Find components needing attention and inspect their identity, configuration and reported condition. Optional columns show CPU counts, memory and storage capacity, firmware release dates and assembly revisions. Component health, aggregate health and collection availability are kept distinct.
| Aspect | Description |
|---|---|
| Name | Redfish:hardware |
| Require Cloud | no |
| Performance | Reads data already collected by the job; no additional BMC requests. Response size grows with the number of rows. |
| Security | Exposes device identity, health and source resource addresses to authorized operators. Does not expose credentials or session tokens. |
| Availability | Available after collection produces usable data. Returns HTTP 503 before the first collection and after a total failure. Partial collections retain current rows and mark gaps. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| Instance | select | Select the configured Redfish endpoint job. | no | First available job |
Returns
One row per monitored component or logical resource, including known resources that could not be read. Identity, configuration and version details are optional columns populated when reported by the BMC. Capacity belongs to the individual resource; physical drives and logical volumes must not be added together. Release date describes the firmware or software release, not its installation. Missing or unusable details are blank.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| Key | string | hidden | Stable row identity. | |
| Sort | string | hidden | Attention, name and identity ordering. | |
| Component | string | Component or logical resource name. | ||
| Type | string | Resource kind. | ||
| Health | string | BMC-reported health of this component. | ||
| State | string | BMC-reported operational state. | ||
| Location | string | BMC-reported location or slot. | ||
| Reported issue | string | BMC conditions, rollup warnings or predicted failure. | ||
| Data availability | string | Whether this component was read in this collection. | ||
| Observed | timestamp | Collection observation time; not the BMC's internal sampling time. | ||
| Manufacturer | string | hidden | Component manufacturer. | |
| Model | string | hidden | Component model. | |
| Serial number | string | hidden | Component serial number. | |
| Part number | string | hidden | Component part number. | |
| Asset tag | string | hidden | Component asset tag. | |
| Firmware | string | hidden | Firmware, software or BIOS version. | |
| Power state | string | hidden | BMC-reported power state. | |
| Health rollup | string | hidden | BMC-reported aggregate health, separate from component health. | |
| Failure predicted | boolean | hidden | BMC predicts component failure. | |
| Resource URI | string | hidden | Source resource address. | |
| Processor cores | integer | cores | hidden | Total cores in this processor. |
| Enabled cores | integer | cores | hidden | Enabled cores in this processor. |
| Supported threads | integer | threads | hidden | Execution threads supported by this processor. |
| Capacity | integer | bytes | hidden | Capacity of this memory device, physical drive or logical volume. Memory capacity is converted from MiB to bytes. |
| Memory type | string | hidden | Memory device technology, such as DDR4 or DDR5. | |
| Media type | string | hidden | Drive media type, such as SSD or HDD. | |
| Drive protocol | string | hidden | Protocol used by this drive, such as SAS, SATA or NVMe. | |
| RAID type | string | hidden | RAID configuration of this logical volume. | |
| Release date | timestamp | hidden | Firmware or software release/production date; not installation time. | |
| Hardware version | string | hidden | Vendor-reported hardware version of this assembly. | |
| Engineering revision | string | hidden | Engineering change level or revision of this assembly. | |
| rowOptions | none | hidden | Row presentation. |
Redfish Logs
Browse events currently retained by one BMC log service in the Logs view. Select the endpoint job and a service linked from its Systems, Managers or Chassis. Refresh reads the log again; BMC rotation or clearing can remove events. This viewer does not store an archive.
| Aspect | Description |
|---|---|
| Name | Redfish:logs |
| Require Cloud | no |
| Performance | Each query discovers linked services and reads every page and entry of the selected log before filtering. There is no event cap; cost grows with BMC retention and pagination. Reads share the job's max_concurrent_requests budget with metrics. The default UI refresh is 60 seconds. Slow full scans can fail at the Function deadline; narrow time or text filters do not reduce BMC reads. |
| Security | Uses the job's existing credentials, TLS and proxy settings. Reading logs requires BMC permissions for the linked services and entries. Queries are read-only apart from creating and deleting their authentication sessions. Event messages may contain sensitive operational information; credentials and session tokens are not returned. |
| Availability | Available for running jobs without waiting for a successful metric poll. An empty service selector means no supported linked services were advertised. Missing Entries support and inaccessible services return an error; an empty readable log returns an empty table. The view has no histogram, live tail or historical archive, and a multi-page read is not an atomic snapshot. |
Prerequisites
No additional configuration is required.
Parameters
| Parameter | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| Instance | select | Select the configured Redfish endpoint job. | no | First available job | |
| Log service | select | Select a linked service advertised by this endpoint. | yes | First advertised service in the UI | |
| Severity | select | Filter by BMC severity. Unknown includes missing and unrecognized values. | no | all | All severities (default), Critical, Warning, OK, Unknown |
| After | integer | Inclusive lower time boundary in integer Unix seconds. A negative value is relative to before, or to now when before is omitted. | no | No lower boundary | |
| Before | integer | Inclusive upper time boundary in integer Unix seconds. Zero or a negative value is relative to now. | no | No upper boundary | |
| Search | string | Case-sensitive Netdata simple patterns against the combined message, IDs, resource addresses, entry type and reported severity. Use *failure* for a substring. Space-separated patterns are checked in order; the first match decides, ! excludes, and no match excludes the row. Use !*noise* * to exclude noise and keep everything else. | no | No text filter |
Returns
One row per matching retained entry. Time uses EventTimestamp, then valid Created. Both originals and the time basis remain available in details. Undated entries remain visible as Unavailable after dated rows, with a notice that the time range cannot filter them. Refresh replaces all rows. Failed pages or members fail the request instead of returning a partial log as complete.
| Column | Type | Unit | Visibility | Description |
|---|---|---|---|---|
| Order | integer | hidden | Newest first, then undated entries; row position within this query. | |
| Time | timestamp | EventTimestamp with valid Created fallback; Unavailable when neither can be used. | ||
| Severity | string | OK, Warning, Critical or Unknown. | ||
| Message | string | BMC event message. | ||
| Entry ID | string | Identifier assigned by this log service. | ||
| Entry type | string | hidden | BMC event format. | |
| Log service | string | hidden | Selected source resource. | |
| Entry URI | string | hidden | Source entry resource. | |
| Message ID | string | hidden | BMC message registry identifier. | |
| EventTimestamp | string | hidden | Original event time, including invalid source values. | |
| Created | string | hidden | Original entry creation time, including invalid source values. | |
| Time basis | string | hidden | EventTimestamp, Created or Unavailable. | |
| Reported severity | string | hidden | Original severity, including unrecognized source values. | |
| rowOptions | none | hidden | Row presentation. |
Troubleshooting
Diagnostics
Debug Mode
Important: Debug mode is not supported for data collection jobs created via the UI using the Dyncfg feature.
To troubleshoot issues with the redfish collector, run the go.d.plugin with the debug option enabled. The output
should give you clues as to why the collector isn't working.
-
Navigate to the
plugins.ddirectory, usually at/usr/libexec/netdata/plugins.d/. If that's not the case on your system, opennetdata.confand look for thepluginssetting under[directories].cd /usr/libexec/netdata/plugins.d/ -
Switch to the
netdatauser.sudo -u netdata -s -
Run the
go.d.pluginto debug the collector:./go.d.plugin -d -m redfishTo debug a specific job:
./go.d.plugin -d -m redfish -j jobName
Getting Logs
If you're encountering problems with the redfish collector, follow these steps to retrieve logs and identify potential issues:
- Run the command specific to your system (systemd, non-systemd, or Docker container).
- Examine the output for any warnings or error messages that might indicate issues. These messages should provide clues about the root cause of the problem.
System with systemd
Use the following command to view logs generated since the last Netdata service restart:
journalctl _SYSTEMD_INVOCATION_ID="$(systemctl show --value --property=InvocationID netdata)" --namespace=netdata --grep redfish
System without systemd
Locate the collector log file, typically at /var/log/netdata/collector.log, and use grep to filter for collector's name:
grep redfish /var/log/netdata/collector.log
Note: This method shows logs from all restarts. Focus on the latest entries for troubleshooting current issues.
Docker Container
If your Netdata runs in a Docker container named "netdata" (replace if different), use this command:
docker logs netdata 2>&1 | grep redfish
Known Errors
config validation: 'username' and 'password' are required for auth_method "<method>"
When
At job start, with auth_method set to auto, session, or basic.
Cause
Only these three modes send credentials, and both username and password must be set for them. The
message also appears the other way round (must be empty for auth_method "none") when credentials are
left in place after switching a job to none.
Fix
Set both fields, or switch auth_method to none for an endpoint that takes no credentials. Values may
be secret references such as ${file:/etc/netdata/redfish-password} rather than literals.
ServiceRoot has no RedfishVersion
When
At job start or on the first collection, after the URL responded.
Cause
The address answered, but what it returned is not a Redfish ServiceRoot. Usually url points at the BMC's
web UI, a load balancer, or a captive portal rather than at the Redfish service.
Fix
Point url at the service origin or its ServiceRoot path — https://<bmc-address> or
https://<bmc-address>/redfish/v1/. Confirm with
curl -k https://<bmc-address>/redfish/v1/, which must return JSON containing RedfishVersion.
Redfish endpoint check: Redfish TLS certificate verification failed
When
With an https:// URL and a BMC presenting a self-signed or internally issued certificate, or a
certificate issued for a different name than the one in url. During collection the same message
appears without the Redfish endpoint check: prefix.
Cause
The Agent host does not trust the certificate authority that signed the BMC's certificate, or the
certificate does not cover the address in url. Most BMCs ship with a self-signed certificate. The
collector logs this summary rather than the underlying TLS error text.
Fix
Point tls_ca at the CA bundle that signed the certificate, or install that CA in the Agent host's trust
store; for a name mismatch, use the address the certificate was issued for. tls_skip_verify: true will
also connect, but it accepts any certificate and leaves the session open to interception — use it to
confirm the diagnosis, not as the permanent setting.
The job starts and passes its check, then collects nothing
When
With auth_method set to auto or session.
Cause
In these modes the configuration test identifies the endpoint without opening a session, so it succeeds before the credentials are ever used. They are validated when collection starts.
Fix
Check the username and password, and that the BMC account may read the systems, chassis, managers,
sensors, and storage you expect. auth_method: basic exercises the credentials on every request and
fails more visibly while you are diagnosing.
Collection takes as long as, or longer than, the interval
Cause
The endpoint exposes more components than it can serve within update_every. BMCs are frequently slow and
many serialize requests internally, so the walk cannot be shortened by concurrency alone. The collector
publishes what it finished and starts fresh at the next interval, leaving gaps on some charts.
Fix
Raise update_every, narrow collect to the areas you need, or lower max_concurrent_requests for a
controller that degrades under parallel load. Raise timeout only when individual responses genuinely
need longer.
A component or reading is missing from the charts
Cause
The collector reads standard Redfish properties only; vendor-specific OEM extensions are skipped. A BMC
may also omit a property, or expose it in a shape the standard schemas do not describe. Its area may also
be excluded by collect.
Fix
Check collect covers the area first. If it does, report the vendor, model, and firmware version with a
sanitized payload from the affected resource so support can be added.
Do you have any feedback for this page? If so, you can open a new issue on our netdata/learn repository.