Package org.metricshub.ipmi.client

Class SolRequest

java.lang.Object
org.metricshub.ipmi.client.SolRequest
public final class SolRequest extends Object
Opens a Serial over LAN console in the session of the client (IPMI 2.0 section 15). The BMC usually requires the Administrator privilege to activate the SOL payload: open the client with privilege(PrivilegeLevel.Administrator).

  • Method Details

    • timeout

      public SolRequest timeout(Duration deadline)
      Overrides the deadline of the client for the activation of the console.
      Parameters:
      deadline - the time the activation may take, session setup included
      Returns:
      this request

    • open

      public SolConsole open()
      Activates the SOL payload and opens the console.
      Returns:
      the console, to close when done: closing it deactivates the payload
      Throws:
      IpmiCompletionCodeException - when the BMC refuses the activation, for a lack of privilege for instance
      IpmiClientException - when the BMC offers no SOL payload instance, or the activation fails