SoftLayer Hardware Component Model (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_Hardware_Component_Model data type. For information on the SoftLayer_Hardware_Component_Model service please see SoftLayer_Hardware_Component_Model.

Contents 1 Overview 2 Local Properties 2.1 capacity 2.2 description 2.3 hardwareGenericComponentModelId 2.4 id 2.5 manufacturer 2.6 name 2.7 version 3 Relational Properties 3.1 compatibleChildComponentModels 3.2 compatibleParentComponentModels 3.3 hardwareComponents 3.4 hardwareGenericComponentModel 3.5 rebootTime 3.6 type 4 Count Properties 4.1 compatibleChildComponentModelCount 4.2 compatibleParentComponentModelCount 4.3 hardwareComponentCount

Overview

The SoftLayer_Hardware_Component_Model data type contains general information relating to a single SoftLayer component model. A component model represents a vendor specific representation of a hardware component. Every piece of hardware on a server will have a specific hardware component model.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

capacity

A component model's capacity. The capacity of a component model depends on the model itself. For Example: Hard drives have a capacity that reflects the amount of data that hard drive can store.

• Type: decimal
• Length: 10 digits before the decimal point

---

description

A colon delimited list of hardware component model attributes.

• Type: string
• Length: 150 characters

---

hardwareGenericComponentModelId

The internal identifier of the generic component model for a component model.

• Type: integer
• Length: 10 digits

---

id

A hardware component model's internal identifier number.

• Type: integer

---

manufacturer

A hardware component model's manufacturer.

• Type: string
• Length: 50 characters

---

name

The model name of a hardware component model.

• Type: string
• Length: 100 characters

---

version

The model number or model description of a hardware component model.

• Type: string
• Length: 50 characters

Relational Properties

compatibleChildComponentModels

All the component models that are compatible with a hardware component model.
compatibleChildComponentModels can be queried by object mask.

• Type: SoftLayer_Hardware_Component_ModelArray

---

compatibleParentComponentModels

All the component models that a hardware component model is compatible with.
compatibleParentComponentModels can be queried by object mask.

• Type: SoftLayer_Hardware_Component_ModelArray

---

hardwareComponents

A hardware component model's physical components in inventory.
hardwareComponents can be queried by object mask.

• Type: SoftLayer_Hardware_ComponentArray

---

hardwareGenericComponentModel

The non-vendor specific generic component model for a hardware component model.
hardwareGenericComponentModel can be queried by object mask.
hardwareGenericComponentModel must be a unique value.

• Type: SoftLayer_Hardware_Component_Model_Generic

---

rebootTime

A motherboard's average reboot time.
rebootTime can be queried by object mask.
rebootTime must be a unique value.

• Type: SoftLayer_Hardware_Component_Motherboard_Reboot_Time

---

type

A hardware component model's type.
type can be queried by object mask.
type must be a unique value.

• Type: string

Count Properties

compatibleChildComponentModelCount

A count of all the component models that are compatible with a hardware component model.
compatibleChildComponentModelCount must be a unique value.

• Type: unsigned long

---

compatibleParentComponentModelCount

A count of all the component models that a hardware component model is compatible with.
compatibleParentComponentModelCount must be a unique value.

• Type: unsigned long

---

hardwareComponentCount

A count of a hardware component model's physical components in inventory.
hardwareComponentCount must be a unique value.

• Type: unsigned long