chip

Documentation

Overview

Package chip facilitates communication with Intel® AMT devices to represent any type of integrated circuit hardware, including ASICs, processors, memory chips, etc.

Index

• Constants
• type Body
• type OperationalStatus
• type Package
  • func NewChipWithClient(wsmanMessageCreator *message.WSManMessageCreator, client client.WSMan) Package
  • func (chip Package) Enumerate() (response Response, err error)
  • func (chip Package) Get() (response Response, err error)
  • func (chip Package) Pull(enumerationContext string) (response Response, err error)
• type PackageResponse
• type PullResponse
• type Response
  • func (r *Response) JSON() string
  • func (r *Response) YAML() string

Constants

const CIM_Chip string = "CIM_Chip"

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

Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail:

- "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on.

- "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future.

- "In Service" describes an element being configured, maintained, cleaned, or otherwise administered.

- "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.

- "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable.

- "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated.

- "Dormant" indicates that the element is inactive or quiesced.

- "Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems.

- "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error).

- "Power Mode" indicates that the element has additional power model information contained in the Associated PowerManagementService association.

- "Relocating" indicates the element is being relocated.

OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.

ValueMap={0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, .., 0x8000..}

Values={Unknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor Reserved}

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

type Package

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

func NewChipWithClient

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

NewChip returns a new instance of the Chip struct.

func (Package) Enumerate

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

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

func (Package) Get

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

Get retrieves the representation of the instance

func (Package) Pull

func (chip 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_Chip"`
	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. 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.
	ElementName       string            `xml:"ElementName"`
	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.
	OperationalStatus OperationalStatus `xml:"OperationalStatus"` // Indicates the current statuses of the element.
	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.
	Version           string            `xml:"Version"`           // A string that indicates the version of the PhysicalElement.
}

Response Types

type PullResponse

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

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