package
0.5.7
Repository: https://github.com/bmc-toolbox/bmclib.git
Documentation: pkg.go.dev

# Functions

ListSupportedVendors returns a list of supported vendors.
NewDevice returns a pointer to an initialized Device type.
NewFirmwareObj returns a *Firmware object.
VendorFromProductName attempts to identify the vendor from the given productname.

# Constants

BladeHwType is the constant defining the blade hw type.
ChassisHwType is the constant defining the chassis hw type.
Cloudline is the constant that defines the cloudlines.
Common is the constant of thinks we could use across multiple vendors.
Dell is the constant that defines the vendor Dell.
DiscreteHwType is the constant defining the Discrete hw type.
Redfish firmware apply at constants FirmwareApplyImmediate sets the firmware to be installed immediately after upload.
FirmwareApplyOnReset sets the firmware to be install on device power cycle/reset.
FirmwareInstallComplete indicates the device completed the firmware install this covers the redfish state - 'complete'.
FirmwareInstallFailed indicates the firmware install failed this covers the redfish states - 'interrupted', 'killed', 'exception', 'cancelled', 'suspended'.
FirmwareInstallInitializing indicates the device is performing init actions to install the update this covers the redfish states - 'starting', 'downloading' no action is required from the callers part in this state.
FirmwareInstallPowerCycleBMC indicates the firmware install requires a BMC power cycle.
FirmwareInstallPowerCycleHost indicates the firmware install requires a host power cycle.
FirmwareInstallQueued indicates the device has queued the update, but has not started the update task yet this covers the redfish states - 'pending', 'new' no action is required from the callers part in this state.
FirmwareInstallRunner indicates the device is installing the update this covers the redfish states - 'running', 'stopping', 'cancelling' no action is required from the callers part in this state.
No description provided by the author
Grid describes the power redundancy mode when using grid redundancy.
HP is the constant that defines the vendor HP.
Quanta is the contant to identify Intel hardware.
NoRedundancy describes the power redundancy mode we don't have redundancy.
No description provided by the author
device BIOS/UEFI POST code bmclib identifiers.
No description provided by the author
No description provided by the author
PowerSupply describes the power redundancy mode when using power supply redundancy.
Quanta is the contant to identify Quanta hardware.
Generic component slugs Slugs are set on Device types to identify the type of component.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Supermicro is the constant that defines the vendor Supermicro.
Unknown is the constant that defines unknown things.

# Structs

BIOS component.
Blade contains all the blade information we will expose across different vendors.
BMC component.
Chassis contains all the chassis the information we will expose across different vendors.
CPLD component.
CPU component.
Device type is composed of various components.
Discrete contains all the blade information we will expose across different vendors.
Disk represents a disk device.
Drive component.
Enclosure component.
Fan represents que current status a fan.
Firmware struct holds firmware attributes of a device component.
GPU component.
Mainboard component.
Memory component.
Nic represents a network interface devices.
NIC component.
Psu represents a power supply device.
PSU component.
Status is the health status of a component.
StorageBlade contains all the storage blade information we will expose across different vendors.
StorageController component.
TPM component.

# Interfaces

Bmc represents all the required bmc items.
BmcCollection represents the requirement of items to be collected a server.
Cmc represents all the required cmc items.
CmcCollection represents the requirement of items to be collected from a chassis.
CmcSetup interface declares methods that are used to apply one time configuration to a Chassis.
Configure interface declares methods implemented to apply configuration to BMCs.