Index

A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AA_RAKP_HMAC_MD5 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Authentication algorithm = RAKP-HMAC-MD5
AA_RAKP_HMAC_SHA1 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Authentication algorithm = RAKP-HMAC-SHA1
AA_RAKP_HMAC_SHA256 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Authentication algorithm = RAKP-HMAC-SHA256
AA_RAKP_NONE - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Authentication algorithm = RAKP-none
ABootCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AboveUpperCritical - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
AboveUpperNonCritical - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
AboveUpperNonRecoverable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
AbstractSensorRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
Fields shared by the Full, Compact and Event-Only sensor records (IPMI 2.0 tables 43-1, 43-2 and 43-3), and the methods decoding them.
AbstractSensorRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
 
AC_FAILED - Enum constant in enum org.metricshub.ipmi.client.PowerEvent
The system lost its AC supply.
acFailed() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the AC failed (byte 3 bit 0).
Ack - Enum constant in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
ASF ACK Class of Message
ACK - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolAckState
Message was acknowledged.
AcpiG1Sleeping - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiG3MechanicalOff - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiLegacyOffState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiLegacyOnState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS0G0Working - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS1SleepingProcessorContextMaintained - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS2SleepingProcessorContextLost - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS3SleepingProcessorContextLostMemoryRetained - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS4NonVolatileSleep - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS4S5SoftOffStateUndetermined - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS5EnteredByOverride - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiS5G2SoftOff - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiSleepingInS1S2OrS3 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AcpiUnknown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
ACTIVATE_PAYLOAD - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Activate Payload command
ActivatePayload<R extends ActivatePayloadResponseData> - Class in org.metricshub.ipmi.core.coding.commands.payload
An abstract wrapper class for Activate Payload Command.
ActivatePayloadResponseData - Class in org.metricshub.ipmi.core.coding.commands.payload
Wrapper for Activate Payload response
ActivatePayloadResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
 
ActivateSolPayload - Class in org.metricshub.ipmi.core.coding.commands.payload
Concrete implementation of ActivatePayload command for PayloadType.SOL.
ActivateSolPayload(int) - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.ActivateSolPayload
Instantiate a new ActivateSolPayload
ActivateSolPayloadResponseData - Class in org.metricshub.ipmi.core.coding.commands.payload
Concrete implementation of ActivatePayloadResponseData for PayloadType.SOL.
ActivateSolPayloadResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.ActivateSolPayloadResponseData
 
AdConverter - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
add(PayloadCoder) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Adds request to the queue and generates the tag.
add(PayloadCoder, boolean) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Adds request to the queue and generates the tag.
add(PayloadCoder, boolean, int) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Adds request to the queue under the given tag, when no other request holds it: a SOL packet sent again keeps its packet sequence number.
AdDaConverter - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
AddInCard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
AddInCard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AddInCard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
AddressType - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
Type of address behind Sensor Record's 'Sensor Owner ID' field.
Administrator - Enum constant in enum org.metricshub.ipmi.core.coding.commands.PrivilegeLevel
Every command, the configuration of the BMC included; Serial over LAN needs this level on most BMCs.
AgentNotResponding - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Graceful shutdown request to agent via BMC did not occur due to missing or malfunctioning local agent.
AirInlet - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
AirInlet2 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Duplicate of EntityId.AirInlet.
AL_ADMINISTRATOR - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandsConstants
Authentication level = Administrator
AL_CALLBACK - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandsConstants
Authentication level = Callback
AL_HIGHEST_AVAILABLE - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandsConstants
Highest available authentication level
AL_OEM - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandsConstants
OEM-defined authentication level
AL_OPERATOR - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandsConstants
Authentication level = Operator
AL_USER - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandsConstants
Authentication level = User
ALGORITHM_NAME - Static variable in class org.metricshub.ipmi.core.coding.security.IntegrityHmacMd5_128
 
ALGORITHM_NAME - Static variable in class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha1_96
 
ALGORITHM_NAME - Static variable in class org.metricshub.ipmi.core.coding.security.IntegrityMd5_128
 
AllEventLoggingDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
AllInOne - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
Alpha - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.InstanceModifierType
 
Amps - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
anonymousLogin() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Tells whether the BMC accepts the anonymous login (null user name and null password).
answers(IpmiLanMessage) - Method in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
Tells whether a reply ends the exchange: the response of the controller, or the response to Send Message when the BMC refused to forward the request or put the response of the controller in it.
answers(IpmiLanMessage) - Method in class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder
Tells whether a reply received under the tag of this request answers it: the same command code, under the response network function of the request (the request one plus one, IPMI 2.0 section 5.1).
appendField(byte) - Method in class org.metricshub.ipmi.core.common.MessageComposer
Append single-byte field to the message.
appendField(byte[]) - Method in class org.metricshub.ipmi.core.common.MessageComposer
Append byte arrach field to the message.
ApplicationRequest - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
ApplicationResponse - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
Asf - Enum constant in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
 
ASFIANA - Static variable in class org.metricshub.ipmi.core.coding.rmcp.RmcpConstants
IANA Enterprise Number = ASF IANA
Assertion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sel.EventDirection
The event asserts its state.
Authcap - Class in org.metricshub.ipmi.core.sm.states
Authcap() - Constructor for class org.metricshub.ipmi.core.sm.states.Authcap
 
AuthcapWaiting - Class in org.metricshub.ipmi.core.sm.states
Waiting for the GetChannelAuthenticationCapabilities response, the first one of the handshake.
AuthcapWaiting(int) - Constructor for class org.metricshub.ipmi.core.sm.states.AuthcapWaiting
Instantiates a new AuthcapWaiting using the given tag
AuthenticationAlgorithm - Class in org.metricshub.ipmi.core.coding.security
Interface for authentication algorithms.
AuthenticationCapabilitiesReceived - Class in org.metricshub.ipmi.core.sm.events
Performs transition from Ciphers to Authcap: the caller declared the cipher suite and the privilege of the session.
AuthenticationCapabilitiesReceived(int, PrivilegeLevel) - Constructor for class org.metricshub.ipmi.core.sm.events.AuthenticationCapabilitiesReceived
 
AuthenticationException - Exception in org.metricshub.ipmi.core.coding.commands.session
The RAKP authentication of a session failed on the console side: the key exchange authentication code of RAKP Message 2 or the integrity check value of RAKP Message 4 does not match, which means a wrong password or BMC key (IPMI 2.0 sections 13.31 and 13.32).
AuthenticationException(String) - Constructor for exception org.metricshub.ipmi.core.coding.commands.session.AuthenticationException
Creates the exception.
AuthenticationRakpHmacMd5 - Class in org.metricshub.ipmi.core.coding.security
RAKP-HMAC-MD5 authentication algorithm.
AuthenticationRakpHmacMd5() - Constructor for class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacMd5
Initiates RAKP-HMAC-MD5 authentication algorithm.
AuthenticationRakpHmacSha1 - Class in org.metricshub.ipmi.core.coding.security
RAKP-HMAC-SHA1 authentication algorithm.
AuthenticationRakpHmacSha1() - Constructor for class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha1
Initiates RAKP-HMAC-SHA1 authentication algorithm.
AuthenticationRakpHmacSha256 - Class in org.metricshub.ipmi.core.coding.security
RAKP-HMAC-SHA256 authentication algorithm.
AuthenticationRakpHmacSha256() - Constructor for class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha256
Initiates RAKP-HMAC-SHA256 authentication algorithm.
AuthenticationRakpNone - Class in org.metricshub.ipmi.core.coding.security
RAKP-None authentication algorithm.
AuthenticationRakpNone() - Constructor for class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
Constructs an instance of the RAKP-None authentication algorithm.
AuthenticationType - Enum in org.metricshub.ipmi.core.coding.protocol
Available types of authentication.
Authorize - Class in org.metricshub.ipmi.core.sm.events
Performs transition from Authcap to OpenSessionWaiting.
Authorize(CipherSuite, int, PrivilegeLevel, int) - Constructor for class org.metricshub.ipmi.core.sm.events.Authorize
 
AutomaticBootToDiagnostic - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
auxiliaryFirmwareRevision() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the auxiliary firmware revision, four bytes whose meaning the manufacturer defines (a build number, a boot block version).
available() - Method in class org.metricshub.ipmi.client.DeviceId
Tells whether the BMC is in normal operation, rather than updating its firmware or its SDR repository or initializing itself.
available() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Returns the number of characters received from the BMC that a read returns without waiting.

B

BackPanelBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Baseboard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Duplicate of EntityId.SystemBoard.
BaseCompatibilityInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
Base Compatibility record (type 04h) from the FRU MultiRecord area
BaseCompatibilityInfo(byte[], int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Creates and populates record
BaseCompatibilityRecord - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
BaseOsInstallationAborted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Base OS/Hypervisor installation aborted (IPMI 2.0 revision 1.1).
BaseOsInstallationCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Base OS/Hypervisor installation completed (IPMI 2.0 revision 1.1).
BaseOsInstallationFailed - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Base OS/Hypervisor installation failed (IPMI 2.0 revision 1.1).
BaseOsInstallationStarted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Base OS/Hypervisor installation started (IPMI 2.0 revision 1.1): the installation of the operating system or hypervisor of the system, not the installation or provisioning of a virtual machine.
BaseUnit - Enum in org.metricshub.ipmi.core.coding.commands.fru
Represents unit which is used to access FRU
Battery - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Battery - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
BatteryFailed - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
BatteryLow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Predictive failure.
BatteryPresenceDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Becquerel - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
BelowLowerCritical - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
BelowLowerNonCritical - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
BelowLowerNonRecoverable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
BiosWatchdogReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
BIOS Watchdog Reset: Watchdog 1 (sensor type 11h, deprecated since IPMI 1.5 in favour of Watchdog 2, 23h).
bit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
BMC_ADDRESS - Static variable in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanConstants
The address of the BMC.
BMC_MESSAGE_CHANNEL_INFO_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
BmcCapabilities - Class in org.metricshub.ipmi.client
What the BMC supports before any login (Get Channel Cipher Suites and Get Channel Authentication Capabilities, IPMI 2.0 sections 22.15 and 22.13): the cipher suites it offers and its authentication options.
bmcKey(byte[]) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets the BMC key (Kg) of the two-key login, as raw bytes, for a BMC whose key is set.
bmcKeyRequired() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Tells whether the BMC requires the two-key login: the BMC key (Kg) is set and must be given with the password.
BmcMessageChannelInfoRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
Deprecated.
This sensor record has been deprecated
BmcMessageChannelInfoRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.BmcMessageChannelInfoRecord
Deprecated.
 
board() - Method in class org.metricshub.ipmi.client.Fru
Returns the board info area, as the protocol core decodes it.
BoardInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
FRU record containing Board info.
BoardInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Creates and populates record
BootCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Boot device not specified.
BootError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
BootSourceSelectionTimeout - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Break - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
Generate BREAK (300 ms, nominal)
Break - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
A break condition from the system has been detected.
BRIDGE - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device responds to the commands of the Bridge network function, used for ICMB bridging (bit 6).
BridgeRequest - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
BridgeResponse - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
build() - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Validates the settings and creates the client.
builder(String) - Static method in class org.metricshub.ipmi.client.IpmiClient
Starts building a client of the BMC at the given host.
BusCorrectableError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
BusDegraded - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
BusExpansionChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
BusFatalError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
BusTimeout - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
BusUncorrectableError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
ButtonSwitch - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Byte - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
byteArrayToInt(byte[]) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts byte array in BigEndian convention to int.
ByteBuffer - Class in org.metricshub.ipmi.core.common
ByteBuffer is a wrapper for byte[], and allows to safely read and write from the buffer.
ByteBuffer(int) - Constructor for class org.metricshub.ipmi.core.common.ByteBuffer
Allocate new ByteBuffer with given size.
Bytes - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.BaseUnit
The device is accessed by bytes.
byteToInt(byte) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Because Java doesn't support unsigned byte values, simple type casting leads to overflows and wrong values.

C

CA_AES_CBC128 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Confidentiality algorithm = AES-CBC-128
CA_NONE - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Confidentiality algorithm = None
CA_XRC4_128 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Confidentiality algorithm = xRC4-128
CA_XRC4_40 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Confidentiality algorithm = xRC4-40
CableInterconnect - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
CableInterconnect - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
CableInterconnectConfigurationError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Incorrect cable connected / Incorrect interconnection
CableInterconnectConnected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
calcFormula(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Converts to units-based value using the 'y=Mx+B' formula.
calcFormula(int, SensorReadingFactors) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Converts a reading with the factors the BMC returned for it in reply to Get Sensor Reading Factors, as a non-linear sensor needs (FullSensorRecord.isNonLinear()).
calculateSik(Rakp1ResponseData) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
Calculates SIK (Session Integrity Key) based on RAKP Messages 1 and 2
Callback - Enum constant in enum org.metricshub.ipmi.core.coding.commands.PrivilegeLevel
The lowest level: only the commands that initiate a callback.
Candela - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
CannotRespond - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Cannot return number of requested data bytes.
capabilities() - Method in class org.metricshub.ipmi.client.IpmiClient
Reads what the BMC supports before any login: its authentication options and the cipher suites it offers (Get Channel Authentication Capabilities and Get Channel Cipher Suites).
capacity() - Method in class org.metricshub.ipmi.core.common.ByteBuffer
Returns max capacity of the buffer (number of total data that can be stored in the buffer).
CBootCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
CdRomBootCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Cfm - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Characters - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
CharacterTransferUnavailable - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
Character transfer is unavailable because system is in a powered-down or sleep state.
chassis() - Method in class org.metricshub.ipmi.client.Fru
Returns the chassis info area, as the protocol core decodes it.
Chassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Chassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
CHASSIS_CONTROL - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Chassis Control command
CHASSIS_DEVICE - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device implements the chassis commands, as the chassis device of the ICMB specification (bit 7).
CHASSIS_IDENTIFY - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Chassis Identify command
ChassisBackPanelBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
chassisControl(PowerCommand) - Method in class org.metricshub.ipmi.client.IpmiClient
Controls the power of the chassis (Chassis Control, IPMI 2.0 section 28.3): power up, power down, power cycle, hard reset, soft shutdown or diagnostic interrupt.
ChassisControl - Class in org.metricshub.ipmi.core.coding.commands.chassis
Wrapper class for Chassis Control request.
ChassisControl(PowerCommand) - Constructor for class org.metricshub.ipmi.core.coding.commands.chassis.ChassisControl
Initiates ChassisControl for encoding and decoding.
ChassisControlResponseData - Class in org.metricshub.ipmi.core.coding.commands.chassis
Wrapper class for Chassis Control response.
ChassisControlResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.chassis.ChassisControlResponseData
 
chassisIdentify(int) - Method in class org.metricshub.ipmi.client.IpmiClient
Makes the chassis identify itself (Chassis Identify, IPMI 2.0 section 28.5), typically with a blinking LED, for the given number of seconds, or turns the identify off.
ChassisIdentify - Class in org.metricshub.ipmi.core.coding.commands.chassis
Wrapper for the Chassis Identify command (IPMI 2.0 section 28.5): makes the chassis identify itself, by a blinking LED or a beep, for a number of seconds, indefinitely, or not any more.
ChassisIdentify(int, boolean) - Constructor for class org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentify
Initiates ChassisIdentify for encoding and decoding.
chassisIdentifyForever() - Method in class org.metricshub.ipmi.client.IpmiClient
Makes the chassis identify itself until chassisIdentify(0) turns it off: the optional "force identify on" of Chassis Identify, which not every BMC implements.
ChassisIdentifyResponseData - Class in org.metricshub.ipmi.core.coding.commands.chassis
Wrapper class for Chassis Identify response, which carries no data.
ChassisIdentifyResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyResponseData
 
ChassisIdentifyState - Enum in org.metricshub.ipmi.core.coding.commands.chassis
Chassis Identify State.
ChassisInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
FRU record containing Chassis info.
This area is used to hold Serial Number, Part Number, and other information about the system chassis.
ChassisInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Creates and populates record
ChassisRequest - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
ChassisResponse - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
chassisStatus() - Method in class org.metricshub.ipmi.client.IpmiClient
Reads the state of the chassis: power, faults, intrusion, identify LED (Get Chassis Status).
ChassisStatus - Class in org.metricshub.ipmi.client
The state of the chassis: power, faults, intrusion, identify LED (Get Chassis Status, IPMI 2.0 table 28-3).
ChassisType - Enum in org.metricshub.ipmi.core.coding.commands.fru.record
Specifies possible types of chassis.
checkCredentials(String, byte[], byte[]) - Static method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
Checks the credentials of a session against what a BMC stores: a user name of at most 16 bytes in UTF-8, a password and a BMC key (Kg) of at most 20 bytes.
checkKeyExchangeAuthenticationCode(byte[], byte[], byte[]) - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationAlgorithm
Checks value of the Key Exchange Authentication Code in RAKP messages
checkKeyExchangeAuthenticationCode(byte[], byte[], byte[]) - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
Checks value of the Key Exchange Authentication Code in RAKP messages using the RAKP-None algorithm.
Chipset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
ChipsetSoftPowerControlFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Chip set did not respond to BMC request to change system power state
ChipsetThermalTrip - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
choose(List<CipherSuite>) - Method in interface org.metricshub.ipmi.core.api.sol.CipherSuiteSelectionHandler
Chooses one CipherSuite among list of available CipherSuites, to be used during IPMI connection.
choose(List<CipherSuite>) - Method in class org.metricshub.ipmi.core.api.sol.SpecificCipherSuiteSelector
 
Ciphers - Class in org.metricshub.ipmi.core.sm.states
The authentication capabilities and the CipherSuites of the BMC were read.
Ciphers() - Constructor for class org.metricshub.ipmi.core.sm.states.Ciphers
 
cipherSuite(int) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Uses exactly the given cipher suite, without asking the BMC which ones it offers: saves the Get Channel Authentication Capabilities and Get Channel Cipher Suites round trips with a BMC known to support it.
CipherSuite - Class in org.metricshub.ipmi.core.coding.security
Provides cipher suite (authentication, confidentiality and integrity algorithms used during the session).
CipherSuite(byte, byte, byte, byte) - Constructor for class org.metricshub.ipmi.core.coding.security.CipherSuite
Creates a cipher suite.
cipherSuites() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Returns the standard cipher suites (0 to 19) the BMC offers, with their algorithms; the OEM suites and reserved suite IDs it lists are left out.
cipherSuites(int...) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets the cipher suites the client may use, by order of preference: the first one the BMC offers is used.
CipherSuiteSelectionHandler - Interface in org.metricshub.ipmi.core.api.sol
Interface for CipherSuite selection handler to choose among available CipherSuites returned by the server.
CiphersWaiting - Class in org.metricshub.ipmi.core.sm.states
State at which getting Channel Cipher Suites is in progress.
CiphersWaiting(int, int) - Constructor for class org.metricshub.ipmi.core.sm.states.CiphersWaiting
Initializes state.
clear(String) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Removes every request from the queue and frees their tags: those still waiting for a reply are reported as failed, the one-way ones are dropped.
ClockCalendar - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
close() - Method in class org.metricshub.ipmi.client.IpmiClient
Closes the session (Close Session, sent once and waited for at most the message timeout plus one second), releases the UDP port and the threads.
close() - Method in class org.metricshub.ipmi.client.SolConsole
Deactivates the SOL payload and releases the console.
close() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Deactivates the SOL payload, closes the sessions the console opened, and tears down the connector when the console owns it: these are released even when the deactivation fails.
close() - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Closes all open connections and disconnects UdpListener.
closeConnection() - Method in interface org.metricshub.ipmi.core.transport.Messenger
Closes the connection.
closeConnection() - Method in class org.metricshub.ipmi.core.transport.UdpMessenger
Closes the socket and releases port.
closeConnection(int) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Closes the connection with the given index and releases it; the index is not reused.
closeConnection(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Closes the connection with the given handle, forgets its session, and wipes the credentials the handle keeps.
closeConnection(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Closes the connection with the given handle, without closing its session: the requests still waiting for a reply on the connection fail, with a ConnectionException or an IllegalStateException.
closeSession() - Method in class org.metricshub.ipmi.core.connection.Connection
Closes the session.
closeSession(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Closes the session with the remote host if it is currently in open state, and wipes the password and the BMC key (Kg) the handle keeps.
closeSession(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Closes the session with the remote host if it is currently in open state, and wipes the password and the BMC key (Kg) the handle keeps.
CloseSession - Class in org.metricshub.ipmi.core.coding.commands.session
Wrapper for Close Session request
CloseSession - Class in org.metricshub.ipmi.core.sm.events
StateMachineEvent that will make StateMachine in the SessionValid State to send CloseSession and transit to Authcap State the session.
CloseSession(int) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.CloseSession
Initiates CloseSession for both encoding and decoding.
CloseSession(int, int, int) - Constructor for class org.metricshub.ipmi.core.sm.events.CloseSession
Prepares CloseSession
CloseSessionResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
Wrapper for Close Session response
CloseSessionResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.CloseSessionResponseData
 
cm - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Collision - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
ColorTempDegK - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
ComboManagementASIC - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
command() - Method in exception org.metricshub.ipmi.client.IpmiCompletionCodeException
Returns the command code of the command the BMC answered.
COMMAND_CODE - Static variable in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
Command code of Send Message (IPMI 2.0 table G-1).
CommandCodes - Class in org.metricshub.ipmi.core.coding.commands
Contains command codes for IPMI commands Byte constants are encoded as pseudo unsigned bytes.
CommandNotSupported - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Cannot execute command.
CommandsConstants - Class in org.metricshub.ipmi.core.coding.commands
Set of constants.
COMPACT_SENSOR_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
CompactSensorRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
Wrapper for Compact Sensor Record format
CompactSensorRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.CompactSensorRecord
 
complete() - Method in class org.metricshub.ipmi.client.Fru
Tells whether the FRU inventory was read and decoded entirely.
completionCode() - Method in exception org.metricshub.ipmi.client.IpmiCompletionCodeException
Returns the completion code, CompletionCode.Unknown when the library does not model it.
completionCode() - Method in class org.metricshub.ipmi.client.RawResponse
Returns the completion code: CompletionCode.Ok when the BMC carried the request out, CompletionCode.Unknown for an OEM (01h-7Eh) or command-specific (80h-BEh) code, whose meaning only the command defines (see RawResponse.rawCompletionCode()).
CompletionCode - Enum in org.metricshub.ipmi.core.coding.payload
 
ComponentManagementURL - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
 
ConfidentialityAesCbc128 - Class in org.metricshub.ipmi.core.coding.security
AES-CBC-128 confidentiality algorithm
ConfidentialityAesCbc128() - Constructor for class org.metricshub.ipmi.core.coding.security.ConfidentialityAesCbc128
 
ConfidentialityAlgorithm - Class in org.metricshub.ipmi.core.coding.security
Interface for Confidentiality Algorithms.
ConfidentialityAlgorithm() - Constructor for class org.metricshub.ipmi.core.coding.security.ConfidentialityAlgorithm
 
ConfidentialityNone - Class in org.metricshub.ipmi.core.coding.security
Class representing no confidentiality algorithm.
ConfidentialityNone() - Constructor for class org.metricshub.ipmi.core.coding.security.ConfidentialityNone
 
ConfigurationError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
connect(InetAddress, int, long) - Method in class org.metricshub.ipmi.core.connection.Connection
Starts the connection to the specified InetAddress
connect(InetAddress, int, long, boolean) - Method in class org.metricshub.ipmi.core.connection.Connection
Starts the connection to the specified InetAddress
Connection - Class in org.metricshub.ipmi.core.connection
A connection with the specific remote host.
Connection(Messenger, int) - Constructor for class org.metricshub.ipmi.core.connection.Connection
Creates the connection.
ConnectionException - Exception in org.metricshub.ipmi.core.connection
Exception indicating that connecting to the remote machine failed.
ConnectionException(String) - Constructor for exception org.metricshub.ipmi.core.connection.ConnectionException
 
ConnectionHandle - Class in org.metricshub.ipmi.core.api.async
Identifies one Connection (one BMC) of a connector: its index in the connector, the address and UDP port of the BMC, the cipher suite and privilege level of its session, and the user name, password and BMC key (Kg) the session was opened with, which the connector keeps to open another session on a payload port of the same BMC (Serial over LAN).
ConnectionHandle(int, InetAddress, int) - Constructor for class org.metricshub.ipmi.core.api.async.ConnectionHandle
Creates the handle of a connection.
ConnectionListener - Interface in org.metricshub.ipmi.core.connection
Interface for the Connection listener.
ConnectionManager - Class in org.metricshub.ipmi.core.connection
Manages multiple Connections
ConnectionManager(int) - Constructor for class org.metricshub.ipmi.core.connection.ConnectionManager
Initiates the connection manager.
ConnectionManager(int, long) - Constructor for class org.metricshub.ipmi.core.connection.ConnectionManager
Initiates the connection manager.
ConnectionManager(int, InetAddress) - Constructor for class org.metricshub.ipmi.core.connection.ConnectionManager
Initiates the connection manager.
ConnectionManager(Messenger) - Constructor for class org.metricshub.ipmi.core.connection.ConnectionManager
Initiates the connection manager.
ConnectivitySwitch - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
A blade module that provides the fabric or network connection for one or more processing blades or modules.
ConsistencyOrParityCheckInProgress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Constants - Class in org.metricshub.ipmi.core.common
Holds constants common for whole library.
ControllerAccessUnavailable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Controller access degraded or unavailable.
convert(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorReadingFactors
Applies the linear part of the conversion formula (section 36.3): (M x + B 10^K1) 10^K2, without any linearization function.
convertToByte() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolInboundStatusField
Convert this object to it's raw, byte representation.
convertToByte() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolOutboundOperationField
Convert this object to it's raw, byte representation.
CoolingDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
CoolingDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
coolingFault() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether a cooling or fan fault was detected.
coolingFaultDetected() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether a cooling or fan fault was detected (byte 4 bit 3).
CoolingUnit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
copy() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Returns a new instance of this suite, with uninitialized algorithms: opening a session keys the algorithms of its suite, so two sessions must never share an instance.
CoreLogicDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
CorrectableEcc - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Correctable ECC / other correctable memory error
CorrectableEccOtherCorrectableMemoryErrorLoggingLimitReached - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Correctable ECC / other correctable memory error logging limit reached
CorrectableError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
CorrectableMachineCheckError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
CorrectableMachineCheckErrorLoggingDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
CorrectableMemoryErrorLoggingDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Coulombs - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
createConnection(InetAddress) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Creates connection to the remote host on default IPMI port.
createConnection(InetAddress, int) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Creates connection to the remote host.
createConnection(InetAddress, int) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Creates connection to the remote host on specified port.
createConnection(InetAddress, int) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Creates and initiates Connection to the remote host with the default ping frequency.
createConnection(InetAddress, int, boolean) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Creates and initiates Connection to the remote host with the default ping frequency.
createConnection(InetAddress, int, int) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Creates and initiates Connection to the remote host.
createConnection(InetAddress, int, int, boolean) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Creates and initiates Connection to the remote host.
createConnection(InetAddress, int, CipherSuite, PrivilegeLevel) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.
createConnection(InetAddress, int, CipherSuite, PrivilegeLevel) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.
createConnection(InetAddress, CipherSuite, PrivilegeLevel) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Creates connection to the remote host, with pre set CipherSuite and PrivilegeLevel, skipping the getAvailableCipherSuites and getChannelAuthenticationCapabilities phases.
credentials(String, char[]) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets the user name and password of the session.
CRITICAL - Enum constant in enum org.metricshub.ipmi.client.SensorStatus
The reading is at or beyond a critical threshold.
CriticalInterrupt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
CriticalStopDuringOsLoad - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Unexpected error during system startup.
CTS - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
Deassert CTS (clear to send) to the baseboard serial controller.
CuCm - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Cufeet - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
CuIn - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
CuM - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Current - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Current - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Cycles - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

D

D0PowerState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
D1PowerState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
D2PowerState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
D3PowerState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
DaConverter - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
data() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Returns the reply of the BMC, as the protocol core decodes it.
data() - Method in class org.metricshub.ipmi.client.ChassisStatus
Returns the reply of the BMC, as the protocol core decodes it.
data() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the reply of the BMC, as the protocol core decodes it.
data() - Method in class org.metricshub.ipmi.client.RawResponse
Returns the response data after the completion code, as the BMC sent it.
data(int...) - Method in class org.metricshub.ipmi.client.RawRequest
Sets the request data.
DataNotPresent - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Requested Sensor, data, or record not present.
Day - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Days - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
DbA - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
DbC - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
DCD_DSR - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
When test mode inactive, deassert DCD/DSR to baseboard serial controller.
DcLoad - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
DcLoadInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
DC Load record (type 02h) from the FRU MultiRecord area
This record is used to describe the maximum load that a device requires from a particular DC Output.
DcLoadInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Creates and populates record
DcOutput - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
DcOutputInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
DC Output record (type 01h) from the FRU MultiRecord area
DcOutputInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Creates and populates record
DEACTIVATE_PAYLOAD - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Deactivate Payload command
deactivated() - Method in class org.metricshub.ipmi.client.SolConsole
Tells whether the console has ended other than by a successful SolConsole.close(): the BMC reported the SOL payload deactivated (another session deactivated or took it, or the system was reset or powered on or off locally), the client was closed or lost the session the console runs in, or SolConsole.close() could not deactivate the payload.
DeactivatePayload - Class in org.metricshub.ipmi.core.coding.commands.payload
A wrapper class for Deactivate Payload Command.
DeactivatePayload(PayloadType, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayload
Creates new instance of the DeactivatePayload command for deactivating given PayloadType.
DeactivatePayloadCompletionCode - Enum in org.metricshub.ipmi.core.coding.commands.payload
Enumeration of specific completion codes for DeactivatePayload command.
DeactivatePayloadResponseData - Class in org.metricshub.ipmi.core.coding.commands.payload
Wrapper for Deactivate Payload response
DeactivatePayloadResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadResponseData
 
Deassertion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sel.EventDirection
The event deasserts its state.
Decibels - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
decode(byte[]) - Static method in class org.metricshub.ipmi.core.coding.rmcp.RmcpDecoder
Decodes the RMCP packet from raw data.
decode(byte[], IpmiDecoder, PayloadCoder) - Static method in class org.metricshub.ipmi.core.coding.Decoder
Decodes raw data into ResponseData - a wrapper class for message-specific response data.
decode(RmcpMessage) - Method in interface org.metricshub.ipmi.core.coding.protocol.decoder.IpmiDecoder
Decodes IPMI message.
decode(RmcpMessage) - Method in class org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv15Decoder
Decodes IPMI v1.5 message fields.
decode(RmcpMessage) - Method in class org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv20Decoder
Decodes IPMI v2.0 message fields.
decode1sComplement(int, int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Decodes 1's complement value that is encoded on lesser than 16 number of bits.
decode2sComplement(int, int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Decodes 2's complement value that is encoded on lesser than 16 number of bits.
decode6bitAscii(byte[]) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
 
decodeAuthentication(byte) - Method in class org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv20Decoder
Decodes second bit of Payload Type.
decodeAuthenticationType(RmcpMessage) - Static method in class org.metricshub.ipmi.core.coding.protocol.decoder.ProtocolDecoder
Decodes AuthenticationType of the message so that the version of the IPMI protocol could be determined.
decodeBcdPlus(byte[]) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Decodes text encoded in BCD plus format.
decodeDate(int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Decodes a date encoded as an unsigned 32-bit number of seconds from 00:00:00, January 1, 1970 GMT (IPMI 2.0 section 37.1): the dates from 2038 on, and the FFFFFFFFh marker of an unspecified timestamp, are not negative.
decodeFruData(List<ReadFruDataResponseData>) - Static method in class org.metricshub.ipmi.core.coding.commands.fru.ReadFruData
Decodes FruRecords from data provided by ReadFruData command.
decodeFruData(List<ReadFruDataResponseData>, List<String>) - Static method in class org.metricshub.ipmi.core.coding.commands.fru.ReadFruData
Decodes the FRU data read in chunks, reporting the areas and records it had to skip.
decodePayloadType(byte) - Static method in class org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv20Decoder
 
Decoder - Class in org.metricshub.ipmi.core.coding
Decodes RMCP packet into ResponseData.
decodeSessionID(RmcpMessage) - Static method in class org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv20Decoder
Decodes session ID.
decrypt(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAesCbc128
 
decrypt(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAlgorithm
Decrypts the data.
decrypt(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityNone
 
Default - Class in org.metricshub.ipmi.core.sm.events
Generic event that is used in a few transitions.
Default(CipherSuite, int, PrivilegeLevel) - Constructor for class org.metricshub.ipmi.core.sm.events.Default
 
DEFAULT_KEEP_ALIVE - Static variable in class org.metricshub.ipmi.client.IpmiClient
Period of the keep-alive messages when the builder sets none: 30 seconds.
DEFAULT_MESSAGE_TIMEOUT - Static variable in class org.metricshub.ipmi.client.IpmiClient
Timeout of each message when the builder sets none: 5 seconds.
DEFAULT_PING_PERIOD - Static variable in class org.metricshub.ipmi.core.connection.ConnectionManager
Period of the keep-alive messages of the connections created without an explicit one, in milliseconds.
DEFAULT_RETRIES - Static variable in class org.metricshub.ipmi.client.IpmiClient
Resends of a message (IpmiClient.Builder.retries(int)) when the builder sets none: 3.
DEFAULT_RETRIES - Static variable in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Number of times a message without a reply is sent again, until IpmiAsyncConnector.setRetries(int) changes it.
DEFAULT_TIMEOUT - Static variable in class org.metricshub.ipmi.client.IpmiClient
Deadline of each operation when the builder sets none: 2 minutes.
DEFAULT_TIMEOUT - Static variable in class org.metricshub.ipmi.core.connection.Connection
Timeout of a message, in milliseconds, until Connection.setTimeout(int) changes it.
DefaultAck - Class in org.metricshub.ipmi.core.sm.events
Default message for acknowledging received IPMI responses.
DefaultAck() - Constructor for class org.metricshub.ipmi.core.sm.events.DefaultAck
 
DegreesC - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
DegreesF - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
DegreesK - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
describe() - Method in exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
Describes the error reply as a sentence without its final period: the message, then the completion code in hexadecimal, named once.
describe(String, int) - Static method in exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
Describes a completion code as a sentence without its final period: its meaning, then the code in hexadecimal.
describeCompletionCode(int) - Static method in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
Describes a completion code specific to Send Message (IPMI 2.0 table 22-9).
describeRefusal(IPMIException) - Static method in class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
Says why the BMC refused the level: the meaning of the command-specific completion codes of Set Session Privilege Level (IPMI 2.0 table 22-24), or the message of the error reply for the other codes, then the code.
description() - Method in class org.metricshub.ipmi.client.SelEntry
Returns a description of the entry.
Desktop - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
DestinationUnavailable - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Destination unavailable.
DEVICE_RELATIVE_ENTITY_ASSOCIATION_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
DeviceAbsent - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Device Removed / Device Absent
DeviceBay - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
DeviceDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
DeviceEnabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
DeviceFunction - Enum in org.metricshub.ipmi.client
A function the BMC provides, from the additional device support byte of Get Device ID (IPMI 2.0 table 20-2).
deviceId() - Method in class org.metricshub.ipmi.client.IpmiClient
Reads the identity of the BMC: manufacturer and product IDs, firmware revision, IPMI version, functions (Get Device ID).
DeviceId - Class in org.metricshub.ipmi.client
The identity of the BMC: its manufacturer and product IDs, its firmware revision, the IPMI version it implements and the functions it provides (Get Device ID, IPMI 2.0 section 20.1).
DevicePresent - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Device Inserted / Device Present
DeviceRelativeEntityAssiciationRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
Deprecated.
misspelled: use DeviceRelativeEntityAssociationRecord, the class the SDR walk returns for type 09h. This class remains its superclass until 3.0, when it will be removed.
DeviceRelativeEntityAssiciationRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
DeviceRelativeEntityAssociationRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
Device-relative Entity Association record, SDR type 09h (IPMI 2.0 section 43.5): 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.
DeviceRelativeEntityAssociationRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssociationRecord
 
DeviceType - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
 
DiagnosticBootCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
DiagnosticInterrupt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Pulse a diagnostic interrupt (optional) that goes directly to the processors, typically to make the operating system write a diagnostic dump: an NMI on IA-32 systems.
direction() - Method in class org.metricshub.ipmi.client.SelEntry
Returns whether a system event is the assertion of its event (a threshold crossed, a failure detected) or its deassertion (back within the threshold, the failure gone).
disconnect() - Method in class org.metricshub.ipmi.core.connection.Connection
Ends the connection.
Disk - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Disk or disk bay.
DiskDriveBay - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Divide - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ModifierUnitUsage
Unit = Basic Unit / Modifier Unit
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.Authcap
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.AuthcapWaiting
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.Ciphers
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.CiphersWaiting
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.OpenSessionComplete
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.OpenSessionWaiting
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.Rakp1Complete
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.Rakp1Waiting
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.Rakp3Complete
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.Rakp3Waiting
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.SessionValid
 
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.State
Defines the action that should be performed when a response form the remote system arrives in the current state.
doAction(StateMachine, RmcpMessage) - Method in class org.metricshub.ipmi.core.sm.states.Uninitialized
 
DockingStation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
doExternalAction(StateMachineAction) - Method in class org.metricshub.ipmi.core.sm.StateMachine
Sends a notification of an action to all MachineObservers.
doIntegrityCheck(byte[], byte[], byte[]) - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationAlgorithm
Validates Integrity Check Value in RAKP Message 4.
doIntegrityCheck(byte[], byte[], byte[]) - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
Performs Integrity Check in RAKP 4 message using the RAKP-None algorithm.
doTransition(StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.StateMachine
Performs a State transition according to the event and StateMachine.current state.
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.Authcap
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.AuthcapWaiting
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.Ciphers
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.CiphersWaiting
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.OpenSessionComplete
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.OpenSessionWaiting
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.Rakp1Complete
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.Rakp1Waiting
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.Rakp3Complete
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.Rakp3Waiting
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.SessionValid
 
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.State
Performs the state transition
doTransition(StateMachine, StateMachineEvent) - Method in class org.metricshub.ipmi.core.sm.states.Uninitialized
 
DriveBackplane - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
DriveBay - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
DriveBayIntrusion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
driveFault() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether a drive fault was detected.
DriveFault - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
driveFaultDetected() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether a drive fault was detected (byte 4 bit 2).
DrivePresence - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
DS1621TemperatureSensor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
DS1624TemperatureSensor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
DtrAsserted - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
When test mode active, signals that DTR is asserted on serial port.
DuplicatedRequest - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Cannot execute duplicated request.
Dword - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

E

Eeprom24C01 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Eeprom24C02 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Eeprom24C04 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Eeprom24C08 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Eeprom24C16 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Eeprom24C17 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Eeprom24C32 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Eeprom24C64 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
EisaFailSafeTimeout - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
encode(IpmiEncoder, PayloadCoder, int, int, int) - Static method in class org.metricshub.ipmi.core.coding.Encoder
Encodes IPMI command specified by payloadCoder into byte array raw data.
encode(IpmiMessage) - Method in interface org.metricshub.ipmi.core.coding.protocol.encoder.IpmiEncoder
Encodes IPMI message.
encode(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.protocol.encoder.Protocolv15Encoder
 
encode(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.protocol.encoder.Protocolv20Encoder
 
encode(RmcpMessage) - Static method in class org.metricshub.ipmi.core.coding.rmcp.RmcpEncoder
Encodes RMCPMessage into RMCP packet.
encodeInByte(byte) - Method in enum org.metricshub.ipmi.core.coding.payload.sol.SolAckState
Encode information about this SolAckState in given byte, returning updated byte.
encodePayload(int, int, int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
 
encodePayload(int, int, int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
 
encodePayload(int, int, int) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
encodePayload(int, int, int) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
encodePayload(int, int, int) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
encodePayload(int, int, int) - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
Prepares an IPMI request message containing class-specific payload.
Encoder - Class in org.metricshub.ipmi.core.coding
Creates RMCP packet containing encrypted IPMI command from IPMICommand wrapper class or raw byte data.
encrypt(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAesCbc128
 
encrypt(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAlgorithm
Encrypts the data.
encrypt(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityNone
 
encryptPayload(ConfidentialityAlgorithm) - Method in class org.metricshub.ipmi.core.coding.payload.IpmiPayload
entity() - Method in class org.metricshub.ipmi.client.Fru
Returns the entity the FRU is part of.
entity() - Method in class org.metricshub.ipmi.client.Sensor
Returns the entity the sensor monitors.
ENTITY_ASSOCIATION_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
EntityAbsent - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
EntityAssociationRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
This record is used to present the relationship between entities that contain, or are contained by, other entities.
EntityAssociationRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
EntityDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
EntityId - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
The EntityID is used for identifying the physical entity that a sensor or device is associated with.
entityInstance() - Method in class org.metricshub.ipmi.client.Fru
Returns the instance of the entity the FRU is part of: 1 for the first power supply, 2 for the second one.
entityInstance() - Method in class org.metricshub.ipmi.client.Sensor
Returns the instance of the entity the sensor monitors: 1 for the first processor, 2 for the second one.
EntityPresence - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
EntityPresent - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
EntryAddedToAuxiliaryLog - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
equals(Object) - Method in class org.metricshub.ipmi.client.SelEntry
Two entries are equal when they are the same record: same ID and same 16 bytes.
equals(Object) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayload
 
equals(Object) - Method in class org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayload
 
equals(Object) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatus
 
equals(Object) - Method in class org.metricshub.ipmi.core.coding.sol.SolCoder
 
equals(Object) - Method in class org.metricshub.ipmi.core.sm.events.Sendv20Message
 
Error - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
ErrorAction - Class in org.metricshub.ipmi.core.sm.actions
Action representing an exception handed to the machine owner.
ErrorAction(Exception) - Constructor for class org.metricshub.ipmi.core.sm.actions.ErrorAction
 
establishSession(IpmiConnector, String, int, String, byte[], byte[], CipherSuiteSelectionHandler) - Static method in class org.metricshub.ipmi.core.connection.SessionManager
Opens a new connection and session, at the Administrator privilege level, raised to it right after the login.
establishSession(IpmiConnector, String, int, String, String, CipherSuiteSelectionHandler) - Static method in class org.metricshub.ipmi.core.connection.SessionManager
Opens a new connection and session, at the Administrator privilege level, raised to it right after the login.
establishSession(IpmiConnector, ConnectionHandle, int) - Static method in class org.metricshub.ipmi.core.connection.SessionManager
Opens a new connection and session on another UDP port of the BMC of the given connection (the port of a payload, IPMI 2.0 section 24.1), with its user name, password, BMC key and privilege level, and a copy of its cipher suite: opening the session keys the algorithms of its suite.
event() - Method in class org.metricshub.ipmi.client.SelEntry
Returns what happened, as the ReadingType of the event offset for the sensor type and event/reading type: UpperCriticalGoingHigh, PowerSupplyFailureDetected, LogAreaReset...
EVENT_ONLY_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
eventData() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the three event data bytes of a system event as the BMC sent them (IPMI 2.0 table 32-1): the event offset in the low nibble of the first byte, and what its high bits announce for the next two: for a threshold event, the raw reading that triggered it and the threshold, to convert with the FullSensorRecord of the sensor.
EventDirection - Enum in org.metricshub.ipmi.core.coding.commands.sel
Whether a system event is an assertion or a deassertion (bit 7 of the Event Dir | Event Type byte, IPMI 2.0 table 32-1).
EventLoggingDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
EventOnlyRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
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.
EventOnlyRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.EventOnlyRecord
 
eventType() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the event/reading type code of a system event (IPMI 2.0 table 42-1): 01h for a threshold event, 02h to 0Ch for a generic discrete one, 6Fh for a sensor-specific one, 70h to 7Fh for an OEM one.
EventTypeLoggingDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
execute() - Method in class org.metricshub.ipmi.client.FrusRequest
Reads the selected FRUs.
execute() - Method in class org.metricshub.ipmi.client.RawRequest
Sends the request and waits for its reply.
execute() - Method in class org.metricshub.ipmi.client.SelRequest
Reads the entries: Get SEL Time UTC Offset, Get SEL Info, then one Get SEL Entry per entry, each read whole (so without a reservation, IPMI 2.0 section 31.5; one is taken when the BMC asks for it).
execute() - Method in class org.metricshub.ipmi.client.SensorsRequest
Reads the selected sensors.
ExpansionChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
ExtendedCompatibilityInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
Extended Compatibility record (type 05h) from the FRU MultiRecord area: the same layout as the BaseCompatibilityInfo record (type 04h).
ExtendedCompatibilityInfo(byte[], int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.ExtendedCompatibilityInfo
Creates and populates record
ExtendedCompatibilityRecord - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
ExternalEnvironment - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
This Entity ID can be used to identify the environment outside the system chassis.
extractFromByte(byte) - Static method in enum org.metricshub.ipmi.core.coding.payload.sol.SolAckState
Extracts SolAckState from given byte.

F

FAILED_TO_RECEIVE_ANSWER_CAUSE_MESSAGE - Static variable in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
 
Fan - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Fan - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Fan - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
FANAreaIntrusion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Supports detection of hot plug fan tampering.
Farad - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
FatalError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
FatalNmi - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Feet - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
FirmwareOrSoftwareChangeDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Informational.
FirmwareOrSoftwareIncompatibilityDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FirmwareRequest - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
FirmwareResponse - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
firmwareRevision() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the firmware revision as ipmitool prints it: the major revision, a dot and the two digits of the minor revision (1.44, 2.05).
FirmwareUpdating - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command response could not be provided.
FluidOunce - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
FlushInbound - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
When test mode inactive, drop (flush) data from remote console to BMC [not including data carried in this packet, if any].
FlushOutbound - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
When test mode inactive, flush Outbound Character Data (flush data from BMC to remote console).
forId(int) - Static method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Creates one of the standard cipher suites (IPMI 2.0 table 22-20) from its ID, with the algorithms the specification assigns to it: the suite to use with a BMC whose offer is not read.
Frb1BistFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Frb2HangInPostFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Used hang is believed to be due or related to a processor failure.
Frb3ProcessorStartupFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
CPU didn't start.
freeTag(int) - Static method in class org.metricshub.ipmi.core.connection.ConnectionManager
Frees the sessionless tag for further use
FRONT_PANEL_BUTTON_CAPABILITIES_NOT_SET_MESSAGE - Static variable in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
The message of the IllegalAccessException that the front panel button getters throw when the reply has no front panel button capabilities byte.
FrontPanelBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
FrontPanelInterrupt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
frontPanelLockout() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether the front panel is locked out.
FrontSideBus - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Fru - Class in org.metricshub.ipmi.client
A Field Replaceable Unit of the system: the board, chassis, product and multirecord areas of its FRU inventory (IPMI Platform Management FRU Information Storage Definition), or the SPD data of a memory module, or the Processor Information ROM of a processor, located by an SDR record.
FRU_DEVICE_LOCATOR_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
FRU_INVENTORY_DEVICE - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device holds a FRU inventory (bit 3).
FruActivationInProgress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FruActivationRequested - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FruActive - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FruCommunicationLost - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FruDeactivationInProgress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FruDeactivationRequested - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Frudevicebusy - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
FRU device busy.
FruDeviceLocatorRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
A FRU Device Locator record (SDR type 11h, IPMI 2.0 table 43-7): it locates FRU information that is on the IPMB, on a private bus behind a management controller, or accessed with the FRU commands of a management controller.
FruDeviceLocatorRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
 
FruFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FruInactive - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
FRU in standby or 'hot spare' state.
FRUInventoryDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
FruLatchOpen - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Switch indicating FRU latch is in 'unlatched' position and FRU is mechanically removable
FruList - Class in org.metricshub.ipmi.client
The FRUs read by IpmiClient.frus(): an unmodifiable list, with the SDR records the repository walk skipped.
FruMultiRecordType - Enum in org.metricshub.ipmi.core.coding.commands.fru.record
Identifies type of the information stored in FRU's MultiRecord Area entry.
FruNotInstalled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FruRecord - Class in org.metricshub.ipmi.core.coding.commands.fru.record
General class for FRU Inventory area records.
FruRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.FruRecord
 
frus() - Method in class org.metricshub.ipmi.client.IpmiClient
Reads the FRU inventories of the system: frus().execute() for all of them, with ids() to select some, and frus().stream() to get each FRU as soon as it is read.
FruServiceRequestButtonPressed - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
FrusRequest - Class in org.metricshub.ipmi.client
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.
FruState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
FtLb - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
FULL_SENSOR_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
FullSensorRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
A Full Sensor Record (SDR type 01h, IPMI 2.0 table 43-1): one sensor, with the fields of AbstractSensorRecord, the factors that convert its reading bytes to values in its unit (FullSensorRecord.calcFormula(int)), its nominal and normal readings, its reading range and its thresholds.
FullSensorRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
 
FullyRedundant - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Indicates that full redundancy has been regained.
functions() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the functions the BMC provides: sensors, SDR repository, SEL, FRU inventory, chassis...

G

Gauss - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
GeneralChassisIntrusion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
generateAuthCode(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.IntegrityAlgorithm
Creates AuthCode field for message.
generateAuthCode(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.IntegrityMd5_128
 
generateAuthCode(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.IntegrityNone
 
generateSessionId() - Static method in class org.metricshub.ipmi.core.connection.SessionManager
Generates the console session ID of a new session.
generateSessionlessTag() - Static method in class org.metricshub.ipmi.core.connection.ConnectionManager
The tag for messages sent outside the session generated by the ConnectionManager.
generatorId() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the generator ID of a system event: the slave address (20h for the BMC itself) or system software ID of what logged the event in the low byte, its channel number and LUN in the high byte (IPMI 2.0 section 32.1).
GENERIC_DEVICE_LOCATOR_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
GenericDeviceLocatorRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
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.
GenericDeviceLocatorRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
get(int) - Method in class org.metricshub.ipmi.client.FruList
 
get(int) - Method in class org.metricshub.ipmi.client.SelEntryList
 
get(int) - Method in class org.metricshub.ipmi.client.SensorList
 
get(int) - Static method in class org.metricshub.ipmi.core.common.MessageComposer
 
GET_CHANNEL_AUTHENTICATION_CAPABILITIES - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Channel Authentication Capabilities command
GET_CHANNEL_CIPHER_SUITES - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Channel Cipher Suites command
GET_CHANNEL_PAYLOAD_SUPPORT - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Channel Payload Support command
GET_CHASSIS_STATUS - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Chassis Status command
GET_DEVICE_ID - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Device ID command (Application network function)
GET_DEVICE_SDR - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Device SDR command (Sensor/Event network function, IPMI 2.0 section 35.3)
GET_DEVICE_SDR_INFO - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Device SDR Info command (Sensor/Event network function, IPMI 2.0 section 35.2).
GET_FRU_INVENTORY_AREA_INFO - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get FRU Inventory Area Info command
GET_PAYLOAD_ACTIVATION_STATUS - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Payload Activation Status command
GET_PAYLOAD_INSTANCE_INFO - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Payload Instance Info command
GET_SDR - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get SDR command
GET_SDR_REPOSITORY_INFO - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get SDR Repository Info command (Storage network function, IPMI 2.0 section 33.9)
GET_SEL_ENTRY - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get SEL Entry command
GET_SEL_INFO - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get SEL Info command
GET_SEL_TIME_UTC_OFFSET - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get SEL Time UTC Offset command (IPMI 2.0 revision 1.1)
GET_SESSION_INFO - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Get Session Info command
getAcceptedCharacterCount() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
getAcceptedCharactersNumber() - Method in class org.metricshub.ipmi.core.coding.sol.SolResponseData
 
getAccessInfo() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessInfo
Returns the management access information: a URL, a name or a ping address of the system or of a component, or the 16-byte unique ID of the system.
getAccessLun() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the LUN of the FRU commands or Master Write-Read commands that access the FRU device (byte 8 bits 4:3 of the record).
getAccessLun() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getAccuracy() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the accuracy of the readings of the sensor, from the factors of the record (bytes 28 and 29 of the record).
getAccuracy() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorReadingFactors
Returns the accuracy.
getAckNackSequenceNumber() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
getAcknowledgeState() - Method in class org.metricshub.ipmi.core.coding.sol.SolResponseData
 
getAckState() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolInboundStatusField
 
getAckState() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolOutboundOperationField
 
getActiveSessions() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
getAdditionalDeviceSupport() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the additional device support byte (byte 7), the functions the device provides.
getAdditionTimestamp() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Returns the time of the most recent addition to the SEL as the BMC sent it: a Date of the unsigned 32-bit number of seconds, with no UTC offset applied.
getAddress() - Method in class org.metricshub.ipmi.core.transport.UdpMessage
Target address when sending message.
getAddressSpan() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getAddressType() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Tells whether the sensor owner ID is an IPMB slave address or a system software ID (byte 6 bit 0 of the record).
getAddTimestamp() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationAlgorithm
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacMd5
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha1
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha256
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityAlgorithm
Returns the name of the algorithm.
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacMd5_128
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha1_96
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha256_128
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityMd5_128
 
getAlgorithmName() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityNone
 
getAssetTag() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the asset tag.
getAuthCode() - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
getAuthCodeLength() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityAlgorithm
Returns the length of the authentication code
getAuthCodeLength() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacMd5_128
 
getAuthCodeLength() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha1_96
 
getAuthCodeLength() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha256_128
 
getAuthCodeLength() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityMd5_128
 
getAuthCodeLength() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityNone
 
getAuthenticationAlgorithm() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getAuthenticationAlgorithm() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Returns instance of AuthenticationAlgorithm class.
getAuthenticationAlgorithmCode() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
 
getAuthenticationType() - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
 
getAuthenticationType() - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
getAuthenticationTypes() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
getAuxiliaryFirmwareRevision() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the auxiliary firmware revision information (bytes 13 to 16), whose meaning the manufacturer defines.
getAvailableBytesCount() - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
Returns number of incoming bytes that are available to read from the buffer.
getAvailableCipherSuites(int) - Method in class org.metricshub.ipmi.core.connection.Connection
Gets from the managed system supported CipherSuites.
getAvailableCipherSuites(int) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Gets from the managed system supported CipherSuites.
getAvailableCipherSuites(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Gets CipherSuites available for the connection with the remote host.
getAvailableCipherSuites(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Gets CipherSuites available for the connection with the remote host.
getAvailableInstances() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatusResponseData
 
getBaseFrequencyMhz() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the base frequency of the cores (the maximum P1 core frequency).
getBmcKey() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the BMC key (Kg) of the session: the array the handle holds, not a copy, so do not modify it.
getBmcKey() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getBmcKey() - Method in class org.metricshub.ipmi.core.sm.events.OpenSessionAck
 
getBoardManufacturer() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Returns the board manufacturer.
getBoardPartNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Returns the board part number.
getBoardProductName() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Returns the board product name.
getBoardSerialNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Returns the board serial number.
getBusId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getBytes(int) - Static method in class org.metricshub.ipmi.core.common.Randomizer
Generates random bytes.
getCapacity() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the overall capacity of the power supply.
getCapacityMegabytes() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the capacity of the module, as JEDEC computes it from the SDRAM density, the device and bus widths and the ranks.
getChannel() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
getChannelAuthenticationCapabilities(int, CipherSuite, PrivilegeLevel) - Method in class org.metricshub.ipmi.core.connection.Connection
Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the managed system that Connection.getAvailableCipherSuites(int), which must be performed first, read.
getChannelAuthenticationCapabilities(int, CipherSuite, PrivilegeLevel) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the managed system that ConnectionManager.getAvailableCipherSuites(int), which must be performed first, read (requested at the User level).
getChannelAuthenticationCapabilities(ConnectionHandle, CipherSuite, PrivilegeLevel) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the remote host that IpmiAsyncConnector.getAvailableCipherSuites(ConnectionHandle) read (requested at the User level): sends nothing.
getChannelAuthenticationCapabilities(ConnectionHandle, CipherSuite, PrivilegeLevel) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Declares the cipher suite and the privilege of the session, and returns the authentication capabilities of the remote host that IpmiConnector.getAvailableCipherSuites(ConnectionHandle) read (requested at the User level): sends nothing.
GetChannelAuthenticationCapabilities - Class in org.metricshub.ipmi.core.coding.commands.session
Wrapper for Get Channel Authentication Capabilities request
GetChannelAuthenticationCapabilities() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
Initiates class for decoding in 1.5 version.
GetChannelAuthenticationCapabilities(IpmiVersion, IpmiVersion, CipherSuite) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
Initiates class.
GetChannelAuthenticationCapabilities(IpmiVersion, IpmiVersion, CipherSuite, PrivilegeLevel, byte) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
Initiates class.
GetChannelAuthenticationCapabilitiesResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
A wrapper for Get Channel Authentication Capabilities command response
GetChannelAuthenticationCapabilitiesResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
GetChannelCipherSuites - Class in org.metricshub.ipmi.core.coding.commands.session
Wrapper for RMCP+ Get Channel Cipher Suites command.
GetChannelCipherSuites() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
Initiates class for decoding.
GetChannelCipherSuites(byte, byte) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
Initiates class for both encoding and decoding.
GetChannelCipherSuitesPending - Class in org.metricshub.ipmi.core.sm.events
Performed in CiphersWaiting State indcates that not all available CipherSuites were received from the remote system and more GetChannelCipherSuites commands are needed.
GetChannelCipherSuitesPending(int) - Constructor for class org.metricshub.ipmi.core.sm.events.GetChannelCipherSuitesPending
 
GetChannelCipherSuitesResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
Wrapper for Get Channel Cipher Suites response
GetChannelCipherSuitesResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuitesResponseData
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupport
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the channel number of the sensor owner (byte 7 bits 7:4 of the record), 0 for the primary IPMB.
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
 
getChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuitesResponseData
 
GetChannelPayloadSupport - Class in org.metricshub.ipmi.core.coding.commands.payload
A wrapper class for Get Channel Payload Support Command.
GetChannelPayloadSupport() - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupport
Initiates class for decoding.
GetChannelPayloadSupport(byte) - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupport
Initiates class for both encoding and decoding.
GetChannelPayloadSupportResponseData - Class in org.metricshub.ipmi.core.coding.commands.payload
Wrapper for Get Channel Payload Support response
GetChannelPayloadSupportResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupportResponseData
 
getChassisIdentifyState() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Returns the state of the chassis identify (byte 4 bits 5:4), which the BMC reports when it supports the Chassis Identify command and its state (GetChassisStatusResponseData.isChassisIdentifyCommandSupported()).
getChassisPartNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Returns the chassis part number.
getChassisSerialNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Returns the chassis serial number.
GetChassisStatus - Class in org.metricshub.ipmi.core.coding.commands.chassis
Wrapper class for Get Chassis Status request.
GetChassisStatus() - Constructor for class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatus
Initiates GetChassisStatus for encoding and decoding.
GetChassisStatusResponseData - Class in org.metricshub.ipmi.core.coding.commands.chassis
The reply to Get Chassis Status (IPMI 2.0 table 28-3): the current power state, the last power event, the miscellaneous chassis state and, when the BMC sends it, the front panel button capabilities.
GetChassisStatusResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Creates an empty reply, without front panel button capabilities.
getChassisType() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Returns the type of the chassis, coded as the SMBIOS chassis types.
getCipherSuite() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the cipher suite of the session, declared with getChannelAuthenticationCapabilities() or createConnection().
getCipherSuite() - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
 
getCipherSuite() - Method in class org.metricshub.ipmi.core.sm.events.Default
 
getCipherSuite() - Method in class org.metricshub.ipmi.core.sm.events.Rakp2Ack
 
getCipherSuite() - Method in class org.metricshub.ipmi.core.sm.events.StartSession
 
getCipherSuite() - Method in class org.metricshub.ipmi.core.sm.states.SessionValid
 
getCipherSuiteData() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuitesResponseData
 
getCipherSuites(byte[]) - Static method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Builds Cipher Suites collection from raw data received by GetChannelCipherSuites commands.
getClassOfMessage() - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Returns the code of the command in the request data of Chassis Control (IPMI 2.0 table 28-4, byte 1 bits 3:0).
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.fru.BaseUnit
Returns the code of the unit.
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadCompletionCode
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.AddressType
Get address code
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.InstanceModifierType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ModifierUnitUsage
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
Returns the code of the sensor type (IPMI 2.0 table 42-3): the first code of the range for SensorType.Oem (C0h) and SensorType.Reserved (00h).
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sel.EventDirection
Returns the value of the event direction bit.
getCode() - Method in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
Returns the code of the record type: the code of a system event, the first code of the range for the OEM types, -1 for a reserved type.
getCode() - Method in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
getCode() - Method in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationAlgorithm
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacMd5
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha1
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha256
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAesCbc128
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAlgorithm
Returns the algorithm's ID.
getCode() - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityNone
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityAlgorithm
Returns the algorithm's ID.
getCode() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacMd5_128
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha1_96
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha256_128
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityMd5_128
 
getCode() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityNone
 
getCodeRangeMasks() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Returns the code range masks of the record.
getCodeStart() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Returns the compatibility code start value of the record.
getCommand() - Method in exception org.metricshub.ipmi.core.api.sol.SOLException
Returns the command that failed: Get Payload Activation Status, Activate Payload, Set Session Privilege Level, Get Payload Instance Info or Deactivate Payload.
getCommand() - Method in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
Returns the command carried to the controller.
getCommand() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceId
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.ChassisControl
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentify
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatus
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfo
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.fru.ReadFruData
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder
Retrieves command code specific for command represented by this class
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayload
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayload
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupport
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatus
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadInstanceInfo
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdr
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfo
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdr
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfo
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReading
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactors
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.ReserveDeviceSdrRepository
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.ReserveSdrRepository
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntry
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfo
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffset
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.sel.ReserveSel
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.CloseSession
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfo
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
getCommandCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
 
getCompatibilityBase() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Returns the compatibility base of the record.
getCompletionCode() - Method in exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
 
getCompletionCode() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse
 
getConfidentialityAlgorithm() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getConfidentialityAlgorithm() - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
getConfidentialityAlgorithm() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Returns instance of ConfidentialityAlgorithm class.
getConfidentialityAlgorithmCode() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
 
getConfidentialityOverheadSize(int) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAesCbc128
 
getConfidentialityOverheadSize(int) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAlgorithm
Calculates size of the confidentiality header and trailer specific for the algorithm.
getConfidentialityOverheadSize(int) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityNone
 
getConnection(int) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Returns Connection identified by index.
getConnectionHandle() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Returns the connection the console exchanges its packets on: the one of the session it was given, or the one of the session it opened on the port of the payload when the BMC serves SOL on another port.
getConnectionHandle() - Method in exception org.metricshub.ipmi.core.api.sol.SOLException
Returns the connection the failed command was sent on: the one of the session given to the console, or the one of the session the console opened on the port of the payload.
getConnectionHandle() - Method in class org.metricshub.ipmi.core.connection.Session
 
getConsoleRandomNumber() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getConsoleSessionId() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3ResponseData
 
getContainerEntityDeviceAddress() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getContainerEntityDeviceChannel() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getContainerEntityId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getContainerEntityId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getContainerEntityInstance() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getContainerEntityInstance() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getCores() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the number of cores of the processor.
getCount() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfoResponseData
 
getCpuid() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the low 16 bits of the CPUID signature (EAX of CPUID function 1): the processor type, family, model and stepping.
getCurrent() - Method in class org.metricshub.ipmi.core.sm.StateMachine
 
getCurrentPowerState() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Returns the current power state byte as the BMC sent it (byte 2), which the power getters below decode.
getCustomBoardInfo() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Returns the custom fields of the board area, those that follow its predefined fields.
getCustomChassisInfo() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Returns the custom fields of the chassis area, those that follow its predefined fields.
getCustomProductInfo() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the custom fields of the product area, those that follow its predefined fields.
getData() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.InternalUseInfo
Returns the area as it is, format version byte first.
getData() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.RawMultiRecordInfo
Returns the record data, after its header.
getData() - Method in class org.metricshub.ipmi.core.coding.payload.IpmiPayload
 
getData() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
getData() - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
getDefaultCipherSuite() - Static method in class org.metricshub.ipmi.core.connection.Connection
 
getDelTimestamp() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
getDeviceAccessAddress() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the slave address of the controller used to access the FRU device, in its 7-bit form (byte 6 bits 7:1 of the record), 0 when the device is directly on the IPMB.
getDeviceAccessAddress() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getDeviceAddress() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
getDeviceGuid() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getDeviceId() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the device ID (byte 2).
getDeviceId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the FRU device ID of a logical FRU device (byte 7 of the record), the ID that the FRU commands of its controller take, or the 7-bit I2C slave address of a non-logical FRU device (byte 7 bits 7:1).
getDeviceId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
GetDeviceId - Class in org.metricshub.ipmi.core.coding.commands.app
Wrapper for the Get Device ID command (IPMI 2.0 section 20.1): the identity of the controller, its firmware and the functions it provides.
GetDeviceId() - Constructor for class org.metricshub.ipmi.core.coding.commands.app.GetDeviceId
Initiates GetDeviceId for encoding and decoding.
GetDeviceIdResponseData - Class in org.metricshub.ipmi.core.coding.commands.app
Wrapper for the Get Device ID response (IPMI 2.0 table 20-2): the device ID and revision, the firmware revision, the IPMI version, the functions the device provides, the manufacturer and product IDs and the optional auxiliary firmware revision.
GetDeviceIdResponseData(byte[]) - Constructor for class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Decodes the response data.
getDeviceRevision() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the device revision (byte 3, bits 3:0).
getDeviceRevision() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
GetDeviceSdr - Class in org.metricshub.ipmi.core.coding.commands.sdr
Get Device SDR (IPMI 2.0 section 35.3): reads a record of the SDRs a Sensor Device holds itself, for a controller without an SDR Repository.
GetDeviceSdr(int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdr
Creates the command that reads a whole record.
GetDeviceSdr(int, int, int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdr
Creates the command that reads part of a record.
GetDeviceSdrInfo - Class in org.metricshub.ipmi.core.coding.commands.sdr
Get Device SDR Info (IPMI 2.0 section 35.2): how many SDRs a Sensor Device holds itself, or how many sensors it implements at the LUN the request is addressed to.
GetDeviceSdrInfo(boolean) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfo
Creates the command, addressed to LUN 0.
GetDeviceSdrInfo(boolean, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfo
Creates the command, addressed to a LUN of the device: the sensor count is the one of that LUN.
GetDeviceSdrInfoResponseData - Class in org.metricshub.ipmi.core.coding.commands.sdr
The response to GetDeviceSdrInfo (IPMI 2.0 table 35-2).
GetDeviceSdrInfoResponseData(int, boolean, int, Long) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfoResponseData
Creates the response.
getDeviceSlaveAddress() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getDeviceSlaveAddress() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getDeviceType() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the type of the FRU device (byte 11 of the record, IPMI 2.0 table 43-12).
getDeviceType() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getDeviceTypeModifier() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the device type modifier of the FRU device (byte 12 of the record, IPMI 2.0 table 43-12).
getDeviceTypeModifier() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getDramManufacturer() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the manufacturer of the DRAM devices of the module, from its JEDEC JEP106 identification code.
getDtsMax() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the maximum temperature of the digital thermal sensor of the processor.
getElement(int) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Returns the queued request with the given tag, with its one-way flag.
getEmpty() - Static method in class org.metricshub.ipmi.core.coding.security.CipherSuite
 
getEncryptedPayload() - Method in class org.metricshub.ipmi.core.coding.payload.IpmiPayload
Returns encrypted payload encoded in byte array.
getEntityDeviceAddress1() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityDeviceAddress2() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityDeviceAddress3() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityDeviceAddress4() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityDeviceChannel1() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityDeviceChannel2() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityDeviceChannel3() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityDeviceChannel4() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityId() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Returns the entity ID of the record.
getEntityId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the entity the sensor monitors (byte 9 of the record).
getEntityId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getEntityId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
getEntityInstance() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getEntityInstance() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
getEntityInstanceNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the instance number of the entity (byte 10 bits 6:0 of the record).
getEntityRange1() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRange1() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntityRange2() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRange2() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntityRange3() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRange3() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntityRange4() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRange4() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntityRangeInstance1() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRangeInstance1() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntityRangeInstance2() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRangeInstance2() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntityRangeInstance3() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRangeInstance3() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntityRangeInstance4() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
getEntityRangeInstance4() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
getEntriesCount() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Returns the number of entries in the SEL.
getEraseTimestamp() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Returns the time of the most recent erasure of SEL entries as the BMC sent it: a Date of the unsigned 32-bit number of seconds, with no UTC offset applied.
getEvent() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the event of a system event: the state that the event offset (the low 4 bits of byte 14 of the record) designates for the event/reading type and the sensor type.
getEventData() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the three event data bytes of a system event (bytes 14 to 16 of the record).
getEventDirection() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Tells whether a system event is an assertion or a deassertion (byte 13 bit 7 of the record).
getEventReadingType() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the event/reading type code of the sensor: 01h for a threshold sensor, 02h-0Ch for a generic discrete one, 6Fh for a sensor-specific one, 70h-7Fh for an OEM one.
getEventType() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the event/reading type code of a system event (byte 13 bits 6:0 of the record).
getException() - Method in class org.metricshub.ipmi.core.api.async.messages.IpmiError
 
getException() - Method in class org.metricshub.ipmi.core.sm.actions.ErrorAction
 
getExistingSessionForCriteria(InetAddress, int, String) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Returns session already bound to given connection handle fulfilling given criteria.
getExistingSessionForCriteria(InetAddress, int, String) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Returns session already bound to given connection handle fulfilling given criteria.
getFactors() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactorsResponseData
Returns the factors of the requested reading byte, to pass to FullSensorRecord.calcFormula(int, SensorReadingFactors).
getFirmwareRevision() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the firmware revision as ipmitool prints it.
getFirmwareRevision1() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getFirmwareRevision2() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getFrontPanelButtonCapabilities() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Returns the front panel button capabilities byte as the BMC sent it (byte 5, optional).
getFruData() - Method in class org.metricshub.ipmi.core.coding.commands.fru.ReadFruDataResponseData
Returns the bytes returned by the command.
getFruEntityId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the ID of the entity associated with this FRU information (byte 13 of the record, IPMI 2.0 table 43-13).
getFruEntityInstance() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the instance number of the entity associated with this FRU information (byte 14 of the record).
getFruFileId() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Returns the FRU File ID field, a manufacturing aid that identifies the file the FRU information was loaded from.
getFruFileId() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the FRU File ID field, a manufacturing aid that identifies the file the FRU information was loaded from.
GetFruInventoryAreaInfo - Class in org.metricshub.ipmi.core.coding.commands.fru
A wrapper class for Get FRU Inventory Area Info Command.
GetFruInventoryAreaInfo(int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfo
Initiates GetFruInventoryAreaInfo for both encoding and decoding, addressed to LUN 0.
GetFruInventoryAreaInfo(int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfo
Initiates GetFruInventoryAreaInfo for both encoding and decoding.
GetFruInventoryAreaInfoResponseData - Class in org.metricshub.ipmi.core.coding.commands.fru
A wrapper for Get Fru Inventory Area Info response
GetFruInventoryAreaInfoResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfoResponseData
 
getFruInventoryAreaSize() - Method in class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfoResponseData
Returns the size of the FRU inventory area.
getFruUnit() - Method in class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfoResponseData
Returns how the FRU device is accessed.
getGeneratorId() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the generator ID of a system event (bytes 8 and 9 of the record).
getHandle() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the index of the connection in its connector, which is not reused once the connection is closed.
getHandle() - Method in class org.metricshub.ipmi.core.api.async.messages.IpmiResponse
ConnectionHandle to the message that was an origin of the response Handle contains only the id of the connection, not the CipherSuite and PrivilegeLevel used in that connection.
getHandle() - Method in class org.metricshub.ipmi.core.connection.Connection
 
getHighEndInputFrequencyRange() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the high end of the acceptable input frequency range.
getHighEndInputVoltage1() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the high end of the acceptable input voltage range 1.
getHighEndInputVoltage2() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the high end of the acceptable input voltage range 2.
getId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Returns the record ID of the record header (bytes 1 and 2 of the record).
getId() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
 
getId() - Method in class org.metricshub.ipmi.core.connection.queue.QueueElement
 
getIdInstanceModifierOffset() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Suppose sensor ID is 'Temp' for 'Temperature Sensor', share count = 3, ID string instance modifier = numeric, instance modifier offset = 5 - then the sensors could be identified as: Temp 5, Temp 6, Temp 7
If the modifier = alpha, offset=0 corresponds to 'A', offset=25 corresponds to 'Z', and offset = 26 corresponds to 'AA', thus, for offset=26 the sensors could be identified as: Temp AA, Temp AB, Temp AC
getIdInstanceModifierType() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
The instance modifier is a character(s) that software can append to the end of the ID String.
getInboundPayloadSize() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Get inbound payload size
getIndex() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
 
getInstanceCapacity() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatusResponseData
 
getInt() - Static method in class org.metricshub.ipmi.core.common.Randomizer
 
getIntegrityAlgorithm() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getIntegrityAlgorithm() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Returns instance of IntegrityAlgorithm class.
getIntegrityAlgorithmBase(IpmiEncoder) - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
Gets base for integrity algorithm calculations.
getIntegrityAlgorithmCode() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
 
getIntegrityCheckBaseLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationAlgorithm
 
getIntegrityCheckBaseLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacMd5
 
getIntegrityCheckBaseLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha1
 
getIntegrityCheckBaseLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha256
 
getIntegrityCheckBaseLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
 
getIntSequenceNumber() - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
getIpmiCommandData() - Method in class org.metricshub.ipmi.core.coding.payload.IpmiPayload
Returns IPMI command encapsulated in IPMI Payload.
getIpmiCommandData() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
getIpmiCommandData() - Method in class org.metricshub.ipmi.core.coding.payload.PlainMessage
 
getIpmiCommandData() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
getIpmiResponseData() - Method in class org.metricshub.ipmi.core.sm.actions.ResponseAction
 
getIpmiv20Message() - Method in class org.metricshub.ipmi.core.sm.actions.MessageAction
 
getIpmiVersion() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the IPMI version the device implements (byte 6, BCD).
getIpmiVersion() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getIpmiVersion() - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
 
getKeyExchangeAuthenticationCode(byte[], byte[]) - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationAlgorithm
Calculates value of the Key Exchange Authentication Code in RAKP messages
getKeyExchangeAuthenticationCode(byte[], byte[]) - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
Calculates value of the Key Exchange Authentication Code in RAKP messages using the RAKP-None algorithm.
getKeyLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationAlgorithm
 
getKeyLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacMd5
 
getKeyLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha1
 
getKeyLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpHmacSha256
 
getKeyLength() - Method in class org.metricshub.ipmi.core.coding.security.AuthenticationRakpNone
 
getL2KilobytesPerCore() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the size of the mid-level cache (L2) of each core.
getL3Kilobytes() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the size of the last-level cache (L3) of the processor.
getLastPowerEvent() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Returns the last power event byte as the BMC sent it (byte 3).
getLineOperations() - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
 
getLowEndInputFrequencyRange() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the low end of the acceptable input frequency range.
getLowEndInputVoltage1() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the low end of the acceptable input voltage range 1.
getLowEndInputVoltage2() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the low end of the acceptable input voltage range 2.
getLowerCriticalThreshold() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the lower critical threshold of the sensor (byte 41 of the record), converted to the unit of the sensor.
getLowerNonCriticalThreshold() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the lower non-critical threshold of the sensor (byte 42 of the record), converted to the unit of the sensor.
getLowerNonRecoverableThreshold() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the lower non-recoverable threshold of the sensor (byte 40 of the record), converted to the unit of the sensor.
getLunsWithSensors() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfoResponseData
 
getMajorFirmwareRevision() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the major firmware revision (byte 4, bits 6:0, binary).
getManagedSystemGuid() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
getManagedSystemRandomNumber() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
getManagedSystemSessionId() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getManagedSystemSessionId() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getManagedSystemSessionId() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
getManagedSystemSessionId() - Method in class org.metricshub.ipmi.core.connection.Connection
 
getManagedSystemSessionId() - Method in class org.metricshub.ipmi.core.connection.Session
 
getManagedSystemSessionId() - Method in class org.metricshub.ipmi.core.sm.events.OpenSessionAck
 
getManagedSystemSessionId() - Method in class org.metricshub.ipmi.core.sm.events.Rakp2Ack
 
getManagementChannelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the channel number of the management controller used to access the FRU device (byte 9 bits 7:4 of the record), 0 when the device or its controller is on the primary IPMB.
getManufacturer() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the manufacturer of the module, from its JEDEC JEP106 identification code.
getManufacturerId() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the manufacturer ID (bytes 8 to 10, 20 bits), the IANA enterprise number of the manufacturer.
getManufacturerId() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Returns the manufacturer ID of the record.
getManufacturerId() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.OemInfo
Returns the manufacturer ID of the record, which identifies the vendor that defines it.
getManufacturerId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getManufacturerId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.OemRecord
 
getManufacturerId() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the manufacturer ID of a timestamped OEM record (bytes 8 to 10 of the record).
getManufacturerName() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the product manufacturer name.
getManufacturingWeek() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the week of the year the module was manufactured.
getManufacturingYear() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the year the module was manufactured.
getMaxFrequencyMhz() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the maximum turbo frequency of the cores (the maximum P0 core frequency).
getMaximumCurrentLoad() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Returns the maximum current load of the device on the output.
getMaximumInrush() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the maximum inrush of current into the power supply.
getMaximumNegativeDeviation() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Returns the maximum negative deviation from the nominal voltage.
getMaximumPositiveDeviation() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Returns the maximum positive deviation from the nominal voltage.
getMaximumVoltage() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Returns the maximum voltage the device accepts.
getMaxSessions() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
getMemoryType() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the DRAM device type: DDR3, DDR4 or DDR5.
getMessage() - Method in enum org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadCompletionCode
 
getMessage() - Method in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
 
getMessage() - Method in exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
 
getMessage() - Method in class org.metricshub.ipmi.core.common.MessageComposer
Returns final message consisting all messages appended till now.
getMessage() - Method in class org.metricshub.ipmi.core.transport.UdpMessage
 
getMessageSequenceNumber() - Method in class org.metricshub.ipmi.core.sm.events.CloseSession
 
getMessageSequenceNumber() - Method in class org.metricshub.ipmi.core.sm.events.Sendv20Message
 
getMessageTag() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getMessageTag() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
getMessageTag() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3ResponseData
 
getMfgDate() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Returns the manufacturing date and time of the board, which the area gives as minutes since 1996-01-01 00:00 UTC (FRU specification section 11).
getMinimumCurrentLoad() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Returns the minimum current load of the device on the output.
getMinimumVoltage() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Returns the minimum voltage the device accepts.
getMinorFirmwareRevision() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the minor firmware revision byte (byte 5).
getMiscChassisState() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Returns the miscellaneous chassis state byte as the BMC sent it (byte 4).
getModifierUnitUsage() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns how the modifier unit combines with the base unit (Sensor Units 1 bits 2:1): none, divided by or multiplied by.
getModuleType() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the module type: RDIMM, UDIMM, SO-DIMM, LRDIMM...
getName() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the sensor ID string of the record.
getName() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Returns the device ID string of the FRU device (from byte 17 of the record), decoded by its type/length byte (byte 16).
getName() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
getName() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceId
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.ChassisControl
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentify
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatus
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfo
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.fru.ReadFruData
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder
Retrieves network function specific for command represented by this class.
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayload
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayload
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupport
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatus
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadInstanceInfo
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdr
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfo
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdr
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfo
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReading
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactors
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.ReserveDeviceSdrRepository
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.ReserveSdrRepository
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntry
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfo
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffset
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.sel.ReserveSel
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.CloseSession
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfo
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
 
getNetworkFunction() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
Returns the network function, when it is one NetworkFunction lists.
getNetworkFunctionCode() - Method in class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder
Returns the network function code of the request (6 bits, IPMI 2.0 table 5-1): the code of IpmiCommandCoder.getNetworkFunction() by default.
getNetworkFunctionCode() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
Returns the raw network function code (6 bits), which may be one NetworkFunction does not list: Transport (0Ch), Group Extension (2Ch), OEM/Group (2Eh), controller-specific OEM (30h-3Fh), IPMI 2.0 table 5-1.
getNextReading() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactorsResponseData
Returns the next reading byte for which the BMC defines other factors; when the requested byte matches no entry of the table of the BMC, the byte that would have matched the returned factors exactly.
getNextRecordId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrResponseData
 
getNextRecordId() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntryResponseData
 
getNextSessionSequenceNumber() - Method in class org.metricshub.ipmi.core.connection.Connection
 
getNominalReading() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the nominal reading of the sensor (byte 32 of the record), converted to the unit of the sensor, whether or not the analog characteristic flags of byte 31 (bit 0) say that the record specifies it.
getNominalVoltage() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Returns the nominal voltage the device requires.
getNominalVoltage() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Returns the nominal voltage of the output.
getNormalMaximum() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the normal maximum of the sensor (byte 33 of the record), converted to the unit of the sensor, whether or not the analog characteristic flags of byte 31 (bit 1) say that the record specifies it.
getNormalMinimum() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the normal minimum of the sensor (byte 34 of the record), converted to the unit of the sensor, whether or not the analog characteristic flags of byte 31 (bit 2) say that the record specifies it.
getNvmDimmMaxCapacityGigabytes() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the maximum capacity of non-volatile memory DIMMs (persistent memory) the processor supports, as the datasheet names the field; on the processors seen it equals the maximum memory of the model.
getOemData() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.OemInfo
Returns the OEM data of the record.
getOemData() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.OemRecord
 
getOemData() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the OEM-defined bytes of an OEM record.
getOemData() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
getOemIANA() - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
getOemId() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
getOemPayloadID() - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
getOffsetMinutes() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffsetResponseData
 
getOperationField() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolOutboundMessage
 
getOperationNumber() - Method in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
Returns the bit of the operation in the Operation/Status byte of a SOL packet to the BMC (IPMI 2.0 table 15-2).
getOperations() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolOutboundOperationField
 
getOutboundPayloadSize() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Get outbound payload size
getOutputNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Returns the number of the DC output the device draws from.
getOutputNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Returns the number of the DC output.
getPartNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the part number marked on the processor: the Intel family number followed by the SKU number.
getPartNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the part number of the module, as the manufacturer programmed it.
getPassword() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the password of the session, decoded from UTF-8.
getPassword() - Method in class org.metricshub.ipmi.core.sm.events.OpenSessionAck
 
getPasswordBytes() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the password of the session as bytes: the array the handle holds, not a copy, so do not modify it.
getPayload() - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
GetPayloadActivationStatus - Class in org.metricshub.ipmi.core.coding.commands.payload
Wrapper for Get Payload Activation Status Command.
GetPayloadActivationStatus(PayloadType) - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatus
Creates the command.
GetPayloadActivationStatusResponseData - Class in org.metricshub.ipmi.core.coding.commands.payload
Wrapper for Get Payload Activation Status response.
GetPayloadActivationStatusResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatusResponseData
 
getPayloadCoder() - Method in class org.metricshub.ipmi.core.sm.events.Sendv20Message
 
getPayloadData() - Method in class org.metricshub.ipmi.core.coding.payload.IpmiPayload
Returns unencrypted payload encoded in byte array (owner is responsible for encryption).
getPayloadData() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
Converts IpmiLanMessage to byte array.
getPayloadData() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest
 
getPayloadData() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse
Deprecated.
LAN response does not hve payload data
getPayloadData() - Method in class org.metricshub.ipmi.core.coding.payload.PlainMessage
 
getPayloadData() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
GetPayloadInstanceInfo - Class in org.metricshub.ipmi.core.coding.commands.payload
Wrapper for the Get Payload Instance Info command (IPMI 2.0 section 24.5): the session where an instance of a payload is active.
GetPayloadInstanceInfo(PayloadType, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadInstanceInfo
Creates the command.
GetPayloadInstanceInfoResponseData - Class in org.metricshub.ipmi.core.coding.commands.payload
Response of the Get Payload Instance Info command (IPMI 2.0 table 24-7).
GetPayloadInstanceInfoResponseData(int) - Constructor for class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadInstanceInfoResponseData
 
getPayloadLength() - Method in class org.metricshub.ipmi.core.coding.payload.IpmiPayload
Returns encoded but UNENCRYPTED payload length.
getPayloadLength() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
Gets expected size of LAN message in bytes.
getPayloadLength() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest
 
getPayloadLength() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse
 
getPayloadLength() - Method in class org.metricshub.ipmi.core.coding.payload.PlainMessage
 
getPayloadLength() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
getPayloadLength() - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
getPayloadType() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayload
 
getPayloadType() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivateSolPayload
 
getPayloadType() - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
getPayloadUdpPortNumber() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Get payload udp port number
getPayloadVlanNumber() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Get payload vlan number
getPeakVa() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Returns the highest instantaneous VA value that the power supply draws during operation.
getPlainSensorReading() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Returns the reading byte as the BMC sent it (byte 2), unsigned and not converted.
getPopulationChangeIndicator() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfoResponseData
 
getPort() - Method in class org.metricshub.ipmi.core.transport.UdpMessage
Target port when sending message.
getPort() - Method in class org.metricshub.ipmi.core.transport.UdpMessenger
 
getPowerRestorePolicy() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Returns the power restore policy: what the chassis does when AC power returns (byte 2 bits 6:5).
getPpin() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the Protected Processor Inventory Number, the unique identification number of the processor (the one the PPIN MSR gives).
getPrivilegeLevel() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the maximum privilege level requested for the session, declared with getChannelAuthenticationCapabilities() or createConnection(): PrivilegeLevel.MaximumAvailable stays MaximumAvailable, whatever level the session runs at.
getPrivilegeLevel() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
getPrivilegeLevel() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getPrivilegeLevel() - Method in class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
Returns the level the command requests.
getPrivilegeLevel() - Method in class org.metricshub.ipmi.core.sm.events.AuthenticationCapabilitiesReceived
 
getPrivilegeLevel() - Method in class org.metricshub.ipmi.core.sm.events.Default
 
getProductId() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Returns the product ID (bytes 11 and 12).
getProductId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
getProductModelNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the product part or model number.
getProductName() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the product name.
getProductSerialNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the product serial number.
getProductVersion() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Returns the product version.
getRaisedPrivilegeLevel() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Returns the privilege the console raised the session of the payload to, when that session was opened with PrivilegeLevel.MaximumAvailable and the BMC refused to activate the payload at its level: the owner of the session (see SerialOverLan.getConnectionHandle()) runs it at that level from then on.
getRakp1ResponseData() - Method in class org.metricshub.ipmi.core.sm.events.Rakp2Ack
 
getRateUnit() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the rate unit of the reading (Sensor Units 1 bits 5:3).
getRaw() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Returns the response data as the BMC sent it, from byte 2 (the completion code is not included).
getRawCode() - Method in exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
 
getRawCompletionCode() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse
 
getRawData() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the 16 bytes of the record as the BMC sent them.
getReading() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the reading that triggered a threshold event (event data 2, byte 15 of the record), as the raw byte that FullSensorRecord.calcFormula(int) converts.
getReadingType(ReadingType) - Static method in class org.metricshub.ipmi.client.ReadingTypeDescription
Returns the description of a state or event.
getRecordCount() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
getRecordId() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the record ID of the entry (bytes 1 and 2 of the record).
getRecordLength() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Returns the record length (byte 5 of the record): the number of bytes after the 5-byte header.
getRecordType() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessInfo
Returns the kind of management access information the record holds.
getRecordType() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.RawMultiRecordInfo
Returns the record type ID.
getRecordType() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Returns the record type code (byte 4 of the record), as a signed byte: the OEM types C0h-FFh are negative, getRecordType() & 0xFF gives the unsigned code.
getRecordType() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the type of the record (byte 3 of the record, IPMI 2.0 section 31.6.1): a system event, an OEM record with or without a timestamp, or a reserved type.
getRemoteAddress() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the address of the BMC.
getRemoteConsoleSessionId() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getRemoteConsoleSessionId() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
getRemoteMachineAddress() - Method in class org.metricshub.ipmi.core.connection.Connection
 
getRemoteMachineAddress() - Method in class org.metricshub.ipmi.core.sm.StateMachine
 
getRemoteMachinePort() - Method in class org.metricshub.ipmi.core.connection.Connection
 
getRemoteMachinePort() - Method in class org.metricshub.ipmi.core.sm.StateMachine
 
getRemotePort() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the UDP port of the BMC.
getRequest() - Method in class org.metricshub.ipmi.core.connection.queue.QueueElement
 
getRequestedMaximumPrivilegeLevel() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getRequestedPrivilegeLevel() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
 
getRequestedPrivilegeLevel() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
getRequesterAddress() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
getRequesterLogicalUnitNumber() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
getRequestSequenceNumber() - Method in class org.metricshub.ipmi.core.coding.sol.SolResponseData
 
getReservationId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.ReserveSdrRepositoryResponseData
 
getReservationId() - Method in class org.metricshub.ipmi.core.coding.commands.sel.ReserveSelResponseData
 
getResponderAddress() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
getResponderLogicalUnitNumber() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
getResponseData() - Method in class org.metricshub.ipmi.core.api.async.messages.IpmiResponseData
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceId
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.chassis.ChassisControl
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentify
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatus
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfo
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.fru.ReadFruData
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayload
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayload
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupport
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatus
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadInstanceInfo
Decodes the response: the session ID (LS-byte first), then 8 bytes of payload-specific information (table 24-7).
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfo
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdr
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfo
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReading
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactors
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.ReserveSdrRepository
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntry
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfo
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffset
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.sel.ReserveSel
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.CloseSession
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfo
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
 
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
Retrieves payload-specific response data from IPMI message
getResponseData(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.sol.SolCoder
 
getRetries() - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Returns how many times a message without a reply is sent again.
getRetries() - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Returns how many times a message without a reply is sent again.
GetSdr - Class in org.metricshub.ipmi.core.coding.commands.sdr
Wrapper for Get SDR command.
GetSdr(int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSdr
Initiates GetSdr for both encoding and decoding.
GetSdr(int, int, int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSdr
Initiates GetSdr for both encoding and decoding.
GetSdrRepositoryInfo - Class in org.metricshub.ipmi.core.coding.commands.sdr
A wrapper class for Get SDR Repository Info Command.
GetSdrRepositoryInfo() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfo
Initiates GetSdrRepositoryInfo for both encoding and decoding.
GetSdrRepositoryInfoResponseData - Class in org.metricshub.ipmi.core.coding.commands.sdr
Wrapper for Get SDR Repository Info response.
GetSdrRepositoryInfoResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
GetSdrResponseData - Class in org.metricshub.ipmi.core.coding.commands.sdr
Wrapper for Get SDR command response.
GetSdrResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrResponseData
 
getSdrVersion() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
getSdrVersion() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Returns the version of the sensor model specification the record complies with (byte 3 of the record), BCD-decoded: 15 for 51h, version 1.5.
GetSelEntry - Class in org.metricshub.ipmi.core.coding.commands.sel
Wrapper for Get Sel Entry request
GetSelEntry(int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntry
Initiates GetSelEntry for both encoding and decoding.
GetSelEntryResponseData - Class in org.metricshub.ipmi.core.coding.commands.sel
Wrapper for Get Sel Entry response
GetSelEntryResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntryResponseData
 
GetSelInfo - Class in org.metricshub.ipmi.core.coding.commands.sel
Wrapper class for Get SEL Info request.
GetSelInfo() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfo
Initiates GetSelInfo for both encoding and decoding.
GetSelInfoResponseData - Class in org.metricshub.ipmi.core.coding.commands.sel
The reply to Get SEL Info (IPMI 2.0 section 31.2): the version of the SEL, its number of entries and the times of its last addition and erasure.
GetSelInfoResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
 
getSelRecord() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntryResponseData
 
GetSelTimeUtcOffset - Class in org.metricshub.ipmi.core.coding.commands.sel
Wrapper for the Get SEL Time UTC Offset command (IPMI 2.0 revision 1.1, section 31.11a): the offset from UTC of the SEL time, for a BMC that keeps its SEL time as local time.
GetSelTimeUtcOffset() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffset
Initiates GetSelTimeUtcOffset for both encoding and decoding.
GetSelTimeUtcOffsetResponseData - Class in org.metricshub.ipmi.core.coding.commands.sel
Wrapper for the Get SEL Time UTC Offset response.
GetSelTimeUtcOffsetResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffsetResponseData
 
getSelVersion() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Returns the version of the SEL command set, BCD-decoded: 15 for 51h, version 1.5.
getSensorBaseUnit() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the base unit of the reading (Sensor Units 2, IPMI 2.0 table 43-15).
getSensorDirection() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the direction of the sensor: whether it monitors an input or an output of the entity.
getSensorMaximumReading() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the maximum reading of the sensor (byte 35 of the record), converted to the unit of the sensor.
getSensorMinmumReading() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the minimum reading of the sensor (byte 36 of the record), converted to the unit of the sensor.
getSensorModifierUnit() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the modifier unit of the reading (Sensor Units 3, IPMI 2.0 table 43-15).
getSensorNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the number of the sensor (byte 8 of the record), the one the commands that read the sensor take.
getSensorNumber() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the number of the sensor that generated a system event (byte 12 of the record): with the generator ID (SelRecord.getGeneratorId()), it identifies the sensor.
getSensorOwnerId() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the sensor owner ID (byte 6 bits 7:1 of the record): the 7-bit I2C slave address of the controller that owns the sensor, or a system software ID (AbstractSensorRecord.getAddressType()).
getSensorOwnerLun() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the LUN of the sensor owner (byte 7 bits 1:0 of the record), the LUN of the commands that read the sensor.
getSensorReading(FullSensorRecord) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Returns the reading converted to the unit of the sensor with the factors of its Full Sensor Record (FullSensorRecord.calcFormula(int)).
GetSensorReading - Class in org.metricshub.ipmi.core.coding.commands.sdr
Wrapper for Get Sensor Reading request.
GetSensorReading(int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReading
Initiates class for both encoding and decoding, for a sensor at LUN 0 of its owner.
GetSensorReading(int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReading
Initiates class for both encoding and decoding.
GetSensorReadingFactors - Class in org.metricshub.ipmi.core.coding.commands.sdr
Get Sensor Reading Factors (IPMI 2.0 section 35.5): the factors that convert a given reading of a non-linear sensor.
GetSensorReadingFactors(int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactors
Creates the command for a sensor at LUN 0 of its owner.
GetSensorReadingFactors(int, int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactors
Creates the command.
GetSensorReadingFactorsResponseData - Class in org.metricshub.ipmi.core.coding.commands.sdr
Reply to Get Sensor Reading Factors (IPMI 2.0 table 35-5).
GetSensorReadingFactorsResponseData(int, SensorReadingFactors) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingFactorsResponseData
Creates the reply.
GetSensorReadingResponseData - Class in org.metricshub.ipmi.core.coding.commands.sdr
The reply to Get Sensor Reading (IPMI 2.0 table 35-15): the reading byte, the status bits and the threshold or discrete states of the sensor.
GetSensorReadingResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
 
getSensorRecordData() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrResponseData
 
getSensorResolution() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the resolution of a linear sensor: the difference in units between two successive raw readings, |M x 10^R| (IPMI 2.0 section 36.4.2).
getSensorState() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Returns the most severe threshold the reading is at or beyond (byte 4 bits 5:0), for a threshold sensor: the value means nothing for a discrete sensor.
getSensorType() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the type of the sensor (IPMI 2.0 table 42-3).
getSensorType() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the type of the sensor that generated a system event (byte 11 of the record).
getSensorTypeCode() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Returns the sensor type code of the record (IPMI 2.0 table 42-3), which AbstractSensorRecord.getSensorType() does not keep for an OEM (C0h to FFh) or reserved code.
getSensorTypeCode() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the sensor type code of a system event (byte 11 of the record, IPMI 2.0 table 42-3), which SelRecord.getSensorType() does not keep for an OEM (C0h to FFh) or reserved code.
getSequenceNumber() - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
getSequenceNumber() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
getSequenceNumber() - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
getSequenceNumber() - Method in class org.metricshub.ipmi.core.connection.MessageHandler
Returns a sequence number for a message sent outside the queue (the Close Session request).
getSequenceNumber() - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Returns a sequence number for a message sent outside the queue (the Close Session request): it skips the tags of the queued requests.
getSequenceNumber() - Method in class org.metricshub.ipmi.core.sm.events.Default
 
getSequenceNumber() - Method in class org.metricshub.ipmi.core.sm.events.Rakp2Ack
 
getSerialNumber() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Returns the serial number of the module.
getSession() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Returns the session the console exchanges its packets in: the session it was given, or the one it opened on the port of the payload when the BMC serves SOL on another port.
getSessionForCriteria(InetAddress, int, String) - Method in class org.metricshub.ipmi.core.connection.SessionManager
Returns session already bound to given connection handle fulfilling given criteria.
getSessionHandle() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
getSessionId() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadInstanceInfoResponseData
 
getSessionId() - Method in class org.metricshub.ipmi.core.connection.Session
 
getSessionId() - Method in class org.metricshub.ipmi.core.sm.events.AuthenticationCapabilitiesReceived
 
getSessionId() - Method in class org.metricshub.ipmi.core.sm.events.Authorize
 
getSessionId() - Method in class org.metricshub.ipmi.core.sm.events.CloseSession
 
getSessionId() - Method in class org.metricshub.ipmi.core.sm.events.Sendv20Message
 
getSessionId() - Method in class org.metricshub.ipmi.core.sm.events.StartSession
 
getSessionID() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
getSessionID() - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
GetSessionInfo - Class in org.metricshub.ipmi.core.coding.commands.session
Get Session Info (IPMI 2.0 section 22.20), looking a session up by its session ID: what the BMC knows of it.
GetSessionInfo(int) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfo
Creates a Get Session Info request for the session with the given session ID.
GetSessionInfoResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
The reply to Get Session Info (IPMI 2.0 table 22-26): the session counts of the BMC, and the user ID, privilege level and channel of the session looked up when the BMC has it.
GetSessionInfoResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
getSessionSequenceNumber() - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
getSessionSequenceNumber() - Method in class org.metricshub.ipmi.core.sm.events.CloseSession
 
getSessionSequenceNumber() - Method in class org.metricshub.ipmi.core.sm.events.Sendv20Message
 
getShareCount() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sensor numbers sharing this record are sequential starting with the sensor number specified by the Sensor Number field for this record.
getSik() - Method in class org.metricshub.ipmi.core.sm.actions.GetSikAction
 
GetSikAction - Class in org.metricshub.ipmi.core.sm.actions
Returns the Session Integrity Key calculated after receiving RAKP Message 2.
GetSikAction(byte[]) - Constructor for class org.metricshub.ipmi.core.sm.actions.GetSikAction
 
getSize() - Method in enum org.metricshub.ipmi.core.coding.commands.fru.BaseUnit
Returns the size of the unit in bytes.
getSSpec() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the S-spec (or QDF) number of the processor, which identifies its exact model and stepping: SR3GH for an Intel Xeon Silver 4110.
getStatesAsserted(SensorType, int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Returns the states the sensor asserts (bytes 4 and 5): for a discrete sensor, one state per bit set; for a threshold sensor, the going-low or going-high event of each threshold the reading is at or beyond.
getStatusCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
getStatusCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
getStatusCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
getStatusCode() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3ResponseData
 
getStatusCode() - Method in class org.metricshub.ipmi.core.sm.events.Rakp2Ack
 
getStatuses() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolInboundStatusField
 
getStatuses() - Method in class org.metricshub.ipmi.core.coding.sol.SolResponseData
 
getStatusField() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolInboundMessage
 
getStatusNumber() - Method in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
Returns the bit of the status in the Operation/Status byte of a SOL packet from the BMC (IPMI 2.0 table 15-2).
getSupportedPayloads() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupportResponseData
 
getSupportedPayloadType() - Method in class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder
 
getSupportedPayloadType() - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
 
getSupportedPayloadType() - Method in class org.metricshub.ipmi.core.coding.sol.SolCoder
 
getSystemClockMhz() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the system clock frequency.
getTag() - Method in class org.metricshub.ipmi.core.api.async.messages.IpmiResponse
Tag of the message that is associated with the IpmiResponse
getTcaseMax() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the maximum case temperature of the processor.
getTdpWatts() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Returns the thermal design power of the processor.
getTimeout() - Method in class org.metricshub.ipmi.core.connection.Connection
 
getTimeout() - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Returns the timeout of the messages of the connections created from now on.
getTimeout() - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
 
getTimeout(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Returns the timeout of a single message on the given connection.
getTimeout(ConnectionHandle) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Returns the timeout of a single message on the connection with the given handle.
getTimestamp() - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Returns the timestamp of the record as the BMC sent it (bytes 4 to 7 of the record): a Date of the unsigned 32-bit number of seconds, with no UTC offset applied.
getTimestamp() - Method in class org.metricshub.ipmi.core.connection.queue.QueueElement
 
getTolerance() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the tolerance of the readings of the sensor, in its unit, from the factors of the record (IPMI 2.0 section 36.4.1).
getTolerance() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorReadingFactors
Returns the tolerance, in the units of the sensor.
getUnit() - Method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
getUpperCriticalThreshold() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the upper critical threshold of the sensor (byte 38 of the record), converted to the unit of the sensor.
getUpperNonCriticalThreshold() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the upper non-critical threshold of the sensor (byte 39 of the record), converted to the unit of the sensor.
getUpperNonRecoverableThreshold() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Returns the upper non-recoverable threshold of the sensor (byte 37 of the record), converted to the unit of the sensor.
getUser() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the user name of the session, set by openSession().
getUserId() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
getUsername() - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
getUsername() - Method in class org.metricshub.ipmi.core.sm.events.OpenSessionAck
 
getVersion() - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
Gigabit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Gigabyte - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Gilberts - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Grams - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Gravities - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Gray - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Group - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
This is a logical entity for use with Entity Association records.

H

HandHeld - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
handleIncomingMessage(Ipmiv20Message) - Method in class org.metricshub.ipmi.core.connection.MessageHandler
Checks if received message is inside "sliding window range" and was not received yet, and if so, further processes the message in a implementation-specific way.
HardReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Hard reset.
HardReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
HardwareChangeDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Informational.
HardwareIncompatibilityDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
hasAnalogReading() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Tells whether the reading byte of this sensor converts to a value: false for a discrete sensor (an event/reading type other than 01h, whose Get Sensor Reading reply carries states, IPMI 2.0 section 42.1 and table 35-15), when the data format of Sensor Units 1 is 11b (no analog reading, Table 43-1), or when the linearization is reserved.
hashCode() - Method in class org.metricshub.ipmi.client.SelEntry
 
hashCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayload
 
hashCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayload
 
hashCode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatus
 
hashCode() - Method in class org.metricshub.ipmi.core.coding.sol.SolCoder
 
hashCode() - Method in class org.metricshub.ipmi.core.sm.events.Sendv20Message
 
HecetaASIC - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Henry - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Hit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
host() - Method in class org.metricshub.ipmi.client.IpmiClient
Returns the host name or IP address of the BMC.
HotSpare - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Hour - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Hours - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
Hz - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

I

IA_HMAC_MD5_128 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Integrity algorithm = HMAC-MD5-128
IA_HMAC_SHA1_96 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Integrity algorithm = HMAC-SHA1-96
IA_HMAC_SHA256_128 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Integrity algorithm = HMAC-SHA256-128
IA_MD5_128 - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Integrity algorithm = MD5-128
IA_NONE - Static variable in class org.metricshub.ipmi.core.coding.security.SecurityConstants
Integrity algorithm = none
id() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the device ID the manufacturer gives the controller, 0 when unspecified.
id() - Method in class org.metricshub.ipmi.client.Fru
Returns the FRU device ID, 0 for the FRU of the system board.
id() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the record ID of the entry, unique in the log; after a Clear SEL or a Delete SEL Entry, the BMC may give it to another entry (IPMI 2.0 sections 31.4.1 and 31.4.2).
identifyState() - Method in class org.metricshub.ipmi.client.ChassisStatus
Returns the state of the chassis identify LED.
ids(int...) - Method in class org.metricshub.ipmi.client.FrusRequest
Reads only the FRUs with the given device IDs (0 is the system board on most BMCs), on every controller and LUN: a device ID is unique per controller and LUN only.
Ierr - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
IllegalCommand - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command illegal for specified sensor or record type.
IllegalOrUnrecognizedParameter - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Illegal or unrecognized parameter.
IllegalParameter - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Cannot execute command.
InactiveSessionID - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Inactive session ID.
InboundMessageListener - Interface in org.metricshub.ipmi.core.api.async
Interface for incoming payloads.
InboundSolMessageListener - Class in org.metricshub.ipmi.core.api.async
Listener for inbound SOL messages sent by remote system to this application: it buffers their characters and acknowledges them (IPMI 2.0 sections 15.9 and 15.11).
InboundSolMessageListener(IpmiConnector, ConnectionHandle, List<SolEventListener>) - Constructor for class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
Creates the listener of the SOL packets of a connection.
Inches - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
InCriticalArray - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
IndefiniteOn - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
 
InFailedArray - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
info() - Method in class org.metricshub.ipmi.client.SelEntryList
Returns the Get SEL Info reply of the protocol core, for everything else.
Informational - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
InitializationInProgress - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command response could not be provided.
initialize(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.IntegrityAlgorithm
Initializes Integrity Algorithm
initialize(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.IntegrityMd5_128
Keys the algorithm with the user's password (not the Session Integrity Key), zero-padded to 20 bytes.
initialize(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.IntegrityNone
 
initialize(byte[], AuthenticationAlgorithm) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAesCbc128
 
initialize(byte[], AuthenticationAlgorithm) - Method in class org.metricshub.ipmi.core.coding.security.ConfidentialityAlgorithm
Initializes Confidentiality Algorithm
initializeAlgorithms(byte[]) - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Initializes algorithms contained in this CipherSuite.
initializeAlgorithms(byte[], byte[]) - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Initializes algorithms contained in this CipherSuite: the HMAC integrity algorithms and the confidentiality algorithm are keyed with the Session Integrity Key, MD5-128 integrity (suites 11 to 14) with the user's password (IPMI 2.0 section 13.28.4).
input() - Method in class org.metricshub.ipmi.client.SolConsole
Returns the characters the system writes on its serial port.
Input - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
 
InstallError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
InstanceModifierType - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
 
InsufficentPrivilege - Static variable in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Deprecated.
use CompletionCode.InsufficientPrivilege; this alias will be removed in 3.0.
InsufficientPrivilege - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Cannot execute command due to insufficient privilege level or other security - based restriction (e.g.
InsufficientResources - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Insufficient resources to create a session.
InsufficientResourcesForRole - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Insufficient resources to create a session at the requested role.
IntegrityAlgorithm - Class in org.metricshub.ipmi.core.coding.security
Interface for Integrity Algorithms.
IntegrityHmacMd5_128 - Class in org.metricshub.ipmi.core.coding.security
HMAC-MD5-128 integrity algorithm.
IntegrityHmacMd5_128() - Constructor for class org.metricshub.ipmi.core.coding.security.IntegrityHmacMd5_128
Initiates HMAC-MD5-128 integrity algorithm.
IntegrityHmacSha1_96 - Class in org.metricshub.ipmi.core.coding.security
HMAC-SHA1-96 integrity algorithm.
IntegrityHmacSha1_96() - Constructor for class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha1_96
Initiates HMAC-SHA1-96 integrity algorithm.
IntegrityHmacSha256_128 - Class in org.metricshub.ipmi.core.coding.security
HMAC-SHA256-128 integrity algorithm.
IntegrityHmacSha256_128() - Constructor for class org.metricshub.ipmi.core.coding.security.IntegrityHmacSha256_128
Initiates HMAC-SHA1-96 integrity algorithm.
IntegrityMd5_128 - Class in org.metricshub.ipmi.core.coding.security
MD5-128 integrity algorithm (IPMI 2.0 section 13.28.4): a plain MD5 of the password around the message, AuthCode = MD5(password + AuthType/Format ... Next Header + password), where the password is the user's key (Kuid) zero-padded to 20 bytes as the BMC stores it.
IntegrityMd5_128() - Constructor for class org.metricshub.ipmi.core.coding.security.IntegrityMd5_128
Initiates the MD5-128 integrity algorithm.
IntegrityNone - Class in org.metricshub.ipmi.core.coding.security
Class representing RAKP-None integrity algorithm
IntegrityNone() - Constructor for class org.metricshub.ipmi.core.coding.security.IntegrityNone
Initiates the IntegrityNone algorithm
IntelligentBatteryController - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
interlock() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether the chassis interlock is active: the system is powered down because a panel is open.
INTERLOCK - Enum constant in enum org.metricshub.ipmi.client.PowerEvent
The last power down of the system was caused by a chassis interlock, such as an open panel.
InterlockAsserted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
This is typically connected to a switch that mechanically enables/disables power to the slot, or locks the slot in the 'Ready for Installation / Ready for Removal states' - depending on the slot implementation.
InterlockPowerDown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
InternalUseInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
The internal use area of a FRU (FRU specification section 9): vendor-private data, kept as it is.
InternalUseInfo(byte[], int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.InternalUseInfo
Creates the record.
intrusion() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether a chassis intrusion is active.
intToByte(int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Because Java doesn't support unsigned byte values, simple type casting leads to overflows and wrong values.
intToByteArray(int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts int to byte array in BigEndian convention.
intToLittleEndianByteArray(int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts int to byte array in LittleEndian convention.
intToLittleEndianWord(int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts int to LittleEndian word (double bytes array).
intToWord(int) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts int to BigEndian word (double bytes array).
Invalid - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
InvalidAuthenticationAlgorithm - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid authentication algorithm.
InvalidBootSector - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
InvalidCommand - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Used to indicate an unrecognized or unsupported command.
InvalidConfidentialityAlgorithm - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid confidentiality algorithm.
InvalidData - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid data field in Request.
InvalidId - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid session ID.
InvalidIntegrityAlgorithm - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid integrity algorithm.
InvalidIntegrityCheckValue - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid integrity check value.
InvalidLun - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command invalid for given LUN.
InvalidNameLength - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid name length.
InvalidOrUnsupportedFirmwareOrSoftware - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
InvalidOrUnsupportedHardware - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
InvalidPasswordDisable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
A user's access has been disabled due to a series of bad password attempts.
InvalidPayloadType - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid payload type.
InvalidRequestLength - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Request data length invalid.
InvalidRole - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid role.
InvalidSessionHandle - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid Session Handle in request.
InvalidSessionId - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Invalid Session ID in request.
InvalidUsernameOrPassword - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
An Invalid Username or Password was received during the session establishment process.
invokeOperations(SolOperation...) - Method in class org.metricshub.ipmi.client.SolConsole
Sends the given operations to the serial port of the system: a break, a flush, the state of the control lines (IPMI 2.0 table 15-2).
invokeOperations(SolOperation...) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Invokes given SOL-specific operations on remote serial port.
IoCardAreaIntrusion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
IoChannelCheckNmi - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
IoModule - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
A module that contains the main elements of an I/O interface.
IoPort - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
IPMB_EVENT_GENERATOR - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device generates events over the IPMB (bit 5).
IPMB_EVENT_RECEIVER - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device receives events over the IPMB (bit 4).
IpmbSlaveAddress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.AddressType
IPMB Slave Address
Ipmi - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
IPMI packet
Ipmi - Enum constant in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
 
IPMI_COMMAND - Enum constant in enum org.metricshub.ipmi.client.PowerEvent
The last power on of the system was requested by an IPMI command, such as Chassis Control.
IPMI_PORT - Static variable in class org.metricshub.ipmi.core.common.Constants
The port BMC is listening for IPMI messages on.
ipmi20() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Tells whether the BMC supports IPMI 2.0 (RMCP+) sessions: always true, as IpmiClient.capabilities() fails with IpmiClientException for a BMC without them.
Ipmi20UnsupportedException - Exception in org.metricshub.ipmi.core.connection
The BMC does not support IPMI 2.0 (RMCP+): its reply to Get Channel Authentication Capabilities, in the IPMI v1.5 format, reports no IPMI v2.0 connections (IPMI 2.0 table 22-15).
Ipmi20UnsupportedException(String) - Constructor for exception org.metricshub.ipmi.core.connection.Ipmi20UnsupportedException
Creates the exception.
IpmiAsyncConnector - Class in org.metricshub.ipmi.core.api.async
Asynchronous API for connecting to BMC via IPMI.
IpmiAsyncConnector(int) - Constructor for class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Starts IpmiAsyncConnector and initiates the ConnectionManager at the given port.
IpmiAsyncConnector(int, long) - Constructor for class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Starts IpmiAsyncConnector and initiates the ConnectionManager at the given port and ping period.
IpmiAsyncConnector(int, InetAddress) - Constructor for class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Starts IpmiAsyncConnector and initiates the ConnectionManager at the given port and IP interface.
IpmiAuthenticationException - Exception in org.metricshub.ipmi.client
The BMC refused the login: unknown user name, wrong password or BMC key, role or privilege refused.
IpmiAuthenticationException(String, Throwable) - Constructor for exception org.metricshub.ipmi.client.IpmiAuthenticationException
Creates the exception for a login the console side rejected (the password or BMC key does not match).
IpmiAuthenticationException(String, CompletionCode, Throwable) - Constructor for exception org.metricshub.ipmi.client.IpmiAuthenticationException
Creates the exception for a login the BMC rejected with a status code.
IpmiChannel - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
IpmiCli - Class in org.metricshub.ipmi.cli
The command-line client: java -jar ipmi-java-<version>-standalone.jar [options] <subcommand> [...].
IpmiClient - Class in org.metricshub.ipmi.client
A client of one BMC over IPMI 2.0 (RMCP+).
IpmiClient.Builder - Class in org.metricshub.ipmi.client
Builds an IpmiClient: the BMC, the credentials and the session settings.
IpmiClientException - Exception in org.metricshub.ipmi.client
A failure of an IpmiClient operation.
IpmiClientException(String) - Constructor for exception org.metricshub.ipmi.client.IpmiClientException
Creates the exception.
IpmiClientException(String, Throwable) - Constructor for exception org.metricshub.ipmi.client.IpmiClientException
Creates the exception.
IpmiCommandCoder<R extends ResponseData> - Class in org.metricshub.ipmi.core.coding.commands
A wrapper for an IPMI command: encodes its request and decodes its response, of type R.
IpmiCompletionCodeException - Exception in org.metricshub.ipmi.client
The BMC answered a command with an error completion code (IPMI 2.0 table 5-2).
IpmiCompletionCodeException(String, IPMIException) - Constructor for exception org.metricshub.ipmi.client.IpmiCompletionCodeException
Creates the exception for an error reply received in the course of an operation, when the command the BMC answered is not known.
IpmiCompletionCodeException(IpmiCommandCoder<?>, IPMIException) - Constructor for exception org.metricshub.ipmi.client.IpmiCompletionCodeException
Creates the exception for the error reply to a command.
IpmiConnectionException - Exception in org.metricshub.ipmi.client
The connection to the BMC failed for a network reason: unknown host, socket error, no reply to the session setup after all the tries (wrong host, UDP port filtered, IPMI over LAN disabled, an IPMI 1.5-only BMC with IpmiClient.Builder.cipherSuite(int)), or the connection closed while an operation ran, which loses the session.
IpmiConnectionException(String, Throwable) - Constructor for exception org.metricshub.ipmi.client.IpmiConnectionException
Creates the exception.
IpmiConnector - Class in org.metricshub.ipmi.core.api.sync
Synchronous API for connecting to BMC via IPMI.
IpmiConnector(int) - Constructor for class org.metricshub.ipmi.core.api.sync.IpmiConnector
Starts IpmiConnector and initiates the ConnectionManager at the given port.
IpmiConnector(int, long) - Constructor for class org.metricshub.ipmi.core.api.sync.IpmiConnector
Starts IpmiConnector and initiates the ConnectionManager at the given port.
IpmiConnector(int, InetAddress) - Constructor for class org.metricshub.ipmi.core.api.sync.IpmiConnector
Starts IpmiConnector and initiates the ConnectionManager at the given port and IP interface.
IpmiDecoder - Interface in org.metricshub.ipmi.core.coding.protocol.decoder
Decodes IPMI session header and retrieves encrypted payload.
IpmiEncoder - Interface in org.metricshub.ipmi.core.coding.protocol.encoder
Encodes IPMI message.
IpmiError - Class in org.metricshub.ipmi.core.api.async.messages
Class that wraps exception that was cause of not receiving message.
IpmiError(Exception, int, ConnectionHandle) - Constructor for class org.metricshub.ipmi.core.api.async.messages.IpmiError
 
IPMIException - Exception in org.metricshub.ipmi.core.coding.payload.lan
 
IPMIException(CompletionCode) - Constructor for exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
 
IPMIException(CompletionCode, int) - Constructor for exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
 
IPMIException(CompletionCode, int, String) - Constructor for exception org.metricshub.ipmi.core.coding.payload.lan.IPMIException
Creates the exception for a code whose meaning depends on the command: an OEM or command-specific code that CompletionCode does not list.
IpmiLanConstants - Class in org.metricshub.ipmi.core.coding.payload.lan
Set of constants.
IpmiLanMessage - Class in org.metricshub.ipmi.core.coding.payload.lan
A wrapper class for IPMI LAN message
IpmiLanMessage() - Constructor for class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
IpmiLanRequest - Class in org.metricshub.ipmi.core.coding.payload.lan
A wrapper class for IPMB LAN message
IpmiLanRequest(int, byte, byte[], byte) - Constructor for class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest
Builds IpmiLanRequest addressed at LUN 0, under a network function given by its code, which may be one NetworkFunction does not list: Transport (0Ch), Group Extension (2Ch: DCMI, PICMG), OEM/Group (2Eh), controller-specific OEM (30h-3Eh), IPMI 2.0 table 5-1.
IpmiLanRequest(NetworkFunction, byte, byte[], byte) - Constructor for class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest
Builds IpmiLanRequest addressed at LUN 0.
IpmiLanRequest(NetworkFunction, byte, byte[], byte, byte) - Constructor for class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanRequest
Builds IpmiLanRequest.
IpmiLanResponse - Class in org.metricshub.ipmi.core.coding.payload.lan
A wrapper class for IPMB response message.
IpmiLanResponse(byte[]) - Constructor for class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse
Builds IPMI LAN response message from byte array.
IpmiMessage - Class in org.metricshub.ipmi.core.coding.protocol
Wrapper class for IPMI message
IpmiMessage() - Constructor for class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
IpmiMessageHandler - Class in org.metricshub.ipmi.core.connection
Default implementation of MessageHandler for IpmiLanMessages.
IpmiMessageHandler(Connection, int) - Constructor for class org.metricshub.ipmi.core.connection.IpmiMessageHandler
 
IpmiPayload - Class in org.metricshub.ipmi.core.coding.payload
Payload for IPMI messages
IpmiPayload() - Constructor for class org.metricshub.ipmi.core.coding.payload.IpmiPayload
 
IpmiResponse - Class in org.metricshub.ipmi.core.api.async.messages
Interface for response messages delivered to IpmiResponseListeners
IpmiResponse(int, ConnectionHandle) - Constructor for class org.metricshub.ipmi.core.api.async.messages.IpmiResponse
 
IpmiResponseData - Class in org.metricshub.ipmi.core.api.async.messages
Class that wraps ResponseData that was received successfully.
IpmiResponseData(ResponseData, int, ConnectionHandle) - Constructor for class org.metricshub.ipmi.core.api.async.messages.IpmiResponseData
 
IpmiResponseListener - Interface in org.metricshub.ipmi.core.api.async
Interface for listeners of IpmiAsyncConnector.
IpmiTimeoutException - Exception in org.metricshub.ipmi.client
The overall deadline of the operation expired, or a message of an established session got no reply after all the tries.
IpmiTimeoutException(String) - Constructor for exception org.metricshub.ipmi.client.IpmiTimeoutException
Creates the exception.
IpmiTimeoutException(String, Throwable) - Constructor for exception org.metricshub.ipmi.client.IpmiTimeoutException
Creates the exception.
Ipmiv15Message - Class in org.metricshub.ipmi.core.coding.protocol
Wrapper for IPMI v.1.5 message
Ipmiv15Message() - Constructor for class org.metricshub.ipmi.core.coding.protocol.Ipmiv15Message
 
Ipmiv20Message - Class in org.metricshub.ipmi.core.coding.protocol
Wrapper class for IPMI v2.0 message
Ipmiv20Message(ConfidentialityAlgorithm) - Constructor for class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
ipmiVersion() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the version of IPMI the BMC implements, 2.0 in practice: a BMC without RMCP+ fails the login before this command.
IpmiVersion - Enum in org.metricshub.ipmi.core.coding.commands
Describes IPMI version
isAcknowledged() - Method in class org.metricshub.ipmi.core.coding.commands.app.SendMessage
Tells whether the BMC answered Send Message itself with success to the latest try of this request: it then forwarded the request, and a missing response is the one of the controller, not of the BMC.
isAcknowledgeMessage() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
Checks if given SolMessage is an ACK/NACK for some other message.
isAcknowledgeOnly() - Method in class org.metricshub.ipmi.core.coding.sol.SolCoder
 
isActive() - Method in class org.metricshub.ipmi.core.connection.Connection
Checks if the connection is active
isActive() - Method in class org.metricshub.ipmi.core.sm.StateMachine
 
isAnonymusLoginEnabled() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
isBitSetOnPosition(int, byte) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Checks whether single bit on given position is set in given little-endian byte.
isChassisIdentifyCommandSupported() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the BMC supports the Chassis Identify command and reports its state (byte 4 bit 6).
isChassisIntrusionActive() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether a chassis intrusion is active (byte 4 bit 0).
isCommandResponse(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder
Checks if given message contains response command specific for this class.
isCommandResponse(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
isCommandResponse(IpmiMessage) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
isDataCarrier() - Method in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
Checks if given message carries some data (or operation/status).
isDeviceAvailable() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Tells whether the device is available (byte 4, bit 7).
isDiagnosticInterruptButtonDisableAllowed() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the diagnostic interrupt button can be disabled (byte 5 bit 6).
isDiagnosticInterruptButtonDisabled() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the diagnostic interrupt button is disabled (byte 5 bit 2).
isDynamicPopulation() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetDeviceSdrInfoResponseData
 
isEcc() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Tells whether the module carries ECC bits (its bus width extension).
isEntitiesAsRange() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
isEntitiesAsRange() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
isEntityInstanceIncrements() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Tells whether the entity instance number increments for each sensor sharing this record, rather than being the same for all of them.
isEntityPhysical() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Tells whether the entity is a physical entity or a logical container entity (byte 10 bit 7 of the record).
isFrom(Sensor) - Method in class org.metricshub.ipmi.client.SelEntry
Tells whether a system event was reported by the given sensor: the sensor that owns the number of the event, for the owner that logged it.
isFrontPanelButtonCapabilitiesSet() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the reply has the optional front panel button capabilities byte (byte 5): the front panel button getters throw IllegalAccessException when it does not.
isFrontPanelLockoutActive() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the front panel lockout is active: power off and reset with the chassis push-buttons are disabled (byte 4 bit 1).
isHyperThreading() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Tells whether the processor supports Intel Hyper-Threading Technology (two threads per core).
isHysteresisReadable() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Tells whether the hysteresis of the sensor can be read with Get Sensor Hysteresis (byte 12 bits 5:4 of a Full or Compact record).
isInterlock() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the chassis is shut down because a chassis panel interlock switch is active (byte 2 bit 2).
isIpmiv20Support() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
isKgEnabled() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
isLogical() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Tells whether the FRU device is a logical FRU device, accessed with the FRU commands of its management controller, rather than a non-intelligent device accessed with Master Write-Read (byte 8 bit 7 of the record).
isNonLinear() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Tells whether the sensor is non-linear (linearization 70h-7Fh, Table 43-1): the factors of the record hold at the nominal reading only, and the factors of any other reading come from the Get Sensor Reading Factors command (IPMI 2.0 section 36.2).
isNonNullUsernamesEnabled() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
isNullUsernamesEnabled() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
isOem(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Tells whether an event/reading type is OEM: the IPMI 2.0 specification (Table 42-1) reserves 70h to 7Fh for OEM use, and defines none of their states.
isOneWay() - Method in class org.metricshub.ipmi.core.connection.queue.QueueElement
 
isPayloadAuthenticated() - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
isPayloadEncrypted() - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
isPayloadSupported(IpmiPayload) - Method in interface org.metricshub.ipmi.core.api.async.InboundMessageListener
Checks if given payload is supported by this InboundMessageListener instance.
isPayloadSupported(IpmiPayload) - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
 
isPayloadSupported(IpmiPayload, int) - Method in interface org.metricshub.ipmi.core.api.async.InboundMessageListener
Checks if given payload, received on the connection with the given handle, is for this InboundMessageListener.
isPayloadSupported(IpmiPayload, int) - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
Takes the SOL packets of its own connection only: those of the other consoles of the connector are theirs to buffer and acknowledge.
isPercentage() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Tells whether the reading and the thresholds of the sensor are a percentage (Sensor Units 1 bit 0 of a Full or Compact record, IPMI 2.0 tables 43-1 and 43-2), of the base unit when the record gives one.
isPerMessageAuthenticationEnabled() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
isPirom(byte[], int) - Static method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Tells whether FRU data is a Processor Information ROM rather than an IPMI FRU inventory: a data format revision other than 01h (the FRU format version) in byte 0 and the 128-byte size in bytes 1 and 2.
isPowerControlFault() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the controller attempted to turn the system power on or off and the system did not enter the desired state (byte 2 bit 4).
isPowerFault() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether a fault was detected in the main power subsystem (byte 2 bit 3).
isPowerOffButtonDisableAllowed() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the power off button can be disabled (byte 5 bit 4).
isPowerOffButtonDisabled() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the power off button is disabled (byte 5 bit 0).
isPowerOn() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the system power is on (byte 2 bit 0).
isPowerOverload() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the system was shut down because of a power overload (byte 2 bit 1).
isRecordLink() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
isRecordLink() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
isReserveSupported() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
isResetButtonDisableAllowed() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the reset button can be disabled (byte 5 bit 5).
isResetButtonDisabled() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the reset button is disabled (byte 5 bit 1).
isScanningEnabled() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Tells whether the BMC reports sensor scanning as enabled (byte 3 bit 6).
isSensorStateValid() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Tells whether the reading and the states are available: false when the BMC sets the reading/state unavailable bit (byte 3 bit 5), for instance while the first update of the sensor after a re-arm is in progress, or when the entity is not present.
isSessionFound() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
isSessionValid() - Method in class org.metricshub.ipmi.core.connection.Connection
Checks if session is currently open.
isSetIn(byte) - Method in enum org.metricshub.ipmi.client.DeviceFunction
Tells whether this function is flagged in the additional device support byte.
isSpd(byte[], int) - Static method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Tells whether FRU data is SPD data rather than an IPMI FRU inventory: no FRU common header (format version 1) and a JEDEC DRAM device type in byte 2.
isStandbyButtonDisableAllowed() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the standby (sleep) button can be disabled (byte 5 bit 7).
isStandbyButtonDisabled() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the standby (sleep) button is disabled (byte 5 bit 3).
isSupported() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Tells whether this library implements the algorithms of this suite.
isSupportsBridge() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isSupportsChassis() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isSupportsFruInventoryDevice() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isSupportsIpmbEventGenerator() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isSupportsIpmbEventReciever() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isSupportsSdrRepositoryDevice() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isSupportsSelDevice() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isSupportsSensors() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
isTestMode() - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivateSolPayloadResponseData
 
isThresholdsReadable() - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Tells whether the thresholds of the sensor can be read with Get Sensor Thresholds (byte 12 bits 3:2 of a Full or Compact record).
isTransient() - Method in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Tells whether the BMC may answer the same request successfully a little later.
isUnspecified() - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffsetResponseData
 
isUserLevelAuthenticationEnabled() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 

J

Joules - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

K

keepAlive(Duration) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets the period of the keep-alive messages that keep the session open between operations; 30 seconds by default.
kilobit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Kilobyte - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
kPa - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

L

Lan - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
LANHeartbeat - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
LANHeartbeatLost - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
LANLeashLost - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
LapTop - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
lastAddition() - Method in class org.metricshub.ipmi.client.SelEntryList
Returns when an entry was last added to the log.
lastErase() - Method in class org.metricshub.ipmi.client.SelEntryList
Returns when entries were last deleted or the log cleared (IPMI 2.0 table 31-2): the BMC may then give the record ID of an entry read before to another entry.
lastPowerEvents() - Method in class org.metricshub.ipmi.client.ChassisStatus
Returns what caused the last power down or power on: several causes can be flagged at once.
LCDControllerDriver - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
LENGTH_WITH_AUXILIARY_REVISION - Static variable in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
The length of the response data with the auxiliary firmware revision.
LengthLimitExceeded - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Request data field length limit exceeded.
LEVEL_ABOVE_LIMIT - Static variable in class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
Completion code: the requested level exceeds the privilege limit of the channel or of the user.
LEVEL_NOT_AVAILABLE - Static variable in class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
Completion code: the requested level is not available for this user (IPMI 2.0 table 22-24).
LimitExceeded - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
LimitNotExceeded - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Line - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
listIds(List<CipherSuite>) - Static method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Lists the IDs of the given suites, for messages.
Liters - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
littleEndianBcdByteToInt(byte) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts BCD encoded byte with bits 7:4 holding the Least Significant digit of the revision and bits 3:0 holding the Most Significant bits.
littleEndianByteArrayToInt(byte[]) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts byte array in LittleEndian convention to int.
littleEndianWordToInt(byte[]) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts LittleEndian word (double bytes array) to int.
LM75TemperatureSensor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
LMC6874IntelligentBatteryController - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
locator() - Method in class org.metricshub.ipmi.client.Fru
Returns the SDR record that locates the FRU, as the protocol core decodes it.
LogAreaReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Low - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
lowerCritical() - Method in class org.metricshub.ipmi.client.Sensor
Returns the lower critical threshold, in the Sensor.unit() of the sensor.
LowerCriticalGoingHigh - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
LowerCriticalGoingLow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
lowerNonCritical() - Method in class org.metricshub.ipmi.client.Sensor
Returns the lower non-critical threshold, in the Sensor.unit() of the sensor.
LowerNonCriticalGoingHigh - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
LowerNonCriticalGoingLow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
lowerNonRecoverable() - Method in class org.metricshub.ipmi.client.Sensor
Returns the lower non-recoverable threshold, in the Sensor.unit() of the sensor.
LowerNonRecoverableGoingHigh - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
LowerNonRecoverableGoingLow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Lumen - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
LunchBox - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
Lux - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

M

m - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
MachineCheckException - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
MachineObserver - Interface in org.metricshub.ipmi.core.sm
An interface for listener of the StateMachine
main(String[]) - Static method in class org.metricshub.ipmi.cli.IpmiCli
Runs the CLI on the standard streams and exits with its exit code.
MainServerChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
MANAGEMENT_CONTROLLER_CONFIRMATION_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
MANAGEMENT_CONTROLLER_DEVICE_LOCATOR_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
ManagementAccessInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
Management Access record (type 03h) from the FRU MultiRecord area
ManagementAccessInfo(byte[], int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessInfo
Creates and populates record
ManagementAccessRecord - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
ManagementAccessRecordType - Enum in org.metricshub.ipmi.core.coding.commands.fru.record
 
ManagementControllerConfirmationRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
This record can be used by utility software to record that a given controller has been discovered in the system.
ManagementControllerConfirmationRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
ManagementControllerDeviceLocatorRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
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.
ManagementControllerDeviceLocatorRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
ManagementControllerFirmware - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
ManagementControllerOffLine - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Controller cannot be accessed for normal operation because it has been intentionally taken off-line for a non-error condition.
ManagementControllerUnavailable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Controller cannot be accessed because of an error condition
ManagementSubsystemHealth - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
manufacturer() - Method in class org.metricshub.ipmi.client.Fru
Returns the manufacturer, from the product area, or from the board area when the product area does not name it; the module manufacturer of a memory module; Intel for a processor.
manufacturerId() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the manufacturer ID: the IANA enterprise number of the vendor of the BMC.
manufacturerId() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the manufacturer ID (IANA enterprise number) of a timestamped OEM entry.
MAX_INTERVAL - Static variable in class org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentify
The longest interval the request can carry, in seconds.
MAX_SEQUENCE_NUMBER - Static variable in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
MAX_SEQUENCE_NUMBER - Static variable in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
Maxim1617TemperatureSensor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
MaximumAvailable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.PrivilegeLevel
The highest level the account is allowed.
Md2 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
Md5 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
Megabit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Megabyte - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Memory - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
MemoryAutomaticallyThrottled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Memory throttling triggered by a hardware-based mechanism operating independent from system software, such as automatic thermal throttling or throttling to limit power consumption.
MemoryConfigurationError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Indicates a memory configuration error for the entity associated with the sensor.
MemoryCriticalOvertemperature - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Memory device has entered a critical overtemperature state, exceeding specified operating conditions.
MemoryDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
MemoryDeviceDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
MemoryModule - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Board holding memory devices.
MemoryPresenceDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Indicates presence of entity associated with the sensor.
MemoryScrubFailed - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
MessageAction - Class in org.metricshub.ipmi.core.sm.actions
Returns response to the unknown command (recognition is up to the higher levels of the architecture) received in the SessionValid state.
MessageAction(Ipmiv20Message) - Constructor for class org.metricshub.ipmi.core.sm.actions.MessageAction
 
MessageComposer - Class in org.metricshub.ipmi.core.common
Class used for composing byte messages aout from smaller byte subarrays.
MessageHandler - Class in org.metricshub.ipmi.core.connection
Class used for handling outgoing and incoming messages for a Connection.
MessageHandler(Connection, int, int, int) - Constructor for class org.metricshub.ipmi.core.connection.MessageHandler
 
MessageListener - Class in org.metricshub.ipmi.core.api.sync
Listens to the IpmiAsyncConnector waiting for concrete message to arrive.
MessageListener(ConnectionHandle) - Constructor for class org.metricshub.ipmi.core.api.sync.MessageListener
Initiates the MessageListener
MessageQueue - Class in org.metricshub.ipmi.core.connection.queue
Queues messages to send and checks for timeouts.
MessageQueue(Connection, int, int, int) - Constructor for class org.metricshub.ipmi.core.connection.queue.MessageQueue
 
MessageReader - Class in org.metricshub.ipmi.core.common
Class used for reading subsequent byte subarrays from message, that is also a byte array.
MessageReader(byte[]) - Constructor for class org.metricshub.ipmi.core.common.MessageReader
Create new instance of MessageReader, that will operate on given message.
Messages - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
messageTimeout(Duration) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets how long a message waits for its reply before it is sent again; 5 seconds by default.
Messenger - Interface in org.metricshub.ipmi.core.transport
Low level connection handler.
MicrocontrollerCoprocessor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
MicrocontrollerCoprocessor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Microfarad - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Microsecond - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Microseconds - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
Mil - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Miliseconds - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
Millihenry - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Millisecond - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
MIN_SEQUENCE_NUMBER - Static variable in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
MIN_SEQUENCE_NUMBER - Static variable in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
Mini - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
MINIMUM_LENGTH - Static variable in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
The length of the response data without the auxiliary firmware revision.
Minute - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Minutes - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
Miss - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
mm - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
model() - Method in class org.metricshub.ipmi.client.Fru
Returns the model, from the product name of the product area, or from the board product name when the product area does not give it; the part number of a memory module; the S-spec of a processor.
ModifierUnitUsage - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
 
ModuleBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
ModuleBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Mole - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Monitor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
MonitorAsicIc - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
MonitorAsicIc - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Mulitply - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ModifierUnitUsage
Unit = Basic Unit * Modifier Unit
MultiRecordInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
Record from the FRU MultiRecord area
MultiRecordInfo() - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.MultiRecordInfo
Creates an empty record, for the subclasses.
multiRecords() - Method in class org.metricshub.ipmi.client.Fru
Returns the records of the multirecord area (power supply information, DC output, management access...), as the protocol core decodes them.

N

NACK - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolAckState
Message was not acknowledged.
name() - Method in class org.metricshub.ipmi.client.Fru
Returns the name of the FRU, from the ID string of its locator record.
name() - Method in class org.metricshub.ipmi.client.Sensor
Returns the name of the sensor, from the ID string of its record.
names(String...) - Method in class org.metricshub.ipmi.client.SensorsRequest
Reads only the sensors whose name matches one of the given patterns, case-insensitively: * matches any characters and ? one character ("CPU? Temp", "*Fan*").
networkFunction() - Method in exception org.metricshub.ipmi.client.IpmiCompletionCodeException
Returns the network function of the command the BMC answered.
NetworkFunction - Enum in org.metricshub.ipmi.core.coding.payload.lan
IPMB network functions
newMacInstance(String) - Static method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Constructs a Mac object that implements the given MAC algorithm.
Newton - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Nits - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
NoBootableMedia - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
NodeBusy - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command could not be processed because command processing resources are temporarily unavailable.
NoMatchingAuthenticationPayload - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
No matching authentication payload.
NoMatchingCipherSuite - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
No Cipher Suite match with proposed security algorithms.
NoMatchingIntegrityPayload - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
No matching integrity payload.
NON_CRITICAL - Enum constant in enum org.metricshub.ipmi.client.SensorStatus
The reading is at or beyond a non-critical threshold.
NON_RECOVERABLE - Enum constant in enum org.metricshub.ipmi.client.SensorStatus
The reading is at or beyond a non-recoverable threshold.
NonBootableDisketteLeftInDrive - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
None - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ModifierUnitUsage
 
None - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
None - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
nonNullUserNames() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Tells whether the BMC has at least one user with a non-null user name.
NonRedundant_InsufficientResources - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Unit has regained minimum resources needed for 'normal' operation.
NonRedundant_SufficientResourcesFromInsufficientResources - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Unit has regained minimum resources needed for 'normal' operation.
NonRedundant_SufficientResourcesFromRedundant - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Redundancy has been lost but unit is functioning with minimum resources needed for 'normal' operation.
NOT_YET_IMPLEMENTED_MESSAGE - Static variable in class org.metricshub.ipmi.core.coding.security.CipherSuite
Deprecated.
unused since 2.0.00; this constant will be removed in 3.0.
Notebook - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
notify(IpmiResponse) - Method in interface org.metricshub.ipmi.core.api.async.IpmiResponseListener
Notifies listener of action that occurred.
notify(IpmiResponse) - Method in class org.metricshub.ipmi.core.api.sync.MessageListener
 
notify(IpmiPayload) - Method in interface org.metricshub.ipmi.core.api.async.InboundMessageListener
Notify listener about received inbound message.
notify(IpmiPayload) - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
Buffers the characters of a packet, only those it did not receive already when the BMC sends a packet again, acknowledges every packet with a sequence number (with a Suspend NACK when the characters do not fit), and reports the statuses of each packet once.
notify(StateMachineAction) - Method in class org.metricshub.ipmi.core.connection.Connection
 
notify(StateMachineAction) - Method in interface org.metricshub.ipmi.core.sm.MachineObserver
Notifies observer of action performed by the State Machine.
notifyMessage(UdpMessage) - Method in class org.metricshub.ipmi.core.sm.StateMachine
 
notifyMessage(UdpMessage) - Method in interface org.metricshub.ipmi.core.transport.UdpListener
Notifies listener of the UDP message that was received.
notifyRequestListeners(IpmiPayload) - Method in class org.metricshub.ipmi.core.connection.Connection
Notifies the listeners of a payload the remote system sent on its own initiative, with the handle of this connection.
notifyResponseListeners(int, int, ResponseData, Exception) - Method in class org.metricshub.ipmi.core.connection.Connection
 
nullUserNames() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Tells whether the BMC accepts a null user name with a non-null password.
number() - Method in class org.metricshub.ipmi.client.Sensor
Returns the sensor number, unique for the owner and LUN of the sensor: the number of the record plus the index of the sensor among those sharing it.
Numeric - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.InstanceModifierType
 

O

Oem - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
An OEM sensor type, C0h to FFh (IPMI 2.0 table 42-3): SensorType.getCode() is C0h whatever the code, which AbstractSensorRecord.getSensorTypeCode() and SelRecord.getSensorTypeCode() keep.
Oem - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
Oem - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
OEM Explicit
Oem - Enum constant in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
OEM-defined Class of Message
OEM_RECORD - Static variable in class org.metricshub.ipmi.core.coding.commands.sdr.record.RecordTypes
 
Oem0 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
Oem1 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
Oem2 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
Oem3 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
Oem4 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
Oem5 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
Oem6 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
Oem7 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
oemData() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the OEM-defined bytes of an OEM entry: 6 for a timestamped one, 13 otherwise (IPMI 2.0 sections 32.2 and 32.3).
OemInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
OEM record (types C0h-FFh) from the FRU MultiRecord area
OemInfo(byte[], int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.OemInfo
Creates and populates record
OemNonTimestamped - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
A non-timestamped OEM record (E0h-FFh, IPMI 2.0 section 32.3): 13 OEM-defined bytes.
OemRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
OEM specific record.
OemRecord - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
OemRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.OemRecord
 
OemReserved - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
Deprecated.
76h is reserved like the other codes table 42-3 does not define: SensorType.parseInt(int) returns SensorType.Reserved for it.
OEMSpecifiedDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
OemSystemBootEvent - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
OemTimestamped - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
A timestamped OEM record (C0h-DFh, IPMI 2.0 section 32.2): a timestamp, a manufacturer ID and 6 OEM-defined bytes.
Off - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
 
Ohms - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Ok - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
 
Ok - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command completed normally.
OK - Enum constant in enum org.metricshub.ipmi.client.SensorStatus
The reading is within the thresholds, or the discrete sensor answers.
onEnter(StateMachine) - Method in class org.metricshub.ipmi.core.sm.states.State
Defines the action performed when the state is entered.
onSkippedRecord(Consumer<SkippedRecord>) - Method in class org.metricshub.ipmi.client.FrusRequest
Be told of each SDR record the repository walk could not use: the records are given to the consumer, on the calling thread, once the walk is done, before FrusRequest.execute() returns or FrusRequest.stream() yields its first FRU.
onSkippedRecord(Consumer<SkippedRecord>) - Method in class org.metricshub.ipmi.client.SensorsRequest
Be told of each SDR record the repository walk could not use: the records are given to the consumer, on the calling thread, once the walk is done, before SensorsRequest.execute() returns or SensorsRequest.stream() yields its first sensor.
open() - Method in class org.metricshub.ipmi.client.SolRequest
Activates the SOL payload and opens the console.
openSession(ConnectionHandle, String, byte[], byte[]) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Establishes the session with the remote host, with the password as bytes: the caller can then clear them once the session is open, which an immutable String does not allow.
openSession(ConnectionHandle, String, byte[], byte[]) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Establishes the session with the remote host, with the password as bytes: the caller can then clear them once the session is open, which an immutable String does not allow.
openSession(ConnectionHandle, String, String, byte[]) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Establishes the session with the remote host, and raises it to the requested privilege when that is Operator or Administrator (Set Session Privilege Level, IPMI 2.0 section 22.18: every session starts at User).
openSession(ConnectionHandle, String, String, byte[]) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Establishes the session with the remote host, and raises it to the requested privilege when that is Operator or Administrator (Set Session Privilege Level, IPMI 2.0 section 22.18: every session starts at User).
OpenSession - Class in org.metricshub.ipmi.core.coding.commands.session
Wrapper class for RMCP+ Open Session request.
OpenSession(int, PrivilegeLevel, CipherSuite) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.OpenSession
Initiates class for encoding and decoding.
OpenSession(CipherSuite) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.OpenSession
Initiates class for decoding.
OpenSessionAck - Class in org.metricshub.ipmi.core.sm.events
Performs transition from OpenSessionComplete to Rakp1Waiting.
OpenSessionAck(CipherSuite, PrivilegeLevel, int, int, String, byte[], byte[]) - Constructor for class org.metricshub.ipmi.core.sm.events.OpenSessionAck
Provides data required to send RAKP Message 1.
OpenSessionComplete - Class in org.metricshub.ipmi.core.sm.states
Indicates that OpenSession response was received.
OpenSessionComplete() - Constructor for class org.metricshub.ipmi.core.sm.states.OpenSessionComplete
 
OpenSessionResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
A wrapper for Open Session command response
OpenSessionResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
OpenSessionWaiting - Class in org.metricshub.ipmi.core.sm.states
Waiting for the OpenSession response.
Transition to OpenSessionComplete on DefaultAck Transition to Authcap on Timeout
OpenSessionWaiting(int) - Constructor for class org.metricshub.ipmi.core.sm.states.OpenSessionWaiting
 
OperatingSystem - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Operator - Enum constant in enum org.metricshub.ipmi.core.coding.commands.PrivilegeLevel
The User commands and the commands that change the state of the system, such as Chassis Control and Chassis Identify, but not the configuration commands that change the behavior of the out-of-band interfaces.
org.metricshub.ipmi.cli - package org.metricshub.ipmi.cli
The command-line client of the library, ipmicli (IpmiCli): ipmicli [options] <subcommand> [subcommand options], installed with a launcher by the installer, or run with java -jar ipmi-java-<version>-standalone.jar.
org.metricshub.ipmi.client - package org.metricshub.ipmi.client
The client of a BMC.
org.metricshub.ipmi.core.api.async - package org.metricshub.ipmi.core.api.async
The asynchronous API.
org.metricshub.ipmi.core.api.async.messages - package org.metricshub.ipmi.core.api.async.messages
The package containing asynchronous API message classes.
org.metricshub.ipmi.core.api.sol - package org.metricshub.ipmi.core.api.sol
The API for Serial Over LAN (SOL) communication for IPMI.
org.metricshub.ipmi.core.api.sync - package org.metricshub.ipmi.core.api.sync
The synchronous API of the protocol core: IpmiConnector opens RMCP+ sessions and sends commands, waiting for their responses.
org.metricshub.ipmi.core.coding - package org.metricshub.ipmi.core.coding
The part of library responsible for message encoding and decoding.
org.metricshub.ipmi.core.coding.commands - package org.metricshub.ipmi.core.coding.commands
The IPMI commands: one IpmiCommandCoder per command, which encodes the request and decodes the response into its ResponseData.
org.metricshub.ipmi.core.coding.commands.app - package org.metricshub.ipmi.core.coding.commands.app
The application commands of IPMI 2.0: Get Device ID (section 20.1), which describes the controller, and Send Message (sections 6.13.3 and 22.7), which carries a command to a controller behind the BMC.
org.metricshub.ipmi.core.coding.commands.chassis - package org.metricshub.ipmi.core.coding.commands.chassis
Chassis related commands.
org.metricshub.ipmi.core.coding.commands.fru - package org.metricshub.ipmi.core.coding.commands.fru
FRU related commands.
org.metricshub.ipmi.core.coding.commands.fru.record - package org.metricshub.ipmi.core.coding.commands.fru.record
FRU records wrappers.
org.metricshub.ipmi.core.coding.commands.payload - package org.metricshub.ipmi.core.coding.commands.payload
The payload commands of IPMI 2.0 (section 24): Activate and Deactivate Payload, Get Payload Activation Status and Get Payload Instance Info, which the Serial over LAN console sends, and Get Channel Payload Support.
org.metricshub.ipmi.core.coding.commands.sdr - package org.metricshub.ipmi.core.coding.commands.sdr
SDR related commands.
org.metricshub.ipmi.core.coding.commands.sdr.record - package org.metricshub.ipmi.core.coding.commands.sdr.record
SDR records formats.
org.metricshub.ipmi.core.coding.commands.sel - package org.metricshub.ipmi.core.coding.commands.sel
SEL related commands.
org.metricshub.ipmi.core.coding.commands.session - package org.metricshub.ipmi.core.coding.commands.session
Session management related commands.
org.metricshub.ipmi.core.coding.payload - package org.metricshub.ipmi.core.coding.payload
The IPMI payload encoders and decoders.
org.metricshub.ipmi.core.coding.payload.lan - package org.metricshub.ipmi.core.coding.payload.lan
The LAN payload format encoders and decoders.
org.metricshub.ipmi.core.coding.payload.sol - package org.metricshub.ipmi.core.coding.payload.sol
The Serial over LAN payload (IPMI 2.0 section 15): the inbound and outbound SOL messages, their operation and status fields, and the acknowledge states.
org.metricshub.ipmi.core.coding.protocol - package org.metricshub.ipmi.core.coding.protocol
The IPMI protocol messages, encoder and decoder.
org.metricshub.ipmi.core.coding.protocol.decoder - package org.metricshub.ipmi.core.coding.protocol.decoder
IPMI protocol decoder classes.
org.metricshub.ipmi.core.coding.protocol.encoder - package org.metricshub.ipmi.core.coding.protocol.encoder
IPMI protocol encoder classes.
org.metricshub.ipmi.core.coding.rmcp - package org.metricshub.ipmi.core.coding.rmcp
The RMCP-level encoder, decoder and message classes.
org.metricshub.ipmi.core.coding.security - package org.metricshub.ipmi.core.coding.security
Authentication, confidentiality and integrity algorithms.
org.metricshub.ipmi.core.coding.sol - package org.metricshub.ipmi.core.coding.sol
The coder of the Serial over LAN payload: SolCoder encodes the SOL messages sent to the BMC and decodes its replies into SolResponseData.
org.metricshub.ipmi.core.common - package org.metricshub.ipmi.core.common
The library utility classes.
org.metricshub.ipmi.core.connection - package org.metricshub.ipmi.core.connection
Package responsible for Connection management.
org.metricshub.ipmi.core.connection.queue - package org.metricshub.ipmi.core.connection.queue
Package responsible for message queuing.
org.metricshub.ipmi.core.sm - package org.metricshub.ipmi.core.sm
The StateMachine classes
org.metricshub.ipmi.core.sm.actions - package org.metricshub.ipmi.core.sm.actions
The StateMachine actions.
org.metricshub.ipmi.core.sm.events - package org.metricshub.ipmi.core.sm.events
The StateMachine events.
org.metricshub.ipmi.core.sm.states - package org.metricshub.ipmi.core.sm.states
The StateMachine states.
org.metricshub.ipmi.core.transport - package org.metricshub.ipmi.core.transport
The UDP transport layer.
OsBoot - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
OsGracefulShutdown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
System graceful power down by OS.
OsGracefulStop - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
System powered up, but normal OS operation has shut down and system is awaiting reset pushbutton, powercycle or other external input
OsStop - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
OsWatchdogExpired - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
OS Watchdog Expired, status only (Watchdog 1).
OsWatchdogNmiDiagnosticInterrupt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
OS Watchdog NMI / Diagnostic Interrupt (Watchdog 1).
OsWatchdogPowerCycle - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
OS Watchdog Power Cycle (Watchdog 1).
OsWatchdogPowerDown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
OS Watchdog Power Down (Watchdog 1).
OsWatchdogPreTimeoutInterrupt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
OS Watchdog pre-timeout Interrupt, non-NMI (Watchdog 1).
OsWatchdogReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
OS Watchdog Reset (Watchdog 1).
OsWatchdogShutDown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
OS Watchdog Shut Down (Watchdog 1).
Other - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
Other - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
Other - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Other - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
OtherChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
OtherFru - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
OtherFru - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
OtherPreBootPasswordViolation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
OtherSystemBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
OtherUnitsBasedSensor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
OtherUnitsBasedSensor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Ounce - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
OutOfBandAccessPasswordViolation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
OutOfSpace - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Out of space.
output() - Method in class org.metricshub.ipmi.client.SolConsole
Returns the stream whose bytes reach the serial port of the system.
Output - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
 
OverrunOverflow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
OzIn - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

P

Packets - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
ParameterOutOfRange - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Parameter out of range.
Parity - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Returns the command of a Chassis Control code.
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.BaseUnit
Returns the unit of an access type bit.
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadCompletionCode
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.AddressType
Parse the given int value and return the corresponding AddressType
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.InstanceModifierType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ModifierUnitUsage
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
Decodes a sensor type code.
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
Decodes the threshold comparison status (IPMI 2.0 Table 35-15, byte 4 bits [5:0]) into the most severe threshold crossed.
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sel.EventDirection
Returns the event direction of an event direction bit.
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
Returns the record type of a record type code.
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
parseInt(int) - Static method in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
 
parseInt(SensorType, int, int) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Determines type of discrete sensor reading.
partNumber() - Method in class org.metricshub.ipmi.client.Fru
Returns the part number: the product model number of the product area, or the board part number when the product area does not give it; the part number of a memory module or of a processor.
PartsPerMilion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
PAYLOAD_ALREADY_DEACTIVATED - Enum constant in enum org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadCompletionCode
 
PAYLOAD_HEADER_LENGTH - Static variable in class org.metricshub.ipmi.core.coding.payload.sol.SolMessage
 
PAYLOAD_TYPE_IS_DISABLED - Enum constant in enum org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadCompletionCode
 
PayloadCoder - Class in org.metricshub.ipmi.core.coding
Base class for IpmiPayload coders, used for encoding pyloads inside IpmiMessages.
PayloadCoder() - Constructor for class org.metricshub.ipmi.core.coding.PayloadCoder
 
PayloadCoder(IpmiVersion, CipherSuite, AuthenticationType) - Constructor for class org.metricshub.ipmi.core.coding.PayloadCoder
 
PayloadType - Enum in org.metricshub.ipmi.core.coding.protocol
Types of IPMI packet payload
PCF8570256ByteRAM - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
PCF8573ClockCalendar - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
PCF8574AIoPort - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
PCF8583ClockCalendar - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
PCF8591AdDaConverter - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
PCF8593ClockCalendar - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
 
PciBus - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
PciExpressBus - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
PciPErr - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PciSErr - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PefAction - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
percentage() - Method in class org.metricshub.ipmi.client.Sensor
Tells whether the reading and the thresholds are a percentage (Sensor Units 1 bit 0, IPMI 2.0 table 43-1): of the Sensor.unit() unless it is SensorUnit.Unspecified, as a fan speed in % of RPM.
PerformanceLags - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PerformanceMet - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PeripheralBay - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
PeripheralBay2 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
PeripheralChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
perMessageAuthentication() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Tells whether the BMC authenticates every message of a session, rather than the login only.
PhysicalSecurity - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
pirom() - Method in class org.metricshub.ipmi.client.Fru
Returns the Processor Information ROM of a processor, as the protocol core decodes it: the FRU device of a processor cartridge returns the Intel PIROM of the CPU (S-spec, cores, frequencies, caches, part number, TDP, PPIN) instead of a FRU inventory.
PiromInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
The Processor Information ROM (PIROM) of an Intel Xeon processor, which the FRU device of a processor cartridge (device type 10h, modifier 03h) returns instead of an IPMI FRU inventory: the S-spec, the cores, the frequencies, the caches, the part number, the thermal design power and the Protected Processor Inventory Number (PPIN), decoded from the 128-byte layout of data format revision 7 (Intel Xeon Scalable Processors Datasheet, Volume One, chapter 5).
PiromInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
Decodes a PIROM of data format revision 7.
Pizza - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
PlainCommandv20Decoder - Class in org.metricshub.ipmi.core.coding.protocol.decoder
Decodes IPMI session header and retrieves encrypted payload.
PlainCommandv20Decoder(CipherSuite) - Constructor for class org.metricshub.ipmi.core.coding.protocol.decoder.PlainCommandv20Decoder
 
PlainMessage - Class in org.metricshub.ipmi.core.coding.payload
Represents IPMI payload fully specified by user - contains wrapped byte array which is returned as a payload via PlainMessage.getPayloadData().
PlainMessage(byte[]) - Constructor for class org.metricshub.ipmi.core.coding.payload.PlainMessage
Creates IPMI payload.
PlatformAlert - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
PlatformEventTrapGenerated - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PlatformGeneratedLanAlert - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PlatformGeneratedPage - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PlatformGeneratedSnmpTrap - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PlatformSecurityViolationAttempt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
populateMultiRecord(byte[], int) - Static method in class org.metricshub.ipmi.core.coding.commands.fru.record.MultiRecordInfo
Decodes the record of the MultiRecord area that starts at the given offset, with its 5-byte header.
populateSelRecord(byte[]) - Static method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Decodes a SEL record (IPMI 2.0 section 32).
populateSensorRecord(byte[]) - Static method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Decodes an SDR record (IPMI 2.0 section 43): the types 01h-03h, 08h, 09h and 10h-13h into their classes, the OEM types C0h-FFh into an OemRecord.
port(int) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets the UDP port of the BMC; 623 by default.
Portable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
PostMemoryResize - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PostMemoryResize - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Pound - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
POWER_FAULT - Enum constant in enum org.metricshub.ipmi.client.PowerEvent
The last power down of the system was caused by a power fault.
POWER_OVERLOAD - Enum constant in enum org.metricshub.ipmi.client.PowerEvent
The last power down of the system was caused by a power overload.
PowerButtonPressed - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerCommand - Enum in org.metricshub.ipmi.core.coding.commands.chassis
Specifies types of commands that can be sent to BMC via ChassisControl command.
powerControlFault() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether the last power control command failed.
PowerCycle - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Power cycle (optional): a power off interval of at least 1 second, then power up.
PowerCycle - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerDown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Force system into soft off (S4/S5) state.
PowerDown240V - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PoweredOff - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerRestorePolicy
Chassis stays powered off after AC/mains returns
PoweredUp - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerRestorePolicy
Chassis always powers up after AC/mains returns
PowerEvent - Enum in org.metricshub.ipmi.client
What caused the last power down or power on of the system (Get Chassis Status, IPMI 2.0 table 28-3).
powerFault() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether a power fault is active.
PowerInputLost - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
The power source for the power unit was lost
PowerManagement - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Power management / power distribution board
PowerModule - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
DC-to-DC internal converter.
PowerOffOrDown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
powerOn() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether the system is powered on.
powerOverload() - Method in class org.metricshub.ipmi.client.ChassisStatus
Tells whether the system was shut down because of a power overload.
PowerRestored - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerRestorePolicy
After AC returns, power is restored to the state that was in effect when AC/mains was lost
powerRestorePolicy() - Method in class org.metricshub.ipmi.client.ChassisStatus
Returns what the system does when AC power returns after it was lost.
PowerRestorePolicy - Enum in org.metricshub.ipmi.core.coding.commands.chassis
Chassis power restore policy.
PowerSupply - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
PowerSupply - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
PowerSupplyConfigurationError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerSupplyFailureDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerSupplyInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
Power Supply Information record (type 00h) from the FRU MultiRecord area
PowerSupplyInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Creates and populates record
PowerSupplyInformation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
PowerSupplyInputLost - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerSupplyInputLostOrOutOfRange - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerSupplyInputOutOfRange - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerSupplyPredictiveFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerSupplyPresenceDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerSystemBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
PowerUnit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
This Entity ID is typically used as a pre-defined logical entity for grouping power supplies and/or sensors that are associated in monitoring a particular logical power domain.
PowerUnit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
PowerUnitFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerUnitPredictiveFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PowerUnitSoftPowerControlFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Unit did not respond to request to turn on.
PowerUp - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Power up the system.
PowerUp - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PreBootNetworkPasswordViolation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PreBootSetupPasswordViolation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PreBootUserPasswordViolation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Predictive - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PredictiveFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PredictiveFailureDeasserted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
preInitSeconds() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the age of an event logged before the SEL device had the time, as the seconds since its initialization (IPMI 2.0 section 37.1: the timestamps up to 20000000h are relative); empty when SelEntry.timestamp() is a date, unspecified or absent.
PRESENCE_PING - Static variable in class org.metricshub.ipmi.core.coding.rmcp.RmcpConstants
ASF Message type = Presence Ping
privilege(PrivilegeLevel) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets the maximum privilege of the session, requested at Open Session and RAKP 1.
PrivilegeLevel - Enum in org.metricshub.ipmi.core.coding.commands
The privilege level of a session (IPMI 2.0 section 6.8), declared from the lowest to the highest: Callback, User, Operator, Administrator.
problem() - Method in class org.metricshub.ipmi.client.Sensor
Returns why the sensor has no reading.
problems() - Method in class org.metricshub.ipmi.client.Fru
Returns what went wrong while reading the FRU: a read refused by the BMC (with its completion code), a read without reply, data truncated at an offset, an area that could not be decoded.
ProcesorModule - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Holds processors, use this designation when processors are not mounted on system board
ProcessingBlade - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
A blade module that contains processor, memory, and I/O connections that enable it to operate as a processing entity.
Processor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Processor - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Processor2 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Duplicate of EntityId.Processor.
ProcessorAreaIntrusion - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
ProcessorAutomaticallyThrottled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Processor throttling triggered by a hardware-based mechanism operating independent from system software, such as automatic thermal throttling or throttling to limit power consumption
ProcessorBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
ProcessorDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
ProcessorIoModule - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
ProcessorMemoryModule - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Processor and memory together on a module.
ProcessorPresenceDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
ProcessorThermalTrip - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
processRequest(IpmiPayload) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Deprecated.
processRequest(IpmiPayload) - Method in interface org.metricshub.ipmi.core.connection.ConnectionListener
Deprecated.
implement ConnectionListener.processRequest(IpmiPayload, int), which tells the connection
processRequest(IpmiPayload, int) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
 
processRequest(IpmiPayload, int) - Method in interface org.metricshub.ipmi.core.connection.ConnectionListener
Notifies the ConnectionListener of a payload the remote system sent on its own initiative (Serial over LAN data).
processRequestEvent(Set<SolStatus>) - Method in interface org.metricshub.ipmi.core.api.sol.SolEventListener
Process event sent proactively by remote server.
processResponse(ResponseData, int, int, Exception) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
 
processResponse(ResponseData, int, int, Exception) - Method in interface org.metricshub.ipmi.core.connection.ConnectionListener
Notifies the ConnectionListeners of the one of the following events: response to the request tagged with id arrived request tagged with id timed out
processResponseEvent(Set<SolStatus>, byte[], Set<SolOperation>) - Method in interface org.metricshub.ipmi.core.api.sol.SolEventListener
Process event sent by remote server as a response for some outbound message.
product() - Method in class org.metricshub.ipmi.client.Fru
Returns the product info area, as the protocol core decodes it.
productId() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the product ID, as the manufacturer numbers its products.
ProductInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
FRU record containing Product info.
This area is present if the FRU itself is a separate product.
ProductInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Creates and populates record
ProtocolDecoder - Class in org.metricshub.ipmi.core.coding.protocol.decoder
Decodes IPMI session header and retrieves encrypted payload.
ProtocolDecoder() - Constructor for class org.metricshub.ipmi.core.coding.protocol.decoder.ProtocolDecoder
 
ProtocolEncoder - Class in org.metricshub.ipmi.core.coding.protocol.encoder
Adds IPMI session header to encrypted payload.
ProtocolEncoder() - Constructor for class org.metricshub.ipmi.core.coding.protocol.encoder.ProtocolEncoder
 
Protocolv15Decoder - Class in org.metricshub.ipmi.core.coding.protocol.decoder
Decodes IPMI v1.5 session header and retrieves encrypted payload.
Protocolv15Decoder() - Constructor for class org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv15Decoder
 
Protocolv15Encoder - Class in org.metricshub.ipmi.core.coding.protocol.encoder
Encodes IPMI v1.5 message
Protocolv15Encoder() - Constructor for class org.metricshub.ipmi.core.coding.protocol.encoder.Protocolv15Encoder
 
Protocolv20Decoder - Class in org.metricshub.ipmi.core.coding.protocol.decoder
Decodes IPMI v2.0 session header and retrieves encrypted payload.
Protocolv20Decoder(CipherSuite) - Constructor for class org.metricshub.ipmi.core.coding.protocol.decoder.Protocolv20Decoder
Initiates IPMI v2.0 packet decoder.
Protocolv20Encoder - Class in org.metricshub.ipmi.core.coding.protocol.encoder
Encodes IPMI v2.0 message.
Protocolv20Encoder() - Constructor for class org.metricshub.ipmi.core.coding.protocol.encoder.Protocolv20Encoder
 
providesDeviceSdrs() - Method in class org.metricshub.ipmi.client.DeviceId
Tells whether the device provides Device SDRs, as a satellite controller does.
providesDeviceSdrs() - Method in class org.metricshub.ipmi.core.coding.commands.app.GetDeviceIdResponseData
Tells whether the device provides Device SDRs (byte 3, bit 7).
Psi - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
PxeBootCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PxeBootRequested - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
PxeServerNotFound - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 

Q

QueueElement - Class in org.metricshub.ipmi.core.connection.queue
 
QueueElement(int, PayloadCoder, boolean) - Constructor for class org.metricshub.ipmi.core.connection.queue.QueueElement
 
Qword - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

R

RackMountChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
Radians - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
RaidChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
Rakp1 - Class in org.metricshub.ipmi.core.coding.commands.session
A wrapper for RMCP+ RAKP1 message and it's response - RAKP2 message.
Rakp1 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
RAKP Message 1
Rakp1(int, PrivilegeLevel, String, byte[], byte[], CipherSuite) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.Rakp1
Initiates class for encoding and decoding.
Rakp1Complete - Class in org.metricshub.ipmi.core.sm.states
At this state RAKP Message 2 was received - waiting for the confirmation to send RAKP Message 3.
Rakp1Complete(Rakp1) - Constructor for class org.metricshub.ipmi.core.sm.states.Rakp1Complete
Initiates state.
Rakp1ResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
A wrapper for RAKP 2 message.
Rakp1ResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
Rakp1Waiting - Class in org.metricshub.ipmi.core.sm.states
Waiting for RAKP Message 2.
Rakp1Waiting(int, Rakp1) - Constructor for class org.metricshub.ipmi.core.sm.states.Rakp1Waiting
Initiates state.
Rakp2 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
RAKP Message 2
Rakp2Ack - Class in org.metricshub.ipmi.core.sm.events
Performs transition from Rakp1Complete to Rakp3Waiting.
Rakp2Ack(CipherSuite, int, byte, int, Rakp1ResponseData) - Constructor for class org.metricshub.ipmi.core.sm.events.Rakp2Ack
Prepares Rakp2Ack.
Rakp3 - Class in org.metricshub.ipmi.core.coding.commands.session
A wrapper for RMCP+ RAKP3 message and it's response - RAKP4 message.
Rakp3 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
RAKP Message 3
Rakp3(byte, int, CipherSuite, Rakp1, Rakp1ResponseData) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.Rakp3
Initiates class for encoding and decoding.
Rakp3(CipherSuite, Rakp1, Rakp1ResponseData) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.Rakp3
Initiates class for decoding.
Rakp3Complete - Class in org.metricshub.ipmi.core.sm.states
Empty state inserted to keep the convention of Waiting-Complete states.
Rakp3Complete() - Constructor for class org.metricshub.ipmi.core.sm.states.Rakp3Complete
 
Rakp3ResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
A wrapper for RAKP 3 message.
Rakp3ResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.Rakp3ResponseData
 
Rakp3Waiting - Class in org.metricshub.ipmi.core.sm.states
At this point of session challenge, RAKP Message 3 was sent, StateMachine is waiting for RAKP Message 4.
Transition to: Rakp3Complete on DefaultAck Authcap on Timeout
Rakp3Waiting(int, Rakp1, Rakp1ResponseData, CipherSuite) - Constructor for class org.metricshub.ipmi.core.sm.states.Rakp3Waiting
Initiates state.
Rakp4 - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
RAKP Message 4
Randomizer - Class in org.metricshub.ipmi.core.common
Utility class for generating the random numbers of the RMCP+ session setup (the console random number of RAKP Message 1, the first console session ID), with a SecureRandom: a predictable console random number weakens the session keys.
RateUnit - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
 
raw(int, int) - Method in class org.metricshub.ipmi.client.IpmiClient
Sends any request in the session, like ipmitool raw, and returns its reply whatever its completion code: bmc.raw(0x2C, 0x01).data(0xDC, 0x01).execute() is Get DCMI Capabilities Info.
rawCompletionCode() - Method in exception org.metricshub.ipmi.client.IpmiCompletionCodeException
Returns the completion code byte as the BMC sent it, for the codes the library does not model (the command-specific and OEM ones).
rawCompletionCode() - Method in class org.metricshub.ipmi.client.RawResponse
Returns the completion code byte as the BMC sent it.
RawMultiRecordInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
A multirecord of a type the library does not model (Extended DC Output, Extended DC Load, a reserved type...): its type and its data as they are, so that nothing of the FRU is lost.
RawMultiRecordInfo(int, byte[], int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.RawMultiRecordInfo
Creates the record.
rawReading() - Method in class org.metricshub.ipmi.client.Sensor
Returns the reading byte as the BMC sent it, before any conversion.
RawRequest - Class in org.metricshub.ipmi.client
Sends any request, like ipmitool raw: bmc.raw(0x2C, 0x01).data(0xDC, 0x01).execute() is Get DCMI Capabilities Info.
RawResponse - Class in org.metricshub.ipmi.client
The reply to a raw request (IpmiClient.raw(int, int)): its completion code and its data as the BMC sent them, whatever the completion code.
rawStates() - Method in class org.metricshub.ipmi.client.Sensor
Returns the asserted states of the sensor as the protocol core decodes them.
read(int) - Method in class org.metricshub.ipmi.core.common.ByteBuffer
Attempts to read given number of bytes from this ByteBuffer.
READ_FRU_DATA - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Read FRU Data command
readBytes() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Read all available bytes from the port.
readBytes(int) - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
Attempts to read given number of bytes from this ByteBuffer.
readBytes(int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of bytes from the port.
readBytes(int, int) - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
Reads at most the given number of bytes, once they are available, the buffer is full (no other character arrives before a read), or the timeout expires.
readBytes(int, int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of bytes from the port.
ReadFruData - Class in org.metricshub.ipmi.core.coding.commands.fru
A wrapper class for Read FRU Data Command request.
ReadFruData(int, BaseUnit, int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.ReadFruData
Initiates ReadFruData for both encoding and decoding, addressed to LUN 0.
ReadFruData(int, BaseUnit, int, int, int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.ReadFruData
Initiates ReadFruData for both encoding and decoding.
ReadFruDataResponseData - Class in org.metricshub.ipmi.core.coding.commands.fru
Wrapper for Read FRU Data response.
ReadFruDataResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.ReadFruDataResponseData
 
reading() - Method in class org.metricshub.ipmi.client.Sensor
Returns the reading of a threshold sensor (event/reading type 01h), in its Sensor.unit() (a percentage of it when Sensor.percentage() says so), converted with the formula and the linearization of its record, or for a non-linear sensor with the factors the BMC returned for the reading.
readingData() - Method in class org.metricshub.ipmi.client.Sensor
Returns the reply to Get Sensor Reading, of the BMC or of the controller behind it that owns the sensor, as the protocol core decodes it.
ReadingType - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
Type of the reading of the discrete sensor.
ReadingTypeDescription - Class in org.metricshub.ipmi.client
The descriptions of the ReadingType states and events, in the wording of ipmiutil (of ipmitool for the few that ipmiutil does not name), used by Sensor.states() and SelEntry.description().
readIntArray() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads all available bytes from the port as integer (in range from 0 to 255) values array.
readIntArray(int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of integer values (in range from 0 to 255) from the port.
readIntArray(int, int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of integer values (in range from 0 to 255) from the port.
readNextField(int) - Method in class org.metricshub.ipmi.core.common.MessageReader
 
readString() - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Read all available bytes from the port and converts them to String using platform's default Charset.
readString(int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of bytes from the port, converting them to String using platform's default Charset.
readString(int, int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of bytes from the port, converting them to String using platform's default Charset.
readString(Charset) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Read all available bytes from the port and converts them to String using given Charset.
readString(Charset, int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of bytes from the port, converting them to String using given Charset.
readString(Charset, int, int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Reads at max given number of bytes from the port, converting them to String using given Charset.
RealTimeClock - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
reason() - Method in class org.metricshub.ipmi.client.SkippedRecord
Returns why the record was skipped.
RebuildRemapAborted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
RebuildRemapInProgress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
record() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the decoded record of the protocol core, for everything else.
record() - Method in class org.metricshub.ipmi.client.Sensor
Returns the SDR record of the sensor, as the protocol core decodes it: a FullSensorRecord, which holds the conversion formula and the thresholds, or a CompactSensorRecord, which holds neither.
RECORD_SIZE - Static variable in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
The size of every SEL record, whatever its type (IPMI 2.0 section 32): 16 bytes.
recordId() - Method in class org.metricshub.ipmi.client.SkippedRecord
Returns the ID of the record in the SDR repository.
records() - Method in class org.metricshub.ipmi.client.Fru
Returns the records decoded from the FRU inventory: the internal use area (InternalUseInfo), the chassis, board and product areas, then the multirecords, each when the inventory has it and it could be decoded.
recordType() - Method in class org.metricshub.ipmi.client.SkippedRecord
Returns the record type (IPMI 2.0 table 43-1).
RecordTypes - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
Class holding codes for SDR types.
RedundancyDegraded - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Redundancy still exists, but at a less than full level.
RedundancyDegradedFromFullyRedundant - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Unit has lost some redundant resource(s) but is still in a redundant state.
RedundancyDegradedFromNonRedundant - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Unit has regained some resource(s) and is redundant but not fully redundant.
RedundancyLost - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Entered any non-redundant state, including ReadingType.NonRedundant_InsufficientResources
register(MachineObserver) - Method in class org.metricshub.ipmi.core.sm.StateMachine
Registers the listener in the StateMachine so it will be notified of the StateMachineActions performed via StateMachine.doExternalAction(StateMachineAction)
register(UdpListener) - Method in interface org.metricshub.ipmi.core.transport.Messenger
Registers listener in the Messenger so it will be notified via UdpListener.notifyMessage(UdpMessage) when new message arrives.
register(UdpListener) - Method in class org.metricshub.ipmi.core.transport.UdpMessenger
Registers listener in the UdpMessenger so it will be notified via UdpListener.notifyMessage(UdpMessage) when new message arrives.
registerEventListener(SolEventListener) - Method in class org.metricshub.ipmi.client.SolConsole
Registers a listener for the status events of the console (break, deactivation, overrun, control lines).
registerEventListener(SolEventListener) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Registers new SolEventListener that will be informed about SOL events fired by remote system.
registerIncomingMessageListener(InboundMessageListener) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Registers InboundMessageListener that will react on any request sent from remote system to the application.
registerIncomingPayloadListener(InboundMessageListener) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Registers the listener for incoming messages.
registerListener(int, ConnectionListener) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Registers the listener so it will receive notifications from connection
registerListener(IpmiResponseListener) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Registers the listener so it will be notified of incoming messages.
registerListener(ConnectionListener) - Method in class org.metricshub.ipmi.core.connection.Connection
Registers the listener so it will receive notifications from this connection
registerSession(int, int, ConnectionHandle) - Method in class org.metricshub.ipmi.core.connection.SessionManager
Either returns the Session registered for given connection, or creates new IPMI Session and registers it for the given connection handle, if no session was found for the connection.
registerSession(int, ConnectionHandle) - Method in class org.metricshub.ipmi.core.connection.SessionManager
Either returns the Session registered for given connection, or creates new IPMI Session and registers it for the given connection handle, if no session was found for the connection.
remainingSpace() - Method in class org.metricshub.ipmi.core.common.ByteBuffer
Returns remainig space in the buffer (number of bytes that can still be written to this buffer until it gets full).
REMOTE_CONSOLE_ADDRESS - Static variable in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanConstants
The address of the remote console.
RemoteManagementCommunicationDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
remove(int) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Removes message with the given tag from the queue.
remove(QueueElement) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Removes the given element from the queue, if it is still there: a request sent again under the same tag is another element, which stays.
RequestTruncated - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Request data truncated.
ReservationCanceled - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Reservation Canceled or Invalid Reservation ID.
RESERVE_SDR_REPOSITORY - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Reserve SDR Repository command
RESERVE_SEL - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Reserve SEL command
Reserved - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
 
Reserved - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
A sensor type code IPMI 2.0 table 42-3 reserves: 00h and 2Dh to BFh.
Reserved - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
A reserved record type (00h-01h and 03h-BFh, IPMI 2.0 section 31.6.1): only the record ID of such an entry is meaningful.
ReserveDeviceSdrRepository - Class in org.metricshub.ipmi.core.coding.commands.sdr
Reserve Device SDR Repository (IPMI 2.0 section 35.4): the reservation of the partial reads of GetDeviceSdr.
ReserveDeviceSdrRepository() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.ReserveDeviceSdrRepository
Creates the command.
ReserveSdrRepository - Class in org.metricshub.ipmi.core.coding.commands.sdr
Wrapper for Reserve SDR Repository command.
ReserveSdrRepository() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.ReserveSdrRepository
Initiates ReserveSdrRepository for both encoding and decoding.
ReserveSdrRepositoryResponseData - Class in org.metricshub.ipmi.core.coding.commands.sdr
Wrapper for Reserve SDR Repository command response.
ReserveSdrRepositoryResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.ReserveSdrRepositoryResponseData
 
ReserveSel - Class in org.metricshub.ipmi.core.coding.commands.sel
Wrapper for Reserve SEL command.
ReserveSel() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.ReserveSel
Initiates ReserveSel for both encoding and decoding.
ReserveSelResponseData - Class in org.metricshub.ipmi.core.coding.commands.sel
Wrapper for Reserve SEL command response.
ReserveSelResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.ReserveSelResponseData
 
Reset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
ResetButtonPressed - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
resetPacketNumbers() - Method in class org.metricshub.ipmi.core.connection.SolMessageHandler
Numbers the packets from 1 again, both ways, as a new activation of the payload does (ipmitool, OpenBMC): the packets of the previous activation still queued (operations whose acknowledgement never came) leave the queue with their numbers.
resetSequenceNumber() - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Numbers the next request from the first sequence number again: a new SOL payload activation numbers its packets from 1.
ResponseAction - Class in org.metricshub.ipmi.core.sm.actions
StateMachineAction carrying ResponseData for the message in the process of the session challenge.
ResponseAction(ResponseData) - Constructor for class org.metricshub.ipmi.core.sm.actions.ResponseAction
 
ResponseData - Interface in org.metricshub.ipmi.core.coding.commands
A wrapper for command response data.
ResponseUnavailable - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command response could not be provided.
retries(int) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets how many times a message is sent again; 3 by default.
retry(int) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Returns the queued request with the given tag, which is about to be sent again, and restarts its timeout: the request moves to the end of the queue, which stays in the order of the timeouts, with its tag.
retry(int, PayloadType) - Method in class org.metricshub.ipmi.core.connection.Connection
Attempts to retry sending a message.
retry(ConnectionHandle, int, PayloadType) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Attempts to retry sending a message.
Retry - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
retryMessage(int, StateMachine, int) - Method in class org.metricshub.ipmi.core.connection.MessageHandler
Attempts to retry sending message with given tag, assuming that this message exists in message queue.
retryMessage(ConnectionHandle, byte, PayloadType) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Re-sends message with given tag having given PayloadType, using passed ConnectionHandle.
revision() - Method in class org.metricshub.ipmi.client.DeviceId
Returns the revision of the device, as the manufacturer numbers it.
Revolutions - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
RingWOR - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
Assert RI (may not be supported on all implementations) - Goal is to allow this to be used for generating a WOR.
RMCP_V1_0 - Static variable in class org.metricshub.ipmi.core.coding.rmcp.RmcpConstants
RMCP version 1.0
RMCP1_0 - Enum constant in enum org.metricshub.ipmi.core.coding.rmcp.RmcpVersion
 
RmcpClassOfMessage - Enum in org.metricshub.ipmi.core.coding.rmcp
Types of RMCP messages.
RmcpConstants - Class in org.metricshub.ipmi.core.coding.rmcp
Set of constants.
RmcpDecoder - Class in org.metricshub.ipmi.core.coding.rmcp
Decodes RMCP packet from raw data.
RmcpEncoder - Class in org.metricshub.ipmi.core.coding.rmcp
Encodes RMCPMessage into RMCP packet.
RmcpIpmiMessage - Class in org.metricshub.ipmi.core.coding.rmcp
A wrapper class for ASF ping message.
RmcpIpmiMessage(byte[]) - Constructor for class org.metricshub.ipmi.core.coding.rmcp.RmcpIpmiMessage
Prepares a ready to send ASF IPMI message.
RmcpMessage - Class in org.metricshub.ipmi.core.coding.rmcp
A wrapper class for RMCP message.
RmcpMessage() - Constructor for class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
RmcpOpenSessionRequest - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
RmcpOpenSessionResponse - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
 
RmcpPingMessage - Class in org.metricshub.ipmi.core.coding.rmcp
A wrapper class for ASF ping message.
RmcpPingMessage(int) - Constructor for class org.metricshub.ipmi.core.coding.rmcp.RmcpPingMessage
Prepares a ready to send ASF ping message.
RMCPPlus - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
RmcpVersion - Enum in org.metricshub.ipmi.core.coding.rmcp
Supported versions of RMCP protocol
RomBootCompleted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Rpm - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
RtsAsserted - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
When test mode active, signals that RTS is asserted on serial port.
run() - Method in class org.metricshub.ipmi.core.connection.Connection
TimerTask runner - periodically sends a no-op message to keep the session up: a Get Device ID (as ipmitool sends) sent one-way, whose reply is discarded unread and whose timeout is not reported to the listeners.
run() - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
TimerTask runner - periodically checks queue for timed out messages.
run() - Method in class org.metricshub.ipmi.core.transport.UdpMessenger
 
RunTimeCriticalStop - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
a.k.a.

S

SataBus - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
SATA/SAS bus.
ScsiBus - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SDR_REPOSITORY_DEVICE - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device holds the SDR repository (bit 1).
sdrCache(boolean) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Tells whether the client caches the SDR repository it reads, so that IpmiClient.sensors() and IpmiClient.frus() walk it once; enabled by default.
SdrUpdating - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Command response could not be provided.
Second - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Seconds - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
 
SecureModeViolationAttempt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SecurityConstants - Class in org.metricshub.ipmi.core.coding.security
Set of constants.
sel() - Method in class org.metricshub.ipmi.client.IpmiClient
Reads the System Event Log (SEL): sel().execute() for every entry, with SelRequest.since(SelEntry) for the entries added after one already read.
SEL_DEVICE - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device holds the System Event Log (bit 2).
SelAlmostFull - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SelEntry - Class in org.metricshub.ipmi.client
One entry of the System Event Log, read by IpmiClient.sel().
SelEntryList - Class in org.metricshub.ipmi.client
The entries read from the System Event Log by SelRequest.execute(), in the order of the log, with what Get SEL Info says of the whole log: how many entries it holds, and when it was last written and erased.
SelFull - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SelRecord - Class in org.metricshub.ipmi.core.coding.commands.sel
A System Event Log record as the BMC sent it (IPMI 2.0 section 32), decoded: its type, its timestamp and, for a system event, the sensor and the event.
SelRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
 
SelRecordType - Enum in org.metricshub.ipmi.core.coding.commands.sel
The record type of a SEL entry (IPMI 2.0 section 31.6.1): one constant per range of record type codes.
SelRequest - Class in org.metricshub.ipmi.client
Reads the System Event Log: bmc.sel().execute() for every entry, bmc.sel().since(entry).execute() for the entries added after one already read, and bmc.sel().stream() to get each entry as soon as it is read.
send(IpmiCommandCoder<R>) - Method in class org.metricshub.ipmi.client.IpmiClient
Sends any command of the protocol core in the session and returns its typed reply, for the commands the client does not wrap: bmc.send(new GetDeviceId()).
send(UdpMessage) - Method in interface org.metricshub.ipmi.core.transport.Messenger
Sends UdpMessage.
send(UdpMessage) - Method in class org.metricshub.ipmi.core.transport.UdpMessenger
Sends UdpMessage.
sendMessage(byte[]) - Method in class org.metricshub.ipmi.core.sm.StateMachine
Sends message via StateMachine.messenger to the managed system.
sendMessage(ConnectionHandle, IpmiCommandCoder<R>) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Sends the IPMI command to the remote host and returns its typed response.
sendMessage(ConnectionHandle, IpmiCommandCoder<R>, int) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Sends the IPMI command to the remote host with its own number of resends when no reply comes, instead of IpmiConnector.getRetries(): 0 for a command the BMC must not receive twice (a chassis reset, whose reply can be lost after the BMC carried it out).
sendMessage(ConnectionHandle, PayloadCoder) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Sends the IPMI message to the remote host.
sendMessage(ConnectionHandle, PayloadCoder, boolean) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Sends the IPMI message to the remote host.
sendMessage(PayloadCoder, boolean) - Method in class org.metricshub.ipmi.core.connection.Connection
Attempts to send IPMI request to the managed system.
sendMessage(PayloadCoder, StateMachine, int, boolean) - Method in class org.metricshub.ipmi.core.connection.MessageHandler
Attempts to send message encoded by given PayloadCoder to the remote system.
SendMessage<R extends ResponseData> - Class in org.metricshub.ipmi.core.coding.commands.app
Send Message with response tracking (IPMI 2.0 sections 6.13.3 and 22.7): carries the request of another command to a controller behind the BMC, a satellite management controller on the IPMB for instance, and returns the response of that controller, decoded by that command.
SendMessage(int, int, IpmiCommandCoder<R>) - Constructor for class org.metricshub.ipmi.core.coding.commands.app.SendMessage
Creates the command.
sendOneWayMessage(ConnectionHandle, PayloadCoder) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Sends the IPMI message to the remote host and doesn't wait for any response.
Sendv20Message - Class in org.metricshub.ipmi.core.sm.events
Performed in SessionValid State will cause Sendv20Message.message to be sent.
Sendv20Message(PayloadCoder, int, int, int) - Constructor for class org.metricshub.ipmi.core.sm.events.Sendv20Message
Prepares an event for StateMachine that will perform sending an IPMI command in v2.0 format.
Sensor - Class in org.metricshub.ipmi.client
A sensor of the BMC, with its SDR record and its reading.
SENSOR_DEVICE - Enum constant in enum org.metricshub.ipmi.client.DeviceFunction
The device has sensors (bit 0).
SensorAccessUnavailable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Sensor access degraded or unavailable.
SensorDirection - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
Indicates whether the sensor is monitoring an input or output relative to the given Entity.
SensorFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
The sensor is known to be in error.
SensorList - Class in org.metricshub.ipmi.client
The sensors read by IpmiClient.sensors(): an unmodifiable list, with the SDR records the repository walk skipped.
sensorNumber() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the number of the sensor that reported a system event, unique for its generator: the Sensor.number() of the sensor in the SDR repository.
SensorReadingFactors - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
The factors that convert a raw reading into a value in the units of the sensor: M, B and their exponents, with the tolerance and the accuracy.
SensorReadingFactors(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorReadingFactors
Decodes the 6 bytes of the factors.
SensorRecord - Class in org.metricshub.ipmi.core.coding.commands.sdr.record
A record of the Sensor Data Repository (IPMI 2.0 section 43): the record header that every type shares, and SensorRecord.populateSensorRecord(byte[]), which decodes a record into the class of its type.
SensorRecord() - Constructor for class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
 
SensorRequest - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
Sensor/Event Request
SensorResponse - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
Sensor/Event Response
sensors() - Method in class org.metricshub.ipmi.client.IpmiClient
Reads the sensors of the BMC: sensors().execute() for all of them, with types() and names() to select some before their readings are requested, and sensors().stream() to get each sensor as soon as it is read.
SensorsRequest - Class in org.metricshub.ipmi.client
Reads the sensors of the BMC: the Full and Compact sensor records of the SDR repository, each with its Get Sensor Reading.
SensorState - Enum in org.metricshub.ipmi.core.coding.commands.sdr
Represents state of threshold-based sensor.
SensorStatus - Enum in org.metricshub.ipmi.client
The status of a sensor: for a threshold sensor, the worst threshold its reading is at or beyond (IPMI 2.0 table 35-15); for a discrete sensor, whether it answers.
sensorType() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the type of the sensor that reported a system event (IPMI 2.0 table 42-3).
SensorType - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
Type of the sensor.
sensorTypeCode() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the sensor type code of a system event (byte 11 of the record, IPMI 2.0 table 42-3), which SelEntry.sensorType() does not keep for an OEM sensor type (SensorType.Oem, C0h to FFh) or a reserved one (SensorType.Reserved).
SensorUnit - Enum in org.metricshub.ipmi.core.coding.commands.sdr.record
Specifies available units for sensors' measurements.
serialNumber() - Method in class org.metricshub.ipmi.client.Fru
Returns the serial number, from the product area, or from the board area when the product area does not give it; the one of a memory module; the PPIN of a processor.
SerialOverLan - Class in org.metricshub.ipmi.core.api.sol
A Serial over LAN (SOL) console in a session of the protocol core: activates the SOL payload, reads and writes the serial port of the server, and invokes the serial port operations.
SerialOverLan(IpmiConnector, String, int, String, String, byte[], CipherSuiteSelectionHandler) - Constructor for class org.metricshub.ipmi.core.api.sol.SerialOverLan
Creates connection with IPMI using given IpmiConnector, connected to remote machine on given address and port, and opens a new Session for SOL communication, with the BMC key of a BMC configured for two-key logins.
SerialOverLan(IpmiConnector, String, int, String, String, CipherSuiteSelectionHandler) - Constructor for class org.metricshub.ipmi.core.api.sol.SerialOverLan
Creates connection with IPMI using given IpmiConnector, connected to remote machine on given address and port, and opens a new Session for SOL communication.
SerialOverLan(IpmiConnector, String, String, String, CipherSuiteSelectionHandler) - Constructor for class org.metricshub.ipmi.core.api.sol.SerialOverLan
Creates connection with IPMI using given IpmiConnector, connected to remote machine on given address and default IPMI port, and opens a new Session for SOL communication.
SerialOverLan(IpmiConnector, Session) - Constructor for class org.metricshub.ipmi.core.api.sol.SerialOverLan
Tries to open SOL communication on given existing session.
SerialOverLan(IpmiConnector, Session, PrivilegeLevel, PrivilegeLevel) - Constructor for class org.metricshub.ipmi.core.api.sol.SerialOverLan
Tries to open SOL communication on given existing session, like SerialOverLan(IpmiConnector, Session), for a session opened with PrivilegeLevel.MaximumAvailable whose level its owner keeps: the console raises it from the given level, when the BMC refuses to activate the payload at that level, as far as the given ceiling only.
Session - Class in org.metricshub.ipmi.core.connection
Single opened IPMI session handle.
Session(int, int, ConnectionHandle) - Constructor for class org.metricshub.ipmi.core.connection.Session
 
Session(int, ConnectionHandle) - Constructor for class org.metricshub.ipmi.core.connection.Session
 
SessionActivated - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SessionAudit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
SessionDeactivated - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SessionException - Exception in org.metricshub.ipmi.core.connection
Exception that can be thrown when there are some problems with session, for example when establishig new session.
SessionException(String, Throwable) - Constructor for exception org.metricshub.ipmi.core.connection.SessionException
 
SessionManager - Class in org.metricshub.ipmi.core.connection
Manages multiple Sessions.
SessionManager() - Constructor for class org.metricshub.ipmi.core.connection.SessionManager
 
SessionValid - Class in org.metricshub.ipmi.core.sm.states
State in which the session is valid and sending IPMI commands to the remote machine is enabled.
SessionValid(CipherSuite, int) - Constructor for class org.metricshub.ipmi.core.sm.states.SessionValid
Initiates the state.
SET_SESSION_PRIVILEGE_LEVEL - Static variable in class org.metricshub.ipmi.core.coding.commands.CommandCodes
An IPMI code for Set Session Privilege Level command
setAccessInfo(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessInfo
Sets the management access information.
setAccessLun(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the LUN of the commands that access the FRU device.
setAccessLun(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setAccuracy(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the accuracy of the readings.
setActiveSessions(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
setAdditionTimestamp(Date) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Sets the time of the most recent addition to the SEL.
setAddress(InetAddress) - Method in class org.metricshub.ipmi.core.transport.UdpMessage
Target address when sending message.
setAddressSpan(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setAddressType(AddressType) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets whether the sensor owner ID is an IPMB slave address or a system software ID.
setAddTimestamp(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
setAnonymusLoginEnabled(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setAssetTag(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the asset tag.
setAuthCode(byte[]) - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
setAuthenticationAlgorithm(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setAuthenticationType(AuthenticationType) - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
 
setAuthenticationType(AuthenticationType) - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
setAuthenticationType(AuthenticationType) - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv15Message
 
setAuthenticationTypes(Collection<AuthenticationType>) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setAuxilaryInformationData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Set auxiliary information data
setAuxilaryInformationData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivateSolPayloadResponseData
 
setAvailableInstances(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatusResponseData
 
setBitOnPosition(int, byte) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
 
setBmcKey(byte[]) - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Sets the BMC key (Kg) of the session.
setBoardManufacturer(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Sets the board manufacturer.
setBoardPartNumber(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Sets the board part number.
setBoardProductName(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Sets the board product name.
setBoardSerialNumber(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Sets the board serial number.
setBusId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setCapacity(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the overall capacity of the power supply.
setChannel(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
setChannelNumber(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the channel number of the sensor owner.
setChannelNumber(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setChannelNumber(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuitesResponseData
 
setChannelNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupport
Sets the channel number that will be put into IPMI command.
setChannelNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setChannelNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setChannelNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setChannelNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
Sets the channel number that will be put into IPMI command.
setChannelNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
Sets the channel number that will be put into IPMI command.
setChassisPartNumber(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Sets the chassis part number.
setChassisSerialNumber(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Sets the chassis serial number.
setChassisType(ChassisType) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ChassisInfo
Sets the type of the chassis.
setCipherSuite(CipherSuite) - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Sets the cipher suite of the session.
setCipherSuite(CipherSuite) - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
 
setCipherSuiteData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuitesResponseData
 
setClassOfMessage(RmcpClassOfMessage) - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
setCodeRangeMasks(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Sets the code range masks of the record.
setCodeStart(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Sets the compatibility code start value of the record.
setCommand(byte) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
setCompatibilityBase(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Sets the compatibility base of the record.
setCompletionCode(byte) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanResponse
Decodes the completion code.
setConfidentialityAlgorithm(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setConfidentialityAlgorithm(ConfidentialityAlgorithm) - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
setConsoleSessionId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3ResponseData
 
setContainerEntityDeviceAddress(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setContainerEntityDeviceChannel(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setContainerEntityId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setContainerEntityId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setContainerEntityInstance(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setContainerEntityInstance(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setCurrent(State) - Method in class org.metricshub.ipmi.core.sm.StateMachine
 
setCurrentPowerState(byte) - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Sets the current power state byte.
setCustomBoardInfo(String[]) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Sets the custom fields of the board area.
setCustomProductInfo(String[]) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the custom fields of the product area.
setData(byte[]) - Method in class org.metricshub.ipmi.core.coding.payload.IpmiPayload
 
setData(byte[]) - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
setDelTimestamp(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
setDeviceAccessAddress(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the slave address of the controller used to access the FRU device.
setDeviceAccessAddress(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setDeviceAddress(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setDeviceGuid(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setDeviceId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the FRU device ID, or the slave address of a non-logical FRU device.
setDeviceId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setDeviceRevision(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setDeviceSlaveAddress(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setDeviceSlaveAddress(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setDeviceType(DeviceType) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the type of the FRU device.
setDeviceType(DeviceType) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setDeviceTypeModifier(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the device type modifier of the FRU device.
setDeviceTypeModifier(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setEntitiesAsRange(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntitiesAsRange(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityDeviceAddress1(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityDeviceAddress2(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityDeviceAddress3(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityDeviceAddress4(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityDeviceChannel1(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityDeviceChannel2(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityDeviceChannel3(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityDeviceChannel4(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setEntityId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setEntityId(EntityId) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Sets the entity ID of the record.
setEntityId(EntityId) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the entity the sensor monitors.
setEntityInstance(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setEntityInstance(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setEntityInstanceIncrements(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets whether the entity instance number increments for each sensor sharing this record.
setEntityInstanceNumber(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the instance number of the entity.
setEntityPhysical(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets whether the entity is a physical entity or a logical container entity.
setEntityRange1(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRange1(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityRange2(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRange2(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityRange3(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRange3(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityRange4(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRange4(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityRangeInstance1(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRangeInstance1(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityRangeInstance2(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRangeInstance2(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityRangeInstance3(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRangeInstance3(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntityRangeInstance4(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setEntityRangeInstance4(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setEntriesCount(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Sets the number of entries in the SEL.
setEraseTimestamp(Date) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Sets the time of the most recent erasure of SEL entries.
setEvent(ReadingType) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the event of a system event.
setEventData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the three event data bytes of a system event.
setEventDirection(EventDirection) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets whether a system event is an assertion or a deassertion.
setEventReadingType(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the event/reading type code of the sensor.
setEventType(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the event/reading type code of a system event.
setFirmwareRevision1(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setFirmwareRevision2(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setFrontPanelButtonCapabilities(byte) - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Sets the front panel button capabilities byte, which makes the front panel button getters available.
setFruData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.fru.ReadFruDataResponseData
Sets the bytes returned by the command.
setFruEntityId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the ID of the entity associated with this FRU information.
setFruEntityInstance(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the instance number of the entity associated with this FRU information.
setFruFileId(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Sets the FRU File ID field.
setFruFileId(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the FRU File ID field.
setFruInventoryAreaSize(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfoResponseData
Sets the size of the FRU inventory area.
setFruUnit(BaseUnit) - Method in class org.metricshub.ipmi.core.coding.commands.fru.GetFruInventoryAreaInfoResponseData
Sets how the FRU device is accessed.
setGeneratorId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the generator ID of a system event.
setHighEndInputFrequencyRange(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the high end of the acceptable input frequency range.
setHighEndInputVoltage1(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the high end of the acceptable input voltage range 1.
setHighEndInputVoltage2(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the high end of the acceptable input voltage range 2.
setHysteresisReadable(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets whether the hysteresis of the sensor can be read.
setId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Sets the record ID.
setIdInstanceModifierOffset(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the offset of the ID string instance modifier.
setIdInstanceModifierType(InstanceModifierType) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the type of the ID string instance modifier.
setInboundPayloadSize(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Set inbound payload size
setIndex(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelCipherSuites
 
setInstanceCapacity(byte) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatusResponseData
 
setIntegrityAlgorithm(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setIpmiResponseData(ResponseData) - Method in class org.metricshub.ipmi.core.sm.actions.ResponseAction
 
setIpmiv20Support(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setIpmiVersion(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setIpmiVersion(IpmiVersion) - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
 
setKgEnabled(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setLastPowerEvent(byte) - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Sets the last power event byte.
setLineOperations(Set<SolOperation>) - Method in class org.metricshub.ipmi.core.api.async.InboundSolMessageListener
Sets the serial line states (CTS, DCD/DSR, Ring) that the console holds in every packet it sends: they are levels, which a packet without them releases (IPMI 2.0 table 15-2).
setLogical(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets whether the FRU device is a logical FRU device.
setLowEndInputFrequencyRange(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the low end of the acceptable input frequency range.
setLowEndInputVoltage1(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the low end of the acceptable input voltage range 1.
setLowEndInputVoltage2(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the low end of the acceptable input voltage range 2.
setLowerCriticalThreshold(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the lower critical threshold of the sensor.
setLowerNonCriticalThreshold(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the lower non-critical threshold of the sensor.
setLowerNonRecoverableThreshold(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the lower non-recoverable threshold of the sensor.
setManagedSystemGuid(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
setManagedSystemRandomNumber(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
setManagedSystemSessionId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setManagedSystemSessionId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
setManagedSystemSessionId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
setManagementChannelNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the channel number of the management controller used to access the FRU device.
setManufacturerId(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BaseCompatibilityInfo
Sets the manufacturer ID of the record.
setManufacturerId(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.OemInfo
Sets the manufacturer ID of the record.
setManufacturerId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setManufacturerId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.OemRecord
 
setManufacturerId(Integer) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the manufacturer ID of a timestamped OEM record.
setManufacturerName(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the product manufacturer name.
setMaximumCurrentLoad(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Sets the maximum current load of the device on the output.
setMaximumInrush(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the maximum inrush of current into the power supply.
setMaximumNegativeDeviation(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Sets the maximum negative deviation from the nominal voltage.
setMaximumPositiveDeviation(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Sets the maximum positive deviation from the nominal voltage.
setMaximumVoltage(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Sets the maximum voltage the device accepts.
setMaxSessions(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
setMessage(byte[]) - Method in class org.metricshub.ipmi.core.transport.UdpMessage
 
setMessageTag(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setMessageTag(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
setMessageTag(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3ResponseData
 
setMfgDate(Date) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.BoardInfo
Sets the manufacturing date and time of the board.
setMinimumCurrentLoad(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Sets the minimum current load of the device on the output.
setMinimumVoltage(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Sets the minimum voltage the device accepts.
setMiscChassisState(byte) - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Sets the miscellaneous chassis state byte.
setModifierUnitUsage(ModifierUnitUsage) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets how the modifier unit combines with the base unit.
setName(String) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the sensor ID string.
setName(String) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FruDeviceLocatorRecord
Sets the device ID string of the FRU device.
setName(String) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.GenericDeviceLocatorRecord
 
setName(String) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setNetworkFunction(NetworkFunction) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
setNextRecordId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrResponseData
 
setNextRecordId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntryResponseData
 
setNominalReading(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the nominal reading of the sensor.
setNominalVoltage(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Sets the nominal voltage the device requires.
setNominalVoltage(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Sets the nominal voltage of the output.
setNonNullUsernamesEnabled(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setNormalMaximum(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the normal maximum of the sensor.
setNormalMinimum(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the normal minimum of the sensor.
setNullUsernamesEnabled(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setOemData(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setOemData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.OemInfo
Sets the OEM data of the record.
setOemData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.OemRecord
 
setOemData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the OEM-defined bytes of an OEM record.
setOemIANA(int) - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
setOemId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setOemPayloadID(Object) - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
setOemPayloads(byte) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupportResponseData
 
setOffsetMinutes(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffsetResponseData
 
setOutboundPayloadSize(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Set outbound payload size
setOutputNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcLoadInfo
Sets the number of the DC output the device draws from.
setOutputNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.DcOutputInfo
Sets the number of the DC output.
setPassword(String) - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Sets the password of the session, encoded in UTF-8.
setPasswordBytes(byte[]) - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Sets the password of the session as bytes.
setPayload(IpmiPayload) - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
Sets IpmiMessage.payload and IpmiMessage.payloadLength
setPayloadAuthenticated(boolean) - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
setPayloadEncrypted(boolean) - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
setPayloadLength(int) - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
setPayloadType(PayloadType) - Method in class org.metricshub.ipmi.core.coding.protocol.Ipmiv20Message
 
setPayloadUdpPortNumber(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Set payload udp port number
setPayloadVlanNumber(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.payload.ActivatePayloadResponseData
Set payload vlan number
setPeakVa(int) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PowerSupplyInfo
Sets the highest instantaneous VA value that the power supply draws during operation.
setPercentage(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets whether the reading and the thresholds of the sensor are a percentage.
setPerMessageAuthenticationEnabled(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setPort(int) - Method in class org.metricshub.ipmi.core.transport.UdpMessage
Target port when sending message.
setPrivilegeLevel(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setPrivilegeLevel(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
setPrivilegeLevel(PrivilegeLevel) - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Sets the maximum privilege level requested for the session.
setProductId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerConfirmationRecord
 
setProductModelNumber(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the product part or model number.
setProductName(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the product name.
setProductSerialNumber(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the product serial number.
setProductVersion(String) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ProductInfo
Sets the product version.
setRateUnit(RateUnit) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the rate unit of the reading.
setRaw(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Sets the response data as the BMC sent it.
setRawData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the bytes of the record as the BMC sent them.
setReading(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the raw reading that triggered a threshold event.
setRecordCount(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
setRecordId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the record ID.
setRecordLength(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Sets the record length.
setRecordLink(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceRelativeEntityAssiciationRecord
Deprecated.
 
setRecordLink(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.EntityAssociationRecord
 
setRecordType(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Sets the record type code.
setRecordType(ManagementAccessRecordType) - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessInfo
Sets the kind of management access information the record holds.
setRecordType(SelRecordType) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the type of the record.
setRemoteConsoleSessionId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setRemoteConsoleSessionId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
setRequest(PayloadCoder) - Method in class org.metricshub.ipmi.core.connection.queue.QueueElement
 
setRequestedMaximumPrivilegeLevel(PrivilegeLevel) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
setRequestedPrivilegeLevel(PrivilegeLevel) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
 
setRequestedPrivilegeLevel(PrivilegeLevel) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
setRequesterAddress(byte) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
setRequesterLogicalUnitNumber(byte) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
setReservationId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.ReserveSdrRepositoryResponseData
 
setReservationId(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.ReserveSelResponseData
 
setReserveSupported(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
setResponderAddress(byte) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
setResponderLogicalUnitNumber(byte) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
setRetries(int) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Sets how many times a message without a reply is sent again, or a login whose step got no reply is started again from Open Session.
setRetries(int) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Sets how many times a message without a reply is sent again, or a login whose step got no reply is started again from Open Session.
setScanningEnabled(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Sets whether the BMC reports sensor scanning as enabled.
setSdrVersion(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrRepositoryInfoResponseData
 
setSdrVersion(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.SensorRecord
Sets the SDR version of the record.
setSelRecord(SelRecord) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelEntryResponseData
 
setSelVersion(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.GetSelInfoResponseData
Sets the version of the SEL command set.
setSensorBaseUnit(SensorUnit) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the base unit of the reading.
setSensorDirection(SensorDirection) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the direction of the sensor.
setSensorMaximumReading(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the maximum reading of the sensor.
setSensorMinmumReading(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the minimum reading of the sensor.
setSensorModifierUnit(SensorUnit) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the modifier unit of the reading.
setSensorNumber(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the number of the sensor.
setSensorNumber(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the number of the sensor that generated a system event.
setSensorOwnerId(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the sensor owner ID.
setSensorOwnerLun(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the LUN of the sensor owner.
setSensorReading(byte) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Sets the reading byte.
setSensorRecordData(byte[]) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSdrResponseData
 
setSensorState(SensorState) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Sets the most severe threshold the reading is at or beyond.
setSensorStateValid(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Sets whether the reading and the states are available.
setSensorType(SensorType) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the type of the sensor.
setSensorType(SensorType) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the type of the sensor that generated a system event.
setSensorTypeCode(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the sensor type code of the record.
setSensorTypeCode(int) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the sensor type code of a system event.
setSequenceNumber(byte) - Method in class org.metricshub.ipmi.core.coding.payload.lan.IpmiLanMessage
 
setSequenceNumber(int) - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
Set RMCP sequence number.
setSessionFound(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
setSessionHandle(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
setSessionID(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSession
 
setSessionID(int) - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
setSessionParameters(IpmiVersion, CipherSuite, AuthenticationType) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilities
Sets session parameters.
setSessionParameters(IpmiVersion, CipherSuite, AuthenticationType) - Method in class org.metricshub.ipmi.core.coding.PayloadCoder
Sets session parameters.
SetSessionPrivilegeLevel - Class in org.metricshub.ipmi.core.coding.commands.session
Wrapper class for Set Session Privilege Level command
SetSessionPrivilegeLevel(PrivilegeLevel) - Constructor for class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevel
Initiates SetSessionPrivilegeLevel for encoding and decoding
SetSessionPrivilegeLevelResponseData - Class in org.metricshub.ipmi.core.coding.commands.session
 
SetSessionPrivilegeLevelResponseData() - Constructor for class org.metricshub.ipmi.core.coding.commands.session.SetSessionPrivilegeLevelResponseData
 
setSessionSequenceNumber(int) - Method in class org.metricshub.ipmi.core.coding.protocol.IpmiMessage
 
setSessionSetupPayloads(byte) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupportResponseData
 
setShareCount(int) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets the number of sensors sharing this record.
setStandardPayloads(byte) - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetChannelPayloadSupportResponseData
 
setStatesAsserted(boolean[]) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.GetSensorReadingResponseData
Sets the state bits.
setStatusCode(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.OpenSessionResponseData
 
setStatusCode(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1ResponseData
 
setStatusCode(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3
 
setStatusCode(byte) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp3ResponseData
 
setSupportsBridge(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setSupportsChassis(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setSupportsFruInventoryDevice(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setSupportsIpmbEventGenerator(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setSupportsIpmbEventReciever(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setSupportsSdrRepositoryDevice(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setSupportsSelDevice(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setSupportsSensors(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.ManagementControllerDeviceLocatorRecord
 
setThresholdsReadable(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.AbstractSensorRecord
Sets whether the thresholds of the sensor can be read.
setTimeout(int) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Sets the timeout of the messages of the connections created from now on.
setTimeout(int) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Sets the timeout of the messages of the connections created from now on; IpmiConnector.setTimeout(ConnectionHandle, int) changes it for an existing connection.
setTimeout(int) - Method in class org.metricshub.ipmi.core.connection.Connection
 
setTimeout(int) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Sets the timeout of the messages of the connections created from now on.
setTimeout(int) - Method in class org.metricshub.ipmi.core.connection.MessageHandler
 
setTimeout(int) - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
 
setTimeout(ConnectionHandle, int) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Changes the timeout value for connection with the given handle.
setTimeout(ConnectionHandle, int) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Changes the timeout value for connection with the given handle.
setTimestamp(Date) - Method in class org.metricshub.ipmi.core.coding.commands.sel.SelRecord
Sets the timestamp of the record.
setTolerance(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the tolerance of the readings.
setUpperCriticalThreshold(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the upper critical threshold of the sensor.
setUpperNonCriticalThreshold(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the upper non-critical threshold of the sensor.
setUpperNonRecoverableThreshold(double) - Method in class org.metricshub.ipmi.core.coding.commands.sdr.record.FullSensorRecord
Sets the upper non-recoverable threshold of the sensor.
setUser(String) - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Sets the user name of the session.
setUserId(int) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
setUserLevelAuthenticationEnabled(boolean) - Method in class org.metricshub.ipmi.core.coding.commands.session.GetChannelAuthenticationCapabilitiesResponseData
 
setUsername(String) - Method in class org.metricshub.ipmi.core.coding.commands.session.Rakp1
 
setVersion(RmcpVersion) - Method in class org.metricshub.ipmi.core.coding.rmcp.RmcpMessage
 
Siemens - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Sievert - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Simple - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
 
since(int) - Method in class org.metricshub.ipmi.client.SelRequest
Reads only the entries added after the one with the given record ID: the ID of the last entry of a previous read, for a cursor kept without the entry itself (across restarts, for instance).
since(SelEntry) - Method in class org.metricshub.ipmi.client.SelRequest
Reads only the entries added after the given one, the last entry of a previous read: it is read again to find the next one and left out.
size() - Method in class org.metricshub.ipmi.client.FruList
 
size() - Method in class org.metricshub.ipmi.client.SelEntryList
 
size() - Method in class org.metricshub.ipmi.client.SensorList
 
size() - Method in class org.metricshub.ipmi.core.common.ByteBuffer
Returns current size of the buffer (number of available data to read).
SkippedRecord - Class in org.metricshub.ipmi.client
An SDR record the repository walk could not use: the BMC returned it truncated, or the library cannot decode it.
skippedRecords() - Method in class org.metricshub.ipmi.client.FruList
Returns the SDR records the repository walk could not use, with the reason.
skippedRecords() - Method in class org.metricshub.ipmi.client.SensorList
Returns the SDR records the repository walk could not use, with the reason.
SleepButtonPressed - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SlotConnector - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
SlotConnectorDeviceInstalled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SlotConnectorDeviceRemovalRequest - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
This is typically connected to a switch that becomes asserted to request removal of the device)
SlotConnectorFaultStatusAsserted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SlotConnectorIdentifyStatusAsserted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SlotConnectorReadyForDeviceInstallation - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Typically, this means that the slot power is off.
SlotConnectorReadyForDeviceRemoval - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SlotDisabled - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SlotHoldsSpareDevice - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SlotPowerOff - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SoftOsShutdown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SoftShutdown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Initiate a soft shutdown of the operating system via ACPI (optional), by emulating a fatal overtemperature.
Software - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SoftwareInitiatedHardReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SoftwareInitiatedWarmReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
sol() - Method in class org.metricshub.ipmi.client.IpmiClient
Opens a Serial over LAN console in the session: sol().open().
Sol - Enum constant in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
Serial over LAN packet
SolAckState - Enum in org.metricshub.ipmi.core.coding.payload.sol
Enumeration of possible acknowledge states for SOL messages.
SolCoder - Class in org.metricshub.ipmi.core.coding.sol
Implementation of PayloadCoder for payload type PayloadType.Sol.
SolCoder(byte[]) - Constructor for class org.metricshub.ipmi.core.coding.sol.SolCoder
Creates new SolCoder.
SolCoder(byte[], byte, byte, SolAckState, Set<SolOperation>) - Constructor for class org.metricshub.ipmi.core.coding.sol.SolCoder
Creates new SolCoder.
SolCoder(byte, byte, SolAckState) - Constructor for class org.metricshub.ipmi.core.coding.sol.SolCoder
Creates new SolCoder.
SolCoder(byte, byte, SolAckState, Set<SolOperation>) - Constructor for class org.metricshub.ipmi.core.coding.sol.SolCoder
Creates new SolCoder.
SolCoder(Set<SolOperation>) - Constructor for class org.metricshub.ipmi.core.coding.sol.SolCoder
Creates new SolCoder.
SolConsole - Class in org.metricshub.ipmi.client
A Serial over LAN console, as streams: what the system writes on its serial port is read from SolConsole.input(), what is written to SolConsole.output() reaches its serial port.
SolDeactivated - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
SOL is deactivated/deactivating.
SolEventListener - Interface in org.metricshub.ipmi.core.api.sol
Interface for Serial over LAN (SOL) events listener.
SOLException - Exception in org.metricshub.ipmi.core.api.sol
Exception representing problem that might have been encountered during Serial over LAN communication.
SOLException(String) - Constructor for exception org.metricshub.ipmi.core.api.sol.SOLException
Creates the exception.
SOLException(String, Throwable) - Constructor for exception org.metricshub.ipmi.core.api.sol.SOLException
Creates the exception with its cause.
SOLException(String, Throwable, IpmiCommandCoder<?>, ConnectionHandle) - Constructor for exception org.metricshub.ipmi.core.api.sol.SOLException
Creates the exception for a command of the console that failed.
SolInboundMessage - Class in org.metricshub.ipmi.core.coding.payload.sol
Implementation of SolMessage for BMC -> Remote Console message.
SolInboundMessage(byte[]) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolInboundMessage
 
SolInboundMessage(byte, byte, byte, SolInboundStatusField) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolInboundMessage
 
SolInboundStatusField - Class in org.metricshub.ipmi.core.coding.payload.sol
SolInboundStatusField is a transfer object for status sent by remote system to this application in SolInboundMessage.
SolInboundStatusField(byte) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolInboundStatusField
Creates new instance of SolInboundStatusField from raw byte.
SolInboundStatusField(Set<SolStatus>) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolInboundStatusField
Creates new instance if SolInboundStatusField without Acknowledge data.
SolInboundStatusField(SolAckState, Set<SolStatus>) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolInboundStatusField
Creates new instance of SolInboundStatusField filled with given data.
SolMessage - Class in org.metricshub.ipmi.core.coding.payload.sol
Implementation of IpmiPayload for SOL (Serial over LAN) messages.
SolMessageHandler - Class in org.metricshub.ipmi.core.connection
Implementation of MessageHandler for PayloadType.Sol.
SolMessageHandler(Connection, int) - Constructor for class org.metricshub.ipmi.core.connection.SolMessageHandler
 
SolOperation - Enum in org.metricshub.ipmi.core.coding.payload.sol
Enumeration of all possible operations, that Remote Console can invoke on BMC during SOL communication.
SolOutboundMessage - Class in org.metricshub.ipmi.core.coding.payload.sol
Implementation of SolMessage for Remote Console -> BMC message.
SolOutboundMessage(byte, byte, byte, SolOutboundOperationField) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolOutboundMessage
 
SolOutboundOperationField - Class in org.metricshub.ipmi.core.coding.payload.sol
SolOutboundOperationField is a transfer object for operation sent by this application to remote system in SolOutboundMessage.
SolOutboundOperationField(byte) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolOutboundOperationField
Creates new instance of SolOutboundOperationField from raw byte.
SolOutboundOperationField(SolAckState, Set<SolOperation>) - Constructor for class org.metricshub.ipmi.core.coding.payload.sol.SolOutboundOperationField
Creates new instance of SolOutboundOperationField filled with given data.
SolRequest - Class in org.metricshub.ipmi.client
Opens a Serial over LAN console (IPMI 2.0 section 15) in the session of the client or, when the BMC serves SOL on another UDP port, in a session the client opens there with the same credentials, cipher suite and privilege.
SolResponseData - Class in org.metricshub.ipmi.core.coding.sol
Impementation of ResponseData for SolMessages.
SolResponseData(byte, SolAckState, Set<SolStatus>, byte) - Constructor for class org.metricshub.ipmi.core.coding.sol.SolResponseData
Deprecated.
use SolResponseData(byte, SolAckState, Set, int), which takes the count as an int
SolResponseData(byte, SolAckState, Set<SolStatus>, int) - Constructor for class org.metricshub.ipmi.core.coding.sol.SolResponseData
Creates new instance of SolResponseData filled with given data.
SolStatus - Enum in org.metricshub.ipmi.core.coding.payload.sol
Enumeration of all possible states, that Remote Console can receive from BMC during SOL communication.
SpaceSaving - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
SpareMemoryUnit - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Indicates entity associated with the sensor represents a 'spare' unit of memory.
spd() - Method in class org.metricshub.ipmi.client.Fru
Returns the SPD data of a memory module, as the protocol core decodes it: the FRU device of a DIMM returns the JEDEC SPD data of the module (type, capacity, manufacturer, part and serial numbers) instead of a FRU inventory.
SpdInfo - Class in org.metricshub.ipmi.core.coding.commands.fru.record
The Serial Presence Detect (SPD) data of a memory module, which the FRU device of a DIMM returns instead of an IPMI FRU inventory: the module type, capacity, manufacturer, part number and serial number, decoded from the JEDEC SPD layouts of DDR3 (JEDEC Standard 21-C, annex K), DDR4 (annex L) and DDR5 (JESD400-5) modules.
SpdInfo(byte[], int) - Constructor for class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
Decodes the SPD data of a DDR3, DDR4 or DDR5 module.
SpecificCipherSuiteSelector - Class in org.metricshub.ipmi.core.api.sol
Implementation of CipherSuiteSelectionHandler that always returns cipher suite provided in the constructor.
SpecificCipherSuiteSelector(CipherSuite) - Constructor for class org.metricshub.ipmi.core.api.sol.SpecificCipherSuiteSelector
Creates a selector that always returns the given suite, whether the BMC offers it or not.
start(InetAddress, int) - Method in class org.metricshub.ipmi.core.sm.StateMachine
Sets the State Machine in the initial state.
startSession(int, CipherSuite, PrivilegeLevel, String, byte[], byte[]) - Method in class org.metricshub.ipmi.core.connection.Connection
Initiates the session with the managed system.
startSession(int, CipherSuite, PrivilegeLevel, String, byte[], byte[]) - Method in class org.metricshub.ipmi.core.connection.ConnectionManager
Initiates the session with the managed system.
StartSession - Class in org.metricshub.ipmi.core.sm.events
Acknowledges starting the session after receiving RAKP Message 4 ( StateMachine transits from Rakp3Complete to SessionValid)
StartSession(CipherSuite, int) - Constructor for class org.metricshub.ipmi.core.sm.events.StartSession
 
State - Class in org.metricshub.ipmi.core.sm.states
The abstract for state of the StateMachine.
State() - Constructor for class org.metricshub.ipmi.core.sm.states.State
 
StateAsserted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
StateDeasserted - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
StateMachine - Class in org.metricshub.ipmi.core.sm
State machine for connecting and acquiring session with the remote host via IPMI v.2.0.
StateMachine(Messenger) - Constructor for class org.metricshub.ipmi.core.sm.StateMachine
Initializes the State Machine
StateMachineAction - Class in org.metricshub.ipmi.core.sm.actions
Abstract for external action of the StateMachine
StateMachineAction() - Constructor for class org.metricshub.ipmi.core.sm.actions.StateMachineAction
 
StateMachineEvent - Class in org.metricshub.ipmi.core.sm.events
Abstract for an event of the StateMachine.
StateMachineEvent() - Constructor for class org.metricshub.ipmi.core.sm.events.StateMachineEvent
 
states() - Method in class org.metricshub.ipmi.client.Sensor
Returns the asserted states of a discrete sensor, in the wording of ipmiutil ("Device Present", "Device Absent", "Fully Redundant", "Failure detected"...; of ipmitool for the few states ipmiutil does not name), each once, and "Unknown" for a state its event/reading type does not define.
status() - Method in class org.metricshub.ipmi.client.Sensor
Returns the status of the sensor: for a threshold sensor, the worst threshold the reading is at or beyond, as the BMC reports it in its reply to Get Sensor Reading; for a discrete sensor, SensorStatus.OK when it answers.
statusCode() - Method in exception org.metricshub.ipmi.client.IpmiAuthenticationException
Returns the status code the BMC sent when it refused the login: the status code of its Open Session or RAKP reply (IPMI 2.0 table 13-15: unauthorized name, unauthorized role, invalid integrity check value...), or the completion code of the Set Session Privilege Level it refused right after the login.
Steradians - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
stop() - Method in class org.metricshub.ipmi.core.sm.StateMachine
Cleans up the machine resources and leaves the current state: a stopped machine no longer reports a valid session.
StorageRequest - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
StorageResponse - Enum constant in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
 
stream() - Method in class org.metricshub.ipmi.client.FrusRequest
Reads the selected FRUs and streams them: each FRU is yielded as soon as it is read, in the order of FrusRequest.execute(), and the next one is read only as the stream advances, so that a caller that stops early (limit(n), findFirst()) does not pay for the rest.
stream() - Method in class org.metricshub.ipmi.client.SelRequest
Reads the entries and streams them: each entry is yielded as soon as it is read, in the order of the log, and the next one is read only as the stream advances, so that the caller processes the first entries while the last ones are being read, and a caller that stops early (limit(n), findFirst()) does not pay for the rest.
stream() - Method in class org.metricshub.ipmi.client.SensorsRequest
Reads the selected sensors and streams them: each sensor is yielded as soon as it is read, in the order of SensorsRequest.execute(), and the next one is read only as the stream advances, so that a caller that stops early (limit(n), findFirst()) does not pay for the rest.
SubChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
SubChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SubNotebook - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
SuccessfulHardwareChangeDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SuccessfulSoftwareOrFWChangeDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
System - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
A system event record (02h, IPMI 2.0 section 32.1).
SystemAcpiPowerState - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
SystemBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Main system board, may also be a processor board and/or internal expansion board.
SystemBoot - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
SystemBus - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SystemChassis - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SystemEvent - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
SystemFirmware - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SystemFirmwareError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SystemFirmwareHang - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SystemFirmwareProgess - Static variable in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
Deprecated.
use SensorType.SystemFirmwareProgress; this alias will be removed in 3.0.
SystemFirmwareProgress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SystemFirmwareProgress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
SystemInternalExpansionBoard - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SystemManagementModule - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SystemManagementSoftware - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
SystemManagementUrl - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
 
SystemName - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
 
SystemPingAddress - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
 
SystemReconfigured - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SystemRestart - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
SystemSoftwareId - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.AddressType
System Software ID

T

tearDown() - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Finalizes the connector, closes all connections, and wipes the credentials of their sessions.
tearDown() - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Finalizes the connector and closes all connections, without closing their sessions: the requests still waiting for a reply fail, with a ConnectionException or an IllegalStateException.
tearDown() - Method in class org.metricshub.ipmi.core.connection.MessageHandler
 
tearDown() - Method in class org.metricshub.ipmi.core.connection.queue.MessageQueue
Stops the MessageQueue: the requests still waiting for a reply are reported as failed, since the timer that would report their timeout stops.
Temperature - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Temperature - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
TemporaryOn - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
 
Terminator - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Terminator - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
TerminatorPresenceDetected - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
timeout(Duration) - Method in class org.metricshub.ipmi.client.FrusRequest
Overrides the deadline of the client for this request.
timeout(Duration) - Method in class org.metricshub.ipmi.client.IpmiClient.Builder
Sets the overall deadline of each operation, session setup included; 2 minutes by default.
timeout(Duration) - Method in class org.metricshub.ipmi.client.RawRequest
Overrides the deadline of the client for this request.
timeout(Duration) - Method in class org.metricshub.ipmi.client.SelRequest
Overrides the deadline of the client for this request.
timeout(Duration) - Method in class org.metricshub.ipmi.client.SensorsRequest
Overrides the deadline of the client for this request.
timeout(Duration) - Method in class org.metricshub.ipmi.client.SolRequest
Overrides the deadline of the client for the activation of the console.
Timeout - Class in org.metricshub.ipmi.core.sm.events
StateMachineEvent indicating that response for one of the messages in the process of the session challenge did not arrive in time.
Timeout - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Timeout while processing command.
Timeout() - Constructor for class org.metricshub.ipmi.core.sm.events.Timeout
 
TIMEOUT - Static variable in class org.metricshub.ipmi.core.common.Constants
Deprecated.
nothing reads it; it will be removed in the next major version.
TimerExpired - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TimerHardReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TimerInterrupt - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TimerPowerCycle - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TimerPowerDown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
timestamp() - Method in class org.metricshub.ipmi.client.SelEntry
Returns when the event was logged, for a system event or a timestamped OEM entry whose timestamp is a date: empty for an entry without timestamp, an unspecified timestamp (FFFFFFFFh), and an event logged before the BMC had the time (SelEntry.preInitSeconds()).
TimestampClockSynch - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
This event can be used to record when changes are made to the timestamp clock(s) so that relative time differences between SEL entries can be determined.
toString() - Method in class org.metricshub.ipmi.client.BmcCapabilities
 
toString() - Method in class org.metricshub.ipmi.client.ChassisStatus
 
toString() - Method in class org.metricshub.ipmi.client.DeviceId
 
toString() - Method in class org.metricshub.ipmi.client.Fru
 
toString() - Method in class org.metricshub.ipmi.client.FruList
 
toString() - Method in class org.metricshub.ipmi.client.RawResponse
 
toString() - Method in class org.metricshub.ipmi.client.SelEntry
 
toString() - Method in class org.metricshub.ipmi.client.SelEntryList
 
toString() - Method in class org.metricshub.ipmi.client.Sensor
 
toString() - Method in class org.metricshub.ipmi.client.SensorList
 
toString() - Method in class org.metricshub.ipmi.client.SkippedRecord
 
toString() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Returns the index, address and port of the connection, and the cipher suite, privilege level and user name of its session, without the password or the BMC key.
toString() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.PiromInfo
 
toString() - Method in class org.metricshub.ipmi.core.coding.commands.fru.record.SpdInfo
 
toString() - Method in class org.metricshub.ipmi.core.coding.commands.payload.GetPayloadActivationStatusResponseData
 
toString() - Method in class org.metricshub.ipmi.core.coding.commands.session.GetSessionInfoResponseData
 
toString() - Method in class org.metricshub.ipmi.core.coding.sol.SolResponseData
 
totalEntries() - Method in class org.metricshub.ipmi.client.SelEntryList
Returns how many entries the whole log holds, which is more than SelEntryList.size() after SelRequest.since(int).
Tower - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
TransitionToActive - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToBusy - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToCriticalFromLessSevere - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToCriticalFromNonRecoverable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToDegraded - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToIdle - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToInTest - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToNonCriticalFromMoreSevere - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToNonCriticalFromOK - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToNonRecoverable - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToNonRecoverableFromLessSevere - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToOffDuty - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToOffLine - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToOK - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToOnLine - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToPowerOff - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToPowerSave - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransitionToRunning - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
TransmitOverrun - Enum constant in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
Characters were dropped between transmitting this packet and the previous packet, because the system did not pay attention to hardware flow control.
type() - Method in class org.metricshub.ipmi.client.SelEntry
Returns the record type: a system event, an OEM entry with or without timestamp, or a reserved type.
type() - Method in class org.metricshub.ipmi.client.Sensor
Returns what the sensor measures or monitors.
typeCode() - Method in class org.metricshub.ipmi.client.Sensor
Returns the sensor type code of the record (IPMI 2.0 table 42-3), which Sensor.type() does not keep for an OEM sensor type (SensorType.Oem, C0h to FFh) or a reserved one (SensorType.Reserved).
TypeConverter - Class in org.metricshub.ipmi.core.common
Tool class for converting types.
types(SensorType...) - Method in class org.metricshub.ipmi.client.SensorsRequest
Reads only the sensors of the given types; without argument, it reads none.

U

UdpListener - Interface in org.metricshub.ipmi.core.transport
An interface for UdpMessenger listener.
UdpMessage - Class in org.metricshub.ipmi.core.transport
Container for UDP message.
UdpMessage() - Constructor for class org.metricshub.ipmi.core.transport.UdpMessage
 
UdpMessenger - Class in org.metricshub.ipmi.core.transport
Handles the UDP connection.
UdpMessenger(int) - Constructor for class org.metricshub.ipmi.core.transport.UdpMessenger
Initiates UdpMessenger, binds it to the specified port and starts listening.
UdpMessenger(int, InetAddress) - Constructor for class org.metricshub.ipmi.core.transport.UdpMessenger
Initiates UdpMessenger, binds it to the specified port and IP address and starts listening.
UnauthorizedDock - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
UnauthorizedGuid - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
GUID that BMC submitted in RAKP Message 2 was not accepted by remote console.
UnauthorizedName - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Unauthorized name.
UnauthorizedRole - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Unauthorized role or privilege level requested.
UNAVAILABLE - Enum constant in enum org.metricshub.ipmi.client.SensorStatus
The sensor has no reading and no states: the BMC or the controller that owns the sensor refused the reading or sent a malformed reply, that controller did not answer through the BMC, the sensor belongs to system software, or the sensor is not scanned or its reading is not valid yet (Sensor.problem() says which).
UncorrectableCpuComplexError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
UncorrectableECC - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Uncorrectable ECC / other uncorrectable memory error
UncorrectableError - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Underrun - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
UndeterminedSystemHardwareFailure - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Uninitialized - Class in org.metricshub.ipmi.core.sm.states
The initial state.
Uninitialized() - Constructor for class org.metricshub.ipmi.core.sm.states.Uninitialized
 
unit() - Method in class org.metricshub.ipmi.client.Sensor
Returns the unit of the reading and of the thresholds.
Unknown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
The BMC reports the reserved value 11b.
Unknown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerRestorePolicy
The BMC reports the policy as unknown (11b).
Unknown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
 
Unknown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Unknown - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Unknown - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
A code this enumeration does not list: OEM, command-specific or reserved.
UnknownOEMEvent - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
unregister(UdpListener) - Method in interface org.metricshub.ipmi.core.transport.Messenger
Unregisters listener from Messenger so it no longer will be notified.
unregister(UdpListener) - Method in class org.metricshub.ipmi.core.transport.UdpMessenger
Unregisters listener from UdpMessenger so it no longer will be notified.
unregisterEventListener(SolEventListener) - Method in class org.metricshub.ipmi.client.SolConsole
Unregisters a listener.
unregisterEventListener(SolEventListener) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Unregister given SolEventListener, preventing it from receiving SOL events from remote server.
unregisterIncomingMessageListener(InboundMessageListener) - Method in class org.metricshub.ipmi.core.api.sync.IpmiConnector
Unregisters an InboundMessageListener, which then no longer receives the requests of the remote systems.
unregisterIncomingPayloadListener(InboundMessageListener) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Unregisters the listener so it will no longer receive notifications of received messages.
unregisterListener(IpmiResponseListener) - Method in class org.metricshub.ipmi.core.api.async.IpmiAsyncConnector
Unregisters the listener so it will no longer receive notifications of received answers.
unregisterListener(ConnectionListener) - Method in class org.metricshub.ipmi.core.connection.Connection
Unregisters the ConnectionListener
unregisterSession(ConnectionHandle) - Method in class org.metricshub.ipmi.core.connection.SessionManager
Unregisters session for given connection handle, and wipes the credentials of the handle it was registered with.
Unspecified - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
 
Unspecified - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
 
Unspecified - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
 
Unspecified - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
 
Unspecified - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
UNSPECIFIED - Static variable in class org.metricshub.ipmi.core.coding.commands.sel.GetSelTimeUtcOffsetResponseData
07FFh: the offset is unspecified (IPMI 2.0 revision 1.1 section 31.11a), as after a Set SEL Time.
UnspecifiedError - Enum constant in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Unspecified error.
upperCritical() - Method in class org.metricshub.ipmi.client.Sensor
Returns the upper critical threshold, in the Sensor.unit() of the sensor.
UpperCriticalGoingHigh - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
UpperCriticalGoingLow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
upperNonCritical() - Method in class org.metricshub.ipmi.client.Sensor
Returns the upper non-critical threshold, in the Sensor.unit() of the sensor.
UpperNonCriticalGoingHigh - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
UpperNonCriticalGoingLow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
upperNonRecoverable() - Method in class org.metricshub.ipmi.client.Sensor
Returns the upper non-recoverable threshold, in the Sensor.unit() of the sensor.
UpperNonRecoverableGoingHigh - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
UpperNonRecoverableGoingLow - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
User - Enum constant in enum org.metricshub.ipmi.core.coding.commands.PrivilegeLevel
The level every session but a Callback one starts at (IPMI 2.0 section 22.18): the commands that read the BMC, such as the chassis status, the sensors, the FRUs and the SEL.
userLevelAuthentication() - Method in class org.metricshub.ipmi.client.BmcCapabilities
Tells whether the BMC authenticates the commands of the User privilege level.
utcOffsetMinutes() - Method in class org.metricshub.ipmi.client.SelEntryList
Returns the offset from UTC of the SEL time, which a BMC that keeps its SEL time as local time reports with Get SEL Time UTC Offset (IPMI 2.0 revision 1.1): already applied to every timestamp of the list and its entries.

V

V15 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.IpmiVersion
IPMI v1.5
V20 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.IpmiVersion
IPMI v2.0
Va - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
valueOf(String) - Static method in enum org.metricshub.ipmi.client.DeviceFunction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.client.PowerEvent
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.client.SensorStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerRestorePolicy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.BaseUnit
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.IpmiVersion
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadCompletionCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.PrivilegeLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.AddressType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.InstanceModifierType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ModifierUnitUsage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sel.EventDirection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.payload.sol.SolAckState
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.metricshub.ipmi.core.coding.rmcp.RmcpVersion
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.metricshub.ipmi.client.DeviceFunction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.client.PowerEvent
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.client.SensorStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentifyState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerCommand
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.chassis.PowerRestorePolicy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.BaseUnit
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ChassisType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.FruMultiRecordType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.fru.record.ManagementAccessRecordType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.IpmiVersion
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.payload.DeactivatePayloadCompletionCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.PrivilegeLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.AddressType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.DeviceType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.EntityId
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.InstanceModifierType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ModifierUnitUsage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.RateUnit
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sdr.SensorState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sel.EventDirection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.commands.sel.SelRecordType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.payload.CompletionCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.payload.lan.NetworkFunction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.payload.sol.SolAckState
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.payload.sol.SolOperation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.payload.sol.SolStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.protocol.AuthenticationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.protocol.PayloadType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.rmcp.RmcpClassOfMessage
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.metricshub.ipmi.core.coding.rmcp.RmcpVersion
Returns an array containing the constants of this enum type, in the order they are declared.
VersionChange - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Voltage - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
Voltage - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Volts - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 

W

waitForAnswer(int) - Method in class org.metricshub.ipmi.core.api.sync.MessageListener
Blocks the invoking thread until deserved message arrives (tag and handle as specified in MessageListener(ConnectionHandle)).
WarmReset - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.ReadingType
 
wasInterlock() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the last power down was caused by a power interlock being activated (byte 3 bit 2).
wasIpmiPowerOn() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the last 'Power is on' state was entered with an IPMI command (byte 3 bit 4).
wasPowerFault() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the last power down was caused by a power fault (byte 3 bit 3).
wasPowerOverload() - Method in class org.metricshub.ipmi.core.coding.commands.chassis.GetChassisStatusResponseData
Tells whether the last power down was caused by a power overload (byte 3 bit 1).
Watchdog1 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Watchdog2 - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorType
 
Watts - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Week - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
wipeCredentials() - Method in class org.metricshub.ipmi.core.api.async.ConnectionHandle
Wipes the password and the BMC key (Kg) of the session, and the password that MD5-128 integrity keeps, once the connection is closed.
wipeCredentials() - Method in class org.metricshub.ipmi.core.connection.SessionManager
Wipes the credentials of the connections of all the registered sessions, when their connector tears down without closing each connection.
wipeKey() - Method in class org.metricshub.ipmi.core.coding.security.IntegrityAlgorithm
Wipes the key passed to IntegrityAlgorithm.initialize(byte[]) (the password for MD5-128 integrity) once the session is over, and keys the MAC with the wiped key: the codes the algorithm generates no longer match the session.
wipeKeys() - Method in class org.metricshub.ipmi.core.coding.security.CipherSuite
Wipes the key of the integrity algorithm of the suite, if it was keyed (the password for MD5-128 integrity), once the session is over.
Word - Enum constant in enum org.metricshub.ipmi.core.coding.commands.sdr.record.SensorUnit
 
Words - Enum constant in enum org.metricshub.ipmi.core.coding.commands.fru.BaseUnit
The device is accessed by 16-bit words: Read FRU Data takes its offset in words.
wordToInt(byte[]) - Static method in class org.metricshub.ipmi.core.common.TypeConverter
Converts BigEndian word (double bytes array) to int.
write(byte[]) - Method in class org.metricshub.ipmi.core.common.ByteBuffer
Attempts to write given byte array to this ByteBuffer.
writeByte(byte) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Writes single byte to the port.
writeBytes(byte[]) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Writes bytes array to the port, in packets of the size the BMC accepts.
writeInt(int) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Writes single integer (in range from 0 to 255) to the port.
writeIntArray(int[]) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Writes integers (in range from 0 to 255) array to the port.
writeString(String) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Writes String to port, using platform's default Charset when converting String to byte array.
writeString(String, Charset) - Method in class org.metricshub.ipmi.core.api.sol.SerialOverLan
Writes String to port, using given Charset when converting String to byte array.
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form