chassis

Documentation

Overview

Package chassis facilitates communication with Intel® AMT devices to represent the PhysicalElements that enclose other Elements and provide definable functionality, such as a desktop, processing node, UPS, disk or tape storage, or a combination of these.

Index

• Constants
• type Body
• type ChassisPackageType
  • func (c ChassisPackageType) String() string
• type OperationalStatus
  • func (e OperationalStatus) String() string
• type Package
  • func NewChassisWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Package
  • func (chassis Package) Enumerate() (response Response, err error)
  • func (chassis Package) Get() (response Response, err error)
  • func (chassis Package) Pull(enumerationContext string) (response Response, err error)
• type PackageResponse
• type PackageType
  • func (e PackageType) String() string
• type PullResponse
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string

Constants

const (
	CIMChassis    string = "CIM_Chassis"
	ValueNotFound string = "Value not found in map"
)

Types

type Body

type Body struct {
	XMLName           xml.Name `xml:"Body"`
	PullResponse      PullResponse
	EnumerateResponse common.EnumerateResponse
	PackageResponse   PackageResponse
}

type ChassisPackageType

type ChassisPackageType int

ChassisPackageType is an enumeration defining the type of the PhysicalPackage.

const (
	Unknown ChassisPackageType = iota
	Other
	SMBIOSReserved1
	Desktop
	LowProfileDesktop
	PizzaBox
	MiniTower
	Tower
	Portable
	LapTop
	Notebook
	HandHeld
	DockingStation
	AllInOne
	SubNotebook
	SpaceSaving
	LunchBox
	MainSystemChassis
	ExpansionChassis
	SubChassis
	BusExpansionChassis
	PeripheralChassis
	StorageChassis
	SMBIOSReserved2
	SealedCasePC
	SMBIOSReserved3
	CompactPCI
	AdvancedTCA
	BladeEnclosure
	SMBIOSReserved4
	Tablet
	Convertible
	Detachable
	IoTGateway
	EmbeddedPC
	MiniPC
	StickPC
)

ChassisPackageType values.

func (ChassisPackageType) String

func (c ChassisPackageType) String() string

String returns the string representation of a ChassisPackageType value.

type OperationalStatus

type OperationalStatus int

OperationalStatus is the current statuses of the element.

const (
	OperationalStatusUnknown OperationalStatus = iota
	OperationalStatusOther
	OperationalStatusOK
	OperationalStatusDegraded
	OperationalStatusStressed
	OperationalStatusPredictiveFailure
	OperationalStatusError
	OperationalStatusNonRecoverableError
	OperationalStatusStarting
	OperationalStatusStopping
	OperationalStatusStopped
	OperationalStatusInService
	OperationalStatusNoContact
	OperationalStatusLostCommunication
	OperationalStatusAborted
	OperationalStatusDormant
	OperationalStatusSupportingEntityInError
	OperationalStatusCompleted
	OperationalStatusPowerMode
	OperationalStatusRelocating
)

func (OperationalStatus) String

func (e OperationalStatus) String() string

String returns a human-readable string representation of the OperationalStatus enumeration.

type Package

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

func NewChassisWithClient

func NewChassisWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Package

NewChassis returns a new instance of the Chassis struct.

func (Package) Enumerate

func (chassis Package) Enumerate() (response Response, err error)

Enumerate returns an enumeration context which is used in a subsequent Pull call.

func (Package) Get

func (chassis Package) Get() (response Response, err error)

Get retrieves the representation of the instance.

func (Package) Pull

func (chassis Package) Pull(enumerationContext string) (response Response, err error)

Pull returns the instances of this class. An enumeration context provided by the Enumerate call is used as input.

type PackageResponse

type PackageResponse struct {
	XMLName            xml.Name            `xml:"CIM_Chassis"`
	Version            string              `xml:"Version"`      // A string that indicates the version of the PhysicalElement.
	SerialNumber       string              `xml:"SerialNumber"` // A manufacturer-allocated number used to identify the Physical Element.
	Model              string              `xml:"Model"`        // The name by which the PhysicalElement is generally known.
	Manufacturer       string              `xml:"Manufacturer"` // The name of the organization responsible for producing the PhysicalElement. This organization might be the entity from whom the Element is purchased, but this is not necessarily true. The latter information is contained in the Vendor property of CIM_Product.
	ElementName        string              `xml:"ElementName"`
	CreationClassName  string              `xml:"CreationClassName"`  // CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.
	Tag                string              `xml:"Tag"`                // An arbitrary string that uniquely identifies the Physical Element and serves as the key of the Element. The Tag property can contain information such as asset tag or serial number data. The key for PhysicalElement is placed very high in the object hierarchy in order to independently identify the hardware or entity, regardless of physical placement in or on Cabinets, Adapters, and so on. For example, a hotswappable or removable component can be taken from its containing (scoping) Package and be temporarily unused. The object still continues to exist and can even be inserted into a different scoping container. Therefore, the key for Physical Element is an arbitrary string and is defined independently of any placement or location-oriented hierarchy.
	OperationalStatus  []OperationalStatus `xml:"OperationalStatus"`  // Indicates the current statuses of the element.
	PackageType        PackageType         `xml:"PackageType"`        // Enumeration defining the type of the PhysicalPackage. Note that this enumeration expands on the list in the Entity MIB (the attribute, entPhysicalClass). The numeric values are consistent with CIM's enum numbering guidelines, but are slightly different than the MIB's values.
	ChassisPackageType ChassisPackageType  `xml:"ChassisPackageType"` // ChassisPackageType indicates the physical form factor for the type of Chassis.
}

type PackageType

type PackageType int

PackageType is the type of the PhysicalPackage.

const (
	PackageTypeUnknown PackageType = iota
	PackageTypeOther
	PackageTypeRack
	PackageTypeChassisFrame
	PackageTypeCrossConnectBackplane
	PackageTypeContainerFrameSlot
	PackageTypePowerSupply
	PackageTypeFan
	PackageTypeSensor
	PackageTypeModuleCard
	PackageTypePortConnector
	PackageTypeBattery
	PackageTypeProcessor
	PackageTypeMemory
	PackageTypePowerSourceGenerator
	PackageTypeStorageMediaPackage
	PackageTypeBlade
	PackageTypeBladeExpansion
)

func (PackageType) String

func (e PackageType) String() string

String returns a human-readable string representation of the PackageType enumeration.

type PullResponse

type PullResponse struct {
	XMLName      xml.Name          `xml:"PullResponse"`
	PackageItems []PackageResponse `xml:"Items>CIM_Chassis"`
}

type Response

type Response struct {
	*client.Message
	XMLName xml.Name       `xml:"Envelope"`
	Header  message.Header `xml:"Header"`
	Body    Body           `xml:"Body"`
}

func (*Response) JSON

func (r *Response) JSON() string

JSON marshals the type into JSON format.

func (*Response) YAML

func (r *Response) YAML() string

YAML marshals the type into YAML format.