All Classes and Interfaces
Class
Description
This abstract class implements common features required by FRUs, Sensor and Chassis Status runners.
An abstract wrapper class for Activate Payload Command.
Wrapper for Activate Payload response
Concrete implementation of
ActivatePayload command for PayloadType.SOL.Concrete implementation of
ActivatePayloadResponseData for PayloadType.SOL.Type of address behind Sensor Record's 'Sensor Owner ID' field.
GetChannelAuthenticationCapabilities response was received.Waiting for the
GetChannelAuthenticationCapabilities response.Interface for authentication algorithms.
Performs transition from
AuthcapWaiting to Authcap.RAKP-HMAC-SHA1 authentication algorithm.
RAKP-None authentication algorithm.
Available types of authentication.
Performs transition from
Authcap to OpenSessionWaiting.Base Compatibility Information record from FRU Multi Record Area
Represents unit which is used to access FRU
Deprecated.
This sensor record has been deprecated
FRU record containing Board info.
ByteBuffer is a wrapper for byte[], and allows to safely read and write from the buffer.Wrapper class for Chassis Control request.
Wrapper class for Chassis Control response.
Chassis Identify State.
FRU record containing Chassis info.
This area is used to hold Serial Number, Part Number, and other information about the system chassis.
This area is used to hold Serial Number, Part Number, and other information about the system chassis.
Specifies possible types of chassis.
State at which
CipherSuite that will be used during the session is
already picked.Provides cipher suite (authentication, confidentiality and integrity
algorithms used during the session).
Interface for
CipherSuite selection handler to choose among available CipherSuites returned by the server.State at which getting Channel Cipher Suites is in progress.
Wrapper for Close Session request
StateMachineEvent that will make StateMachine in the
SessionValid State to send
CloseSession and
transit to Authcap State the session.Wrapper for Close Session response
Contains command codes for IPMI commands Byte constants are encoded as pseudo
unsigned bytes.
Set of constants.
Wrapper for Compact Sensor Record format
AES-CBC-128 confidentiality algorithm
Interface for Confidentiality Algorithms.
Class representing no confidentiality algorithm.
A connection with the specific remote host.
Exception indicating that connecting to the remote machine failed.
Handle to the
ConnectionInterface for the
Connection listener.Manages multiple
ConnectionsHolds constants common for whole library.
DC output Information record from FRU Multi Record Area
This record is used to describe the maximum load that a device requires from a particular DC Output.
This record is used to describe the maximum load that a device requires from a particular DC Output.
DC output Information record from FRU Multi Record Area
A wrapper class for Deactivate Payload Command.
Enumeration of specific completion codes for
DeactivatePayload command.Wrapper for Deactivate Payload response
Decodes RMCP packet into
ResponseData.Test driver for Encoder/Decoder
Generic event that is used in a few transitions.
Default message for acknowledging received IPMI responses.
EntityId mapping to match the IPMIUtil C code.This record is the same as the
EntityAssociationRecord, except that
it supports describing associations between entities that have
device-relative Entity Instance values as well as system-relative values.Creates RMCP packet containing encrypted IPMI command from IPMICommand
wrapper class or raw byte data.
This record is used to present the relationship between entities that
contain, or are contained by, other entities.
The EntityID is used for identifying the physical entity that a sensor or
device is associated with.
Action representing an exception handed to the machine owner.
This record provides a mechanism to associate FRU and Entity information with
a physical or logical sensor that generates events, but cannot otherwise be
accessed.
Extended Compatibility Information record from FRU Multi Record Area
It seems to be the same as
It seems to be the same as
BaseCompatibilityInfo except of
ManagementAccessRecordType code.Wraps the Field Replaceable Unit information:
The FRU locator which contains the FRU location information.
The FRU records containing
BoardInfo, ChassisInfo and/or ProductInfo.
Wraps FRU device vendor, model and serial number
This record is used for locating FRU information that is on the IPMB, on a
Private Bus behind or management controller, or accessed via FRU commands to
a management controller.
Identifies type of the information stored in FRU's MultiRecord Area entry.
General class for FRU Inventory area records.
Wrapper class for Full Sensor Record format
This record is used to store the location and type information for devices on
the IPMB or management controller private busses that are neither IPMI FRU
devices nor IPMI management controllers.
Wrapper for Get Channel Authentication Capabilities request
A wrapper for Get Channel Authentication Capabilities command response
Wrapper for RMCP+ Get Channel Cipher Suites command.
Performed in
CiphersWaiting State indcates that not all
available CipherSuites were received from the remote system and more
GetChannelCipherSuites commands are needed.Wrapper for Get Channel Cipher Suites response
A wrapper class for Get Channel Payload Support Command.
Wrapper for Get Channel Payload Support response
Wrapper class for Get Chassis Status request.
Wrapper for Get Chassis Status response.
Get the Chassis Status runner
A wrapper class for Get FRU Inventory Area Info Command.
A wrapper for Get Fru Inventory Area Info response
Get FRU information
Wrapper for Get Payload Activation Status Command.
Wrapper for Get Payload Activation Status response.
Wrapper for Get SDR command.
A wrapper class for Get SDR Repository Info Command.
Wrapper for Get SDR Repository Info response.
Wrapper for Get SDR command response.
Wrapper for Get Sel Entry request
Wrapper for Get Sel Entry response
Wrapper class for Get SEL Info request.
Wrapper for Get SEL Info response
Wrapper for Get Sensor Reading request.
Wrapper for Get Sensor Reading response.
Get Full And Compact Sensor records
Returns the Session Integrity Key calculated after receiving RAKP Message 2.
Interface for incoming payloads.
Listener for inbound SOL messages sent by remote system to this application.
Interface for Integrity Algorithms.
HMAC-SHA1-96 integrity algorithm.
Class representing RAKP-None integrity algorithm
Asynchronous API for connecting to BMC via IPMI.
This class is the entry point of the IPMI Client library
IPMI configuration including the required credentials that need to be used to establish the
communication with the IPMI interface.
A wrapper for IPMI command.
Synchronous API for connecting to BMC via IPMI.
Decodes IPMI session header and retrieves encrypted payload.
Encodes IPMI message.
Class that wraps exception that was cause of not receiving message.
Set of constants.
A wrapper class for IPMI LAN message
A wrapper class for IPMB LAN message
A wrapper class for IPMB response message.
Wrapper class for IPMI message
Default implementation of
MessageHandler for IpmiLanMessages.Payload for IPMI messages
Interface for response messages delivered to
IpmiResponseListenersClass that wraps
ResponseData that was received successfully.Interface for listeners of
IpmiAsyncConnector.Wrapper for IPMI v.1.5 message
Wrapper class for IPMI v2.0 message
Describes IPMI version
An interface for listener of the
StateMachineManagement Access Information record from FRU Multi Record Area
This record can be used by utility software to record that a given controller
has been discovered in the system.
This information is used for identifying management controllers on the IPMB
and other internal channels, and for providing Entity and initialization
information for all management controllers, including the BMC.
Returns response to the unknown command (recognition is up to the higher
levels of the architecture) received in the
SessionValid state.Class used for composing byte messages aout from smaller byte subarrays.
Class used for handling outgoing and incoming messages for a
Connection.Listens to the
IpmiAsyncConnector waiting for concrete message to
arrive.Queues messages to send and checks for timeouts.
Class used for reading subsequent byte subarrays from message, that is also a byte array.
Low level connection handler.
Record from FRU Multi Record Area
IPMB network functions
OEM record from FRU Multi Record Area
OEM specific record.
Wrapper class for RMCP+ Open Session request.
Performs transition from
OpenSessionComplete to Rakp1Waiting.Indicates that
OpenSession response was received.A wrapper for Open Session command response
Waiting for the
Transition to
OpenSession response.Transition to
OpenSessionComplete on DefaultAck
Transition to Authcap on Timeout
Base class for
IpmiPayload coders, used for encoding pyloads inside IpmiMessages.Types of IPMI packet payload
Decodes IPMI session header and retrieves encrypted payload.
Represents IPMI payload fully specified by user - contains wrapped byte array
which is returned as a payload via
PlainMessage.getPayloadData().Specifies types of commands that can be sent to BMC via
ChassisControl command.Chassis power restore policy.
Power Supply Information record from FRU Multi Record Area
FRU record containing Board info.
This area is present if the FRU itself is a separate product.
This area is present if the FRU itself is a separate product.
Decodes IPMI session header and retrieves encrypted payload.
Adds IPMI session header to encrypted payload.
Decodes IPMI v1.5 session header and retrieves encrypted payload.
Encodes IPMI v1.5 message
Decodes IPMI v2.0 session header and retrieves encrypted payload.
Encodes IPMI v2.0 message.
A wrapper for RMCP+ RAKP1 message and it's response - RAKP2 message.
At this state RAKP Message 2 was received - waiting for the confirmation to
send RAKP Message 3.
A wrapper for RAKP 2 message.
Waiting for RAKP Message 2.
Performs transition from
Rakp1Complete to Rakp3Waiting.A wrapper for RMCP+ RAKP3 message and it's response - RAKP4 message.
Empty state inserted to keep the convention of Waiting-Complete states.
A wrapper for RAKP 3 message.
At this point of session challenge, RAKP Message 3 was sent,
Transition to:
StateMachine is waiting for RAKP Message 4.Transition to:
Rakp3Complete on DefaultAck
Authcap on Timeout
Utility class for generating random numbers.
A wrapper class for Read FRU Data Command request.
Wrapper for Read FRU Data response.
Type of the reading of the discrete sensor.
ReadingType mapping to match the IPMIUtil event sensor types (states)Class holding codes for SDR types.
Wrapper for Reserve SDR Repository command.
Wrapper for Reserve SDR Repository command response.
Wrapper for Reserve SEL command.
Wrapper for Reserve SEL command response.
StateMachineAction carrying ResponseData for the message in the process
of the session challenge.A wrapper for command response data.
Types of RMCP messages.
Set of constants.
Decodes RMCP packet from raw data.
Encodes RMCPMessage into RMCP packet.
A wrapper class for ASF ping message.
A wrapper class for RMCP message.
A wrapper class for ASF ping message.
Supported versions of RMCP protocol
Set of constants.
Wraps Sensor information:
The Sensor record which can be either
CompactSensorRecord or FullSensorRecord.Indicates whether the sensor is monitoring an input or output relative to the
given Entity.
Wrapper for SDR entry.
Represents state of threshold-based sensor.
Type of the sensor.
Specifies available units for sensors' measurements.
Entry point for the Serial Over LAN (SOL) communication.
Single opened IPMI session handle.
Exception that can be thrown when there are some problems with session, for example when establishig new session.
Manages multiple
Sessions.StateMachineEvent that will make StateMachine in the
SessionValid State to send
GetChannelAuthenticationCapabilities to the BMC in order to keep up
the session.State in which the session is valid and sending IPMI commands to the
remote machine is enabled.Wrapper class for Set Session Privilege Level command
Enumeration of possible acknowledge states for SOL messages.
Implementation of
PayloadCoder for payload type PayloadType.Sol.Interface for Serial over LAN (SOL) events listener.
Exception representing problem that might have been encoutered during Serial over LAN communication.
Implementation of
SolMessage for BMC -> Remote Console message.SolInboundStatusField is a transfer object for status sent by remote system to this application in SolInboundMessage.Implementation of
IpmiPayload for SOL (Serial over LAN) messages.Implementation of
MessageHandler for PayloadType.Sol.Enumeration of all possible operations, that Remote Console can invoke on BMC during SOL communication.
Implementation of
SolMessage for Remote Console -> BMC message.SolOutboundOperationField is a transfer object for operation sent by this application to remote system in SolOutboundMessage.Impementation of
ResponseData for SolMessages.Enumeration of all possible states, that Remote Console can receive from BMC during SOL communication.
Stub for future implementation of DIMM SPD information format.
Implementation of
CipherSuiteSelectionHandler that always returns cipher suite provided in the constructor.Acknowledges starting the session after receiving RAKP Message 4 (
StateMachine transits from Rakp3Complete to
SessionValid)The abstract for state of the
StateMachine.State machine for connecting and acquiring session with the remote host via
IPMI v.2.0.
Abstract for external action of the
StateMachineAbstract for an event of the
StateMachine.StateMachineEvent indicating that response for one of the messages in
the process of the session challenge did not arrive in time.Tool class for converting types.
An interface for
UdpMessenger listener.Container for UDP message.
Handles the UDP connection.
The initial state.