Package org.metricshub.ipmi.client

Class IpmiClient

java.lang.Object

org.metricshub.ipmi.client.IpmiClient

public class IpmiClient
extends Object

This class is the entry point of the IPMI Client library

Method Summary

Modifier and Type	Method	Description
static GetChassisStatusResponseData	getChassisStatus(IpmiClientConfiguration ipmiConfiguration)	Run the get Chassis status IPMI request
static String	getChassisStatusAsStringResult(IpmiClientConfiguration ipmiConfiguration)	Run the get Chassis status IPMI request then convert the result to String
static List<Fru>	getFrus(IpmiClientConfiguration ipmiConfiguration)	Get FRU information
static String	getFrusAndSensorsAsStringResult(IpmiClientConfiguration ipmiConfiguration)	Run the FRUs and Sensors request then convert the result to a String value
static List<Sensor>	getSensors(IpmiClientConfiguration ipmiConfiguration)	Get the sensors

Methods inherited from class java.lang.Object

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

Method Details

getChassisStatus

public static GetChassisStatusResponseData getChassisStatus(IpmiClientConfiguration ipmiConfiguration)
                                                     throws InterruptedException,
ExecutionException,
TimeoutException

Run the get Chassis status IPMI request

Parameters:

ipmiConfiguration - Wraps the IPMI device hostname and the credentials

Returns:

GetChassisStatusResponseData instance

Throws:

InterruptedException

ExecutionException

TimeoutException

getSensors

public static List<Sensor> getSensors(IpmiClientConfiguration ipmiConfiguration)
                               throws InterruptedException,
ExecutionException,
TimeoutException

Get the sensors

Parameters:

ipmiConfiguration - Wraps the IPMI device hostname and the credentials

Returns:

List of Sensor instances

Throws:

InterruptedException

ExecutionException

TimeoutException

getFrus

public static List<Fru> getFrus(IpmiClientConfiguration ipmiConfiguration)
                         throws InterruptedException,
ExecutionException,
TimeoutException

Get FRU information

Parameters:

ipmiConfiguration - Wraps the IPMI device hostname and the credentials

Returns:

List of Fru instances

Throws:

InterruptedException

ExecutionException

TimeoutException

getChassisStatusAsStringResult

public static String getChassisStatusAsStringResult(IpmiClientConfiguration ipmiConfiguration)
                                             throws InterruptedException,
ExecutionException,
TimeoutException

Run the get Chassis status IPMI request then convert the result to String

Parameters:

ipmiConfiguration - Wraps the IPMI device hostname and the credentials

Returns:

Chassis status as String value

Throws:

TimeoutException

ExecutionException

InterruptedException

getFrusAndSensorsAsStringResult

public static String getFrusAndSensorsAsStringResult(IpmiClientConfiguration ipmiConfiguration)
                                              throws InterruptedException,
ExecutionException,
TimeoutException

Run the FRUs and Sensors request then convert the result to a String value

Parameters:

ipmiConfiguration - Wraps the IPMI device hostname and the credentials

Returns:

All sensors (FRUs, Sensors readings and Sensors states) as String value

Throws:

TimeoutException

ExecutionException

InterruptedException