Win32_OnBoardDevice class
The Win32_OnBoardDevice WMI class represents common adapter devices built into the motherboard (system board).
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties. Properties are listed in alphabetic order, not MOF order.
Syntax
[Dynamic, Provider("CIMWin32"), UUID("{AEECF151-D0EA-11d2-ABFC-00805F538618}"), AMENDMENT]
class Win32_OnBoardDevice : CIM_PhysicalComponent
{
string Caption;
string CreationClassName;
string Description;
uint16 DeviceType;
boolean Enabled;
boolean HotSwappable;
datetime InstallDate;
string Manufacturer;
string Model;
string Name;
string OtherIdentifyingInfo;
string PartNumber;
boolean PoweredOn;
boolean Removable;
boolean Replaceable;
string SerialNumber;
string SKU;
string Status;
string Tag;
string Version;
};
Members
The Win32_OnBoardDevice class has these types of members:
Properties
The Win32_OnBoardDevice class has these properties.
-
Caption
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), DisplayName ("Caption")
Short description of the object.
This property is inherited from CIM_ManagedSystemElement.
-
-
CreationClassName
-
Name of the first concrete class to appear in the inheritance chain used in the creation of an instance. When used with the other key properties of the class, the property allows all instances of this class and its subclasses to be uniquely identified.
This property is inherited from CIM_PhysicalElement.
-
Description
-
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Override ("Description"), MappingStrings ("SMBIOS|Type 10|Description")
Description of the object.
This property is inherited from CIM_ManagedSystemElement.
-
-
DeviceType
-
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("SMBIOS|Type 10|Device Type n")
Type of device being represented.
-
-
Other (1)
-
Unknown (2)
-
Video (3)
-
SCSI Controller (4)
-
Ethernet (5)
-
Token Ring (6)
-
Sound (7)
Enabled
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: MappingStrings ("SMBIOS|Type 10|Device Status n")
If TRUE, the on-board device is available for use.
HotSwappable
-
Data type: boolean
-
Access type: Read-only
If TRUE, a physical package can be hot-swapped (if it is possible to replace the element with a physically different but equivalent one while the containing package has power applied to it). For example, a disk drive package inserted using SCA connectors is removable and can be hot-swapped. All packages that can be hot-swapped are inherently removable and replaceable.
This property is inherited from CIM_PhysicalComponent.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")
Date and time the object was installed. This property does not need a value to indicate that the object is installed.
This property is inherited from CIM_ManagedSystemElement.
Manufacturer
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256)
Name of the organization responsible for producing the physical element.
This property is inherited from CIM_PhysicalElement.
Model
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Name by which the physical element is generally known.
This property is inherited from CIM_PhysicalElement.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: DisplayName ("Name")
Label by which the object is known. When subclassed, the property can be overridden to be a key property.
This property is inherited from CIM_ManagedSystemElement.
OtherIdentifyingInfo
-
Data type: string
-
Access type: Read-only
Additional data, beyond asset tag information, that could be used to identify a physical element. One example is bar code data associated with an element that also has an asset tag. Note that if only bar code data is available and is unique or able to be used as an element key, this property would be NULL and the bar code data is used as the class key in the tag property.
This property is inherited from CIM_PhysicalElement.
PartNumber
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (256)
Part number assigned by the organization responsible for producing or manufacturing the physical element.
This property is inherited from CIM_PhysicalElement.
PoweredOn
-
Data type: boolean
-
Access type: Read-only
If TRUE, the physical element is powered on.
This property is inherited from CIM_PhysicalElement.
Removable
-
Data type: boolean
-
Access type: Read-only
If TRUE, a physical package is removable (if it is designed to be taken in and out of the physical container in which it is normally found, without impairing the function of the overall packaging). A package can still be removable if power must be "off" to perform the removal. If power can be "on" and the package removed, then the element is removable and can be hot-swapped. For example, an extra battery in a laptop is removable, as is a disk drive package inserted using SCA connectors. However, the latter can be hot-swapped. A laptop's display is not removable, nor is a nonredundant power supply. Removing these components would affect the function of the overall packaging or is impossible due to the tight integration of the package.
This property is inherited from CIM_PhysicalComponent.
Replaceable
-
Data type: boolean
-
Access type: Read-only
If TRUE, a physical package is replaceable (if it is possible to replace, FRU or upgrade, the element with a physically different one). For example, some computer systems allow the main processor chip to be upgraded to one of a higher clock rating. In this case, the processor is said to be replaceable. Another example is a power supply package mounted on sliding rails. All removable packages are inherently replaceable.
This property is inherited from CIM_PhysicalComponent.
SerialNumber
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Manufacturer-allocated number used to identify the physical element.
This property is inherited from CIM_PhysicalElement.
SKU
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Stock-keeping unit number for the physical element.
This property is inherited from CIM_PhysicalElement.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (10), DisplayName ("Status")
Current status of the object. Various operational and nonoperational statuses can be defined. Operational statuses include: "OK", "Degraded", and "Pred Fail" (an element, such as a SMART-enabled hard disk drive, may be functioning properly but predicting a failure in the near future). Nonoperational statuses include: "Error", "Starting", "Stopping", and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is online, yet the managed element is neither "OK" nor in one of the other states.
This property is inherited from CIM_ManagedSystemElement.
Values include the following:
OK ("OK")
Error ("Error")
Degraded ("Degraded")
Unknown ("Unknown")
Pred Fail ("Pred Fail")
Starting ("Starting")
Stopping ("Stopping")
Service ("Service")
Stressed ("Stressed")
NonRecover ("NonRecover")
No Contact ("No Contact")
Lost Comm ("Lost Comm")
Tag
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, MaxLen (256), Override ("Tag"), MappingStrings ("WMI")
Unique identifier of the on-board device connected to the system.
This property is inherited from CIM_PhysicalElement.
Example: "On Board Device 1"
Version
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
Version of the physical element.
This property is inherited from CIM_PhysicalElement.
Remarks
The Win32_OnBoardDevice class is derived from CIM_PhysicalComponent.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client |
Windows Vista |
| Minimum supported server |
Windows Server 2008 |
| Namespace |
Root\CIMV2 |
| MOF |
|
| DLL |
|
See also