dmi_firmware_inventory_state

Synopsis

#include <opendmi/entity/firmware-inventory.h>

typedef enum dmi_firmware_inventory_state {
    DMI_FIRMWARE_INVENTORY_STATE_UNSPEC          = 0x00,
    DMI_FIRMWARE_INVENTORY_STATE_OTHER           = 0x01,
    DMI_FIRMWARE_INVENTORY_STATE_UNKNOWN         = 0x02,
    DMI_FIRMWARE_INVENTORY_STATE_DISABLED        = 0x03,
    DMI_FIRMWARE_INVENTORY_STATE_ENABLED         = 0x04,
    DMI_FIRMWARE_INVENTORY_STATE_ABSENT          = 0x05,
    DMI_FIRMWARE_INVENTORY_STATE_STANDBY_OFFLINE = 0x06,
    DMI_FIRMWARE_INVENTORY_STATE_STANDBY_SPARE   = 0x07,
    DMI_FIRMWARE_INVENTORY_STATE_UNAVAIL_OFFLINE = 0x08,
} dmi_firmware_inventory_state_t;

const char *dmi_firmware_inventory_state_name(
        dmi_firmware_inventory_state_t value);

Description

The dmi_firmware_inventory_state_t enumeration tells the state of a firmware component, and is the type of the state field of dmi_firmware_inventory_t. The values follow the Status.State property of Redfish.

The dmi_firmware_inventory_state_name function returns the printable name of a value, as the command line tool shows it. The name is translated to the locale set with dmi_set_locale, when the library is built with ICU4C support and has a translation of it.

Values

DMI_FIRMWARE_INVENTORY_STATE_UNSPEC

Unspecified.

DMI_FIRMWARE_INVENTORY_STATE_OTHER

Other state.

DMI_FIRMWARE_INVENTORY_STATE_UNKNOWN

Unknown state.

DMI_FIRMWARE_INVENTORY_STATE_DISABLED

The firmware component is disabled.

DMI_FIRMWARE_INVENTORY_STATE_ENABLED

The firmware component is enabled.

DMI_FIRMWARE_INVENTORY_STATE_ABSENT

The firmware component is not present, or has not been detected.

DMI_FIRMWARE_INVENTORY_STATE_STANDBY_OFFLINE

The firmware is enabled, and waits for an external action to become active.

DMI_FIRMWARE_INVENTORY_STATE_STANDBY_SPARE

The firmware belongs to a redundancy set, and waits for a failover or another external action to become active.

DMI_FIRMWARE_INVENTORY_STATE_UNAVAIL_OFFLINE

The firmware component is present, but cannot be used.

Return value

dmi_firmware_inventory_state_name returns the name of the value, or nullptr if the value has no name. The name is a static string, which must not be modified or freed.

Errors

None.

Standards

DMTF SMBIOS Specification (DSP0134), version 3.5 or newer.