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

Enum PowerCommand

java.lang.Object

java.lang.Enum<PowerCommand>

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

All Implemented Interfaces:

Serializable, Comparable<PowerCommand>

public enum PowerCommand
extends Enum<PowerCommand>

Specifies types of commands that can be sent to BMC via ChassisControl command.

Enum Constant Summary

Enum Constants

Enum Constant	Description
HardReset	Hard reset.
PowerDown	Force system into soft off (S4/S45) state.
PowerUp

Method Summary

Modifier and Type	Method	Description
int	getCode()
static PowerCommand	parseInt(int value)
static PowerCommand	valueOf(String name)	Returns the enum constant of this type with the specified name.
static PowerCommand[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

PowerDown

public static final PowerCommand PowerDown

Force system into soft off (S4/S45) state. This is for 'emergency' management power down actions. The command does not initiate a clean shut-down of the operating system prior to powering down the system.

PowerUp

public static final PowerCommand PowerUp

HardReset

public static final PowerCommand HardReset

Hard reset. In some implementations, the BMC may not know whether a reset will cause any particular effect and will pulse the system reset signal regardless of power state. If the implementation can tell that no action will occur if a reset is delivered in a given power state, then it is recommended (but still optional) that a D5h 'Request parameter(s) not supported in present state.' error completion code be returned.

Method Details

values

public static PowerCommand[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PowerCommand valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getCode

public int getCode()

parseInt

public static PowerCommand parseInt(int value)