Package org.metricshub.ipmi.core.coding.commands.app

Class GetDeviceId

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder<GetDeviceIdResponseData>

org.metricshub.ipmi.core.coding.commands.app.GetDeviceId

public class GetDeviceId
extends IpmiCommandCoder<GetDeviceIdResponseData>

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. It has no request data; the reply is a GetDeviceIdResponseData.

Constructor Summary

Constructors

Constructor	Description
GetDeviceId()	Initiates GetDeviceId for encoding and decoding.

Method Summary

Modifier and Type	Method	Description
byte	getCommandCode()	Retrieves command code specific for command represented by this class
NetworkFunction	getNetworkFunction()	Retrieves network function specific for command represented by this class.
GetDeviceIdResponseData	getResponseData(IpmiMessage message)	Retrieves payload-specific response data from IPMI message

Methods inherited from class org.metricshub.ipmi.core.coding.commands.IpmiCommandCoder

getNetworkFunctionCode, getSupportedPayloadType, isCommandResponse

Methods inherited from class org.metricshub.ipmi.core.coding.PayloadCoder

encodePayload, getAuthenticationType, getCipherSuite, getIpmiVersion, setAuthenticationType, setCipherSuite, setIpmiVersion, setSessionParameters

Methods inherited from class java.lang.Object

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

Constructor Details

GetDeviceId

public GetDeviceId()

Initiates GetDeviceId for encoding and decoding.

Method Details

getCommandCode

public byte getCommandCode()

Description copied from class: IpmiCommandCoder

Retrieves command code specific for command represented by this class

Specified by:

getCommandCode in class IpmiCommandCoder<GetDeviceIdResponseData>

Returns:

command code

getNetworkFunction

public NetworkFunction getNetworkFunction()

Description copied from class: IpmiCommandCoder

Retrieves network function specific for command represented by this class.

Specified by:

getNetworkFunction in class IpmiCommandCoder<GetDeviceIdResponseData>

Returns:

network function, or null for a command of a network function NetworkFunction does not list, which overrides IpmiCommandCoder.getNetworkFunctionCode() instead

See Also:

• NetworkFunction

getResponseData

public GetDeviceIdResponseData getResponseData(IpmiMessage message)
                                        throws IPMIException

Description copied from class: PayloadCoder

Retrieves payload-specific response data from IPMI message

Specified by:

getResponseData in class IpmiCommandCoder<GetDeviceIdResponseData>

Parameters:

message - - IPMI message

Returns:

response data

Throws:

IPMIException - when response completion code isn't OK.