card

Documentation

Overview

Package card facilitates communication with Intel® AMT devices to represent a type of physical container that can be plugged into another Card or HostingBoard, or is itself a HostingBoard/Motherboard in a Chassis

The CIM_Card class includes any package capable of carrying signals and providing a mounting point for PhysicalComponents, such as Chips, or other PhysicalPackages, such as other Cards.

Index

• Constants
• type Body
• type OperationalStatus
  • func (e OperationalStatus) String() string
• type Package
  • func NewCardWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Package
  • func (card Package) Enumerate() (response Response, err error)
  • func (card Package) Get() (response Response, err error)
  • func (card 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 CIM_Card string = "CIM_Card"

Types

type Body

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

Response Types

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 NewCardWithClient

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

NewCard returns a new instance of the Card struct.

func (Package) Enumerate

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

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

func (Package) Get

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

Get retrieves the representation of the instance

func (Package) Pull

func (card 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_Card"`
	CanBeFRUed        bool                `xml:"CanBeFRUed"`        // Boolean that indicates whether this PhysicalElement can be FRUed (TRUE) or not (FALSE).
	CreationClassName string              `xml:"CreationClassName"` // CreationClassName indicates the name of the class or the subclass used in the creation of an instance.
	ElementName       string              `xml:"ElementName"`
	Manufacturer      string              `xml:"Manufacturer"`      // The name of the organization responsible for producing the PhysicalElement.
	Model             string              `xml:"Model"`             // The name by which the PhysicalElement is generally known.
	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.
	SerialNumber      string              `xml:"SerialNumber"`      // A manufacturer-allocated number used to identify the Physical Element.
	Tag               string              `xml:"Tag"`               // An arbitrary string that uniquely identifies the Physical Element and serves as the key of the Element.
	Version           string              `xml:"Version"`           // A string that indicates the version of the PhysicalElement.
}

Response Types

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"`
	CardItems []PackageResponse `xml:"Items>CIM_Card"`
}

Response Types

type Response

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

Response Types

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