Package org.metricshub.ipmi.client

Class FrusRequest

java.lang.Object

org.metricshub.ipmi.client.FrusRequest

public final class FrusRequest
extends Object

Reads the FRU inventories of the BMC: those that the FRU Device Locator records of the SDR repository point at, and the one of the system board.

Method Summary

Modifier and Type	Method	Description
FruList	execute()	Reads the selected FRUs.
FrusRequest	ids(int... deviceIds)	Reads only the FRUs with the given device IDs (0 is the system board on most BMCs).
FrusRequest	timeout(Duration deadline)	Overrides the deadline of the client for this request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

ids

public FrusRequest ids(int... deviceIds)

Reads only the FRUs with the given device IDs (0 is the system board on most BMCs).

Parameters:

deviceIds - the FRU device IDs to read

Returns:

this request

timeout

public FrusRequest timeout(Duration deadline)

Overrides the deadline of the client for this request.

Parameters:

deadline - the time the request may take, session setup included

Returns:

this request

execute

public FruList execute()

Reads the selected FRUs.

Returns:

the FRUs, in the order of their locator records; a FRU that could not be read entirely is returned with its problems

Throws:

IpmiClientException - when the repository cannot be read, or the BMC stops answering