model

package
v0.5.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrTypeComponentFirmware = errors.New("ironlib.GetComponentFirmware() was passed an object type which is not handled")
)

Functions

func DriveTypeSlug

func DriveTypeSlug(m string) string

func FormatProductName

func FormatProductName(s string) string

Return a normalized product name given a product name

Types

type CollectorUtility

type CollectorUtility string

CollectorUtility is the name of a utility defined in utils/

type Component

type Component struct {
	Serial            string            `json:"serial"`
	Vendor            string            `json:"vendor"`
	Type              string            `json:"type"`
	Model             string            `json:"model"`
	Name              string            `json:"name"`
	Slug              string            `json:"slug"`
	FirmwareInstalled string            `json:"firmware_installed"` // The firmware revision installed
	FirmwareAvailable string            `json:"firmware_available"` // The firmware revision available
	Metadata          map[string]string `json:"metadata"`           // Additional metadata if any
	Oem               bool              `json:"oem"`                // Component is an OEM component
	FirmwareManaged   bool              `json:"firmware_managed"`   // Firmware on the component is managed/unmanaged
}

Component is a low level device component - before its classified into a device type (BMC{}, BIOS{}, NIC{})

type CreateVirtualDiskOptions

type CreateVirtualDiskOptions struct {
	RaidMode        string
	PhysicalDiskIDs []uint
	Name            string
	BlockSize       uint
}

type DestroyVirtualDiskOptions

type DestroyVirtualDiskOptions struct {
	VirtualDiskID int
}

type Hardware

type Hardware struct {
	PendingReboot    bool // set when the device requires a reboot after running an upgrade
	UpdatesInstalled bool // set when updates were installed on the device
	UpdatesAvailable int  // -1 == no update lookup as yet,  0 == no updates available, 1 == updates available
	Device           *common.Device
	OEMComponents    []*Component // OEMComponents hold OEM specific components that may not show up in dmidecode/lshw and other collectors.
}

Hardware is a base struct that various providers inherit

func NewHardware

func NewHardware(d *common.Device) *Hardware

NewHardware returns the base Hardware struct that various providers inherit

type UpdateOptions

type UpdateOptions struct {
	ForceInstall      bool // Allow firmware to be downgraded
	InstallAll        bool // Install all available updates (vendor tooling like DSU fetches the updates and installs them)
	DownloadOnly      bool // Only download updates, skip install - Works with InstallAll (where updates are fetched by the vendor tooling)
	Serial            string
	Vendor            string
	Model             string
	Name              string
	Slug              string
	UpdateFile        string // Location of the UpdateFile to be installed
	InstallerVersion  string // The all available updates installer version (specific to dell DSU)
	RepositoryVersion string // The update repository version to activate when defined
	BaseURL           string // The BaseURL for the updates
}

UpdateOptions sets firmware update options for a device component

type UpdateRequirements

type UpdateRequirements struct {
	PostInstallReconfiguration bool // The component requires a re-configuration post firmware install
	PostInstallHostPowercycle  bool // The component requires a host power-cycle post firmware install
}

UpdateRequirements are returned by utilities to help the caller identify actions (if any) required before or after a firmware install.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL