supermicro

Documentation

Index

• Constants
• type Bios
• type BiosLicense
• type Board
• type CPU
• type Chassis
• type ConfigInfo
• type Dimm
• type FruInfo
• type Generic
• type GenericInfo
• type HealthInfo
• type Hostname
• type IPMI
• type Node
• type NodeInfo
• type Platform
• type PlatformInfo
• type PowerInfo
• type PowerSupply
• type Product
• type Reader
• type UserAccounts

Constants

const (
	// VendorID represents the id of the vendor across all packages
	VendorID = "Supermicro"
)

Types

type Bios

type Bios struct {
	Date    string `xml:"REL_DATE,attr"`
	Vendor  string `xml:"VENDOR,attr"`
	Version string `xml:"VER,attr"`
}

Bios holds the bios information

type BiosLicense

type BiosLicense struct {
	Check string `xml:"CHECK,attr"`
}

BiosLicense contains the license of bmc

type Board

type Board struct {
	MfcName   string `xml:"MFC_NAME,attr"`
	PartNum   string `xml:"PART_NUM,attr"`
	ProdName  string `xml:"PROD_NAME,attr"`
	SerialNum string `xml:"SERIAL_NUM,attr"`
}

Board holds the mother board information

type CPU

type CPU struct {
	Core    string `xml:"CORE,attr"`
	Version string `xml:"VER,attr"`
}

CPU holds the cpu information

type Chassis

type Chassis struct {
	PartNum   string `xml:"PART_NUM,attr"`
	SerialNum string `xml:"SERIAL_NUM,attr"`
}

Chassis holds the chassis information

type ConfigInfo

type ConfigInfo struct {
	Hostname     *Hostname       `xml:"HOSTNAME,omitempty"`
	UserAccounts []*UserAccounts `xml:"USER,omitempty"`
}

ConfigInfo holds the bmc configuration

type Dimm

type Dimm struct {
	Size string `xml:"SIZE,attr"`
}

Dimm holds the ram information

type FruInfo

type FruInfo struct {
	Board   *Board   `xml:"BOARD,omitempty"`
	Chassis *Chassis `xml:"CHASSIS,omitempty"`
	Product *Product `xml:"PRODUCT,omitempty" json:"PRODUCT,omitempty"`
}

FruInfo holds the fru ipmi information (serial numbers and so on)

type Generic

type Generic struct {
	BiosVersion   string `xml:"BIOS_VERSION,attr"`
	BmcIP         string `xml:"BMC_IP,attr"`
	BmcMac        string `xml:"BMC_MAC,attr"`
	IpmiFwVersion string `xml:"IPMIFW_VERSION,attr"`
}

Generic holds the bmc information

type GenericInfo

type GenericInfo struct {
	Generic *Generic `xml:"GENERIC,omitempty"`
}

GenericInfo holds the bmc information

type HealthInfo

type HealthInfo struct {
	Health string `xml:"HEALTH,attr"`
}

HealthInfo holds the health information

type Hostname

type Hostname struct {
	Name string `xml:"NAME,attr"`
}

Hostname is the bmc hostname

type IPMI

type IPMI struct {
	Bios         *Bios          `xml:"BIOS,omitempty"`
	CPU          []*CPU         `xml:"CPU,omitempty"`
	ConfigInfo   *ConfigInfo    `xml:"CONFIG_INFO,omitempty"`
	Dimm         []*Dimm        `xml:"DIMM,omitempty"`
	FruInfo      *FruInfo       `xml:"FRU_INFO,omitempty"`
	GenericInfo  *GenericInfo   `xml:"GENERIC_INFO,omitempty"`
	PlatformInfo *PlatformInfo  `xml:"PLATFORM_INFO,omitempty"`
	Platform     *Platform      `xml:"Platform,omitempty"`
	PowerSupply  []*PowerSupply `xml:"PowerSupply,omitempty"`
	PowerInfo    *PowerInfo     `xml:"POWER_INFO"`
	NodeInfo     *NodeInfo      `xml:"NodeInfo,omitempty"`
	BiosLicense  *BiosLicense   `xml:"BIOS_LINCESNE,omitempty"`
	HealthInfo   *HealthInfo    `xml:"HEALTH_INFO,omitempty"`
}

IPMI is the base structure that holds the information on queries to https://$ip/cgi/ipmi.cgi

type Node

type Node struct {
	IP          string `xml:"IP,attr"`
	ID          int    `xml:"ID,attr"`
	Power       string `xml:"Power,attr"`
	PowerStatus string `xml:"PowerStatus,attr"`
	NodeSerial  string `xml:"NodeSerialNo,attr"`
	SystemTemp  string `xml:"SystemTemp,attr"`
}

Node contains the power and thermal information of each board in the chassis

type NodeInfo

type NodeInfo struct {
	Nodes []*Node `xml:"Node,omitempty"`
}

NodeInfo contains a lists of boards in the chassis

type Platform

type Platform struct {
	MultiNode      string `xml:"EnMultiNode,attr"  json:",omitempty"`
	TwinNodeNumber string `xml:"TwinNodeNumber,attr"  json:",omitempty"`
}

Platform holds the information of the hardware type eg: fattwin or discrete

type PlatformInfo

type PlatformInfo struct {
	BiosVersion string `xml:"BIOS_VERSION,attr"`
	MbMacAddr1  string `xml:"MB_MAC_ADDR1,attr"`
	MbMacAddr2  string `xml:"MB_MAC_ADDR2,attr"`
	MbMacAddr3  string `xml:"MB_MAC_ADDR3,attr"`
	MbMacAddr4  string `xml:"MB_MAC_ADDR4,attr"`
}

PlatformInfo holds the hardware related information

type PowerInfo

type PowerInfo struct {
	Power struct {
		Status string `xml:"STATUS,attr"`
	} `xml:"POWER,omitempty"`
}

PowerInfo renders the current power state of the machine

type PowerSupply

type PowerSupply struct {
	Location  string `xml:"LOCATION,attr"`
	Status    string `xml:"STATUS,attr"`
	Unplugged string `xml:"UNPLUGGED,attr"`
}

PowerSupply holds the power supply information

type Product

type Product struct {
	SerialNum string `xml:"SERIAL_NUM,attr"  json:",omitempty"`
}

Product hold the product information

type Reader

type Reader struct {
	// contains filtered or unexported fields
}

Reader holds the status and properties of a connection to a supermicro bmc

type UserAccounts

type UserAccounts struct {
	Name string `xml:"NAME,attr"`
}

UserAccounts contains the user account information