constants

Documentation

Index

• Constants
• func ListSupportedVendors() []string
• type FirmwareInstallStep
• type OperationApplyTime
• type TaskState

Constants

const (
	// EnvEnableDebug is the const for the environment variable to cause bmclib to dump debugging debugging information.
	// the valid parameter for this environment variable is 'true'
	EnvEnableDebug = "DEBUG_BMCLIB"

	// HP is the constant that defines the vendor HP
	HP = "HP"
	// Dell is the constant that defines the vendor Dell
	Dell = "Dell"
	// Supermicro is the constant that defines the vendor Supermicro
	Supermicro = "Supermicro"
	// Cloudline is the constant that defines the cloudlines
	Cloudline = "Cloudline"
	// Quanta is the contant to identify Quanta hardware
	Quanta = "Quanta"
	// Quanta is the contant to identify Intel hardware
	Intel = "Intel"

	// Redfish firmware apply at constants
	// FirmwareApplyImmediate sets the firmware to be installed immediately after upload
	Immediate OperationApplyTime = "Immediate"
	//FirmwareApplyOnReset sets the firmware to be install on device power cycle/reset
	OnReset OperationApplyTime = "OnReset"
	// FirmwareOnStartUpdateRequest sets the firmware install to begin after the start request has been sent.
	OnStartUpdateRequest OperationApplyTime = "OnStartUpdateRequest"

	// 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
	FirmwareInstallInitializing           = "initializing"
	Initializing                TaskState = "initializing"

	// 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
	FirmwareInstallQueued           = "queued"
	Queued                TaskState = "queued"

	// 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
	FirmwareInstallRunning           = "running"
	Running                TaskState = "running"

	// FirmwareInstallComplete indicates the device completed the firmware install
	// this covers the redfish state - 'complete'
	FirmwareInstallComplete           = "complete"
	Complete                TaskState = "complete"

	// FirmwareInstallFailed indicates the firmware install failed
	// this covers the redfish states - 'interrupted', 'killed', 'exception', 'cancelled', 'suspended'
	FirmwareInstallFailed           = "failed"
	Failed                TaskState = "failed"

	// FirmwareInstallPowerCycleHost indicates the firmware install requires a host power cycle
	FirmwareInstallPowerCycleHost           = "powercycle-host"
	PowerCycleHost                TaskState = "powercycle-host"

	FirmwareInstallUnknown           = "unknown"
	Unknown                TaskState = "unknown"

	// FirmwareInstallStepUploadInitiateInstall identifies the step to upload _and_ initialize the firmware install.
	// as part of the same call.
	FirmwareInstallStepUploadInitiateInstall FirmwareInstallStep = "upload-initiate-install"

	// FirmwareInstallStepInstallStatus identifies the step to verify the status of the firmware install.
	FirmwareInstallStepInstallStatus FirmwareInstallStep = "install-status"

	// FirmwareInstallStepUpload identifies the upload step in the firmware install process.
	FirmwareInstallStepUpload FirmwareInstallStep = "upload"

	// FirmwareInstallStepUploadStatus identifies the step to verify the upload status as part of the firmware install status.
	FirmwareInstallStepUploadStatus FirmwareInstallStep = "upload-status"

	// FirmwareInstallStepInstallUploaded identifies the step to install firmware uploaded in FirmwareInstallStepUpload.
	FirmwareInstallStepInstallUploaded FirmwareInstallStep = "install-uploaded"

	// FirmwareInstallStepPowerOffHost indicates the host requires to be powered off.
	FirmwareInstallStepPowerOffHost FirmwareInstallStep = "power-off-host"

	// FirmwareInstallStepResetBMCPostInstall indicates the BMC requires a reset after the install.
	FirmwareInstallStepResetBMCPostInstall FirmwareInstallStep = "reset-bmc-post-install"

	// FirmwareInstallStepResetBMCOnInstallFailure indicates the BMC requires a reset if an install fails.
	FirmwareInstallStepResetBMCOnInstallFailure FirmwareInstallStep = "reset-bmc-on-install-failure"

	// device BIOS/UEFI POST code bmclib identifiers
	POSTStateBootINIT = "boot-init/pxe"
	POSTStateUEFI     = "uefi"
	POSTStateOS       = "grub/os"
	POSTCodeUnknown   = "unknown"
)

Functions

func ListSupportedVendors

func ListSupportedVendors() []string

ListSupportedVendors returns a list of supported vendors

Types

type FirmwareInstallStep

type FirmwareInstallStep string

The FirmwareInstallStep identifies each phase of a firmware install process.

type OperationApplyTime

type OperationApplyTime string

Redfish operation apply time parameter

type TaskState

type TaskState string