dmi_mgmt_nhi_char

Synopsis

#include <opendmi/entity/mgmt-controller.h>

typedef enum dmi_mgmt_nhi_char {
    DMI_MGMT_NHI_CHAR_CREDENTIAL_BOOTSTRAPPING = 0
} dmi_mgmt_nhi_char_t;

const char *dmi_mgmt_nhi_char_name(dmi_mgmt_nhi_char_t value);

Description

The dmi_mgmt_nhi_char_t enumeration numbers the bits of the characteristics field of dmi_mgmt_nhi_usb_v2_t and dmi_mgmt_nhi_pci_v2_t, which tell the characteristics of the device through which the host reaches the management controller. The bits the enumeration does not name are reserved.

A characteristic is present if the bit it numbers is set, e.g. (characteristics & (1u << DMI_MGMT_NHI_CHAR_CREDENTIAL_BOOTSTRAPPING)) != 0.

The dmi_mgmt_nhi_char_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_MGMT_NHI_CHAR_CREDENTIAL_BOOTSTRAPPING

Credential bootstrapping via IPMI commands is supported; the credential_bootstrapping_handle field of the descriptor names the interface to use for it.

Return value

dmi_mgmt_nhi_char_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 Redfish Host Interface Specification (DSP0270), version 1.3 or newer.