api

type BIOS struct {
	Version string
	Vendor  string
	Date    string
}

type BMC struct {
	IP                  string
	MAC                 string
	ChassisPartNumber   string
	ChassisPartSerial   string
	BoardMfg            string
	BoardMfgSerial      string
	BoardPartNumber     string
	ProductManufacturer string
	ProductPartNumber   string
	ProductSerial       string
	FirmwareRevision    string `ipmitool:"Firmware Revision"`
}

type BMCConnection interface {
	// BMC returns the actual BMC details
	BMC() (*BMC, error)
	// PresentSuperUser returns the details of the already present bmc superuser
	PresentSuperUser() BMCUser
	// NeedsPasswordChange checks if a password change is required
	NeedsPasswordChange(user BMCUser, password string) (bool, error)
	// SuperUser returns the details of the preset metal bmc superuser
	SuperUser() BMCUser
	// User returns the details of the preset metal bmc user
	User() BMCUser
	// Present returns true if the InBand Connection found a usable BMC device
	Present() bool
	// Creates the given BMC user and returns generated password
	CreateUserAndPassword(user BMCUser, privilege IpmiPrivilege) (string, error)
	// Creates the given BMC user with the given password
	CreateUser(user BMCUser, privilege IpmiPrivilege, password string) error
	// Changes the password of the given BMC user
	ChangePassword(user BMCUser, newPassword string) error
	// Enables/Disables the given BMC user
	SetUserEnabled(user BMCUser, enabled bool) error
}

type BMCUser struct {
	Name          string
	Id            string
	ChannelNumber int
}

type Board struct {
	VM            bool
	VendorString  string
	Vendor        Vendor
	Model         string
	PartNumber    string
	SerialNumber  string
	BiosVersion   string
	BMC           *BMC
	BIOS          *BIOS
	Firmware      kernel.FirmwareMode
	IndicatorLED  string
	PowerMetric   *PowerMetric
	PowerSupplies []PowerSupply
}

type IpmiPrivilege = uint8

type OutBandBMCConnection interface {
	// BMC returns the actual BMC details
	BMC() (*BMC, error)
}

type PasswordConstraints struct {
	Length      int
	NumDigits   int
	NumSymbols  int
	NoUpper     bool
	AllowRepeat bool
}

type PowerMetric struct {
	// AverageConsumedWatts shall represent the
	// average power level that occurred averaged over the last IntervalInMin
	// minutes.
	AverageConsumedWatts float32
	// IntervalInMin shall represent the time
	// interval (or window), in minutes, in which the PowerMetrics properties
	// are measured over.
	// Should be an integer, but some Dell implementations return as a float.
	IntervalInMin float32
	// MaxConsumedWatts shall represent the
	// maximum power level in watts that occurred within the last
	// IntervalInMin minutes.
	MaxConsumedWatts float32
	// MinConsumedWatts shall represent the
	// minimum power level in watts that occurred within the last
	// IntervalInMin minutes.
	MinConsumedWatts float32
}

type PowerSupply struct {
	// Status shall contain any status or health properties
	// of the resource.
	Status Status
}

type Status struct {
	Health string
	State  string
}

type Vendor int