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

Class ChassisIdentify

java.lang.Object

org.metricshub.ipmi.core.coding.PayloadCoder

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

org.metricshub.ipmi.core.coding.commands.chassis.ChassisIdentify

public class ChassisIdentify
extends IpmiCommandCoder<ChassisIdentifyResponseData>

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. The request carries the interval byte, and the optional force byte only when the identify is to stay on: a BMC that does not support that byte answers an error completion code to it.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_INTERVAL	The longest interval the request can carry, in seconds.

Constructor Summary

Constructors

Constructor	Description
ChassisIdentify(int interval, boolean force)	Initiates ChassisIdentify 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.
ChassisIdentifyResponseData	getResponseData(IpmiMessage message)	Retrieves payload-specific response data from IPMI message

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

answers, 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

Field Details

MAX_INTERVAL

public static final int MAX_INTERVAL

The longest interval the request can carry, in seconds.

See Also:

• Constant Field Values

Constructor Details

ChassisIdentify

public ChassisIdentify(int interval,
 boolean force)

Initiates ChassisIdentify for encoding and decoding.

Parameters:

interval - the identify interval in seconds, 1 to 255 (the BMC may stretch it by 20%); 0 turns the identify off

force - whether the identify stays on indefinitely (the interval is then ignored)

Throws:

IllegalArgumentException - when the interval is not between 0 and 255

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<ChassisIdentifyResponseData>

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<ChassisIdentifyResponseData>

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 ChassisIdentifyResponseData getResponseData(IpmiMessage message)
                                            throws IPMIException,
NoSuchAlgorithmException,
InvalidKeyException

Description copied from class: PayloadCoder

Retrieves payload-specific response data from IPMI message

Specified by:

getResponseData in class IpmiCommandCoder<ChassisIdentifyResponseData>

Parameters:

message - - IPMI message

Returns:

response data

Throws:

IPMIException - when response completion code isn't OK.

NoSuchAlgorithmException - when authentication, confidentiality or integrity algorithm fails.

InvalidKeyException - when creating of the authentication algorithm key fails