Home Reference WMI Reference root CIMV2 Win32_OnBoardDevice
 

Win32_OnBoardDevice

The Win32_OnBoardDevice class represents common adapter devices built into the motherboard (system board).

Quick Start

Properties

In this WMI class, all WMI properties are read-only. You can only read values but not change them.

Caption

Data type String

The Caption property is a short textual description (one-line string) of the object.

CreationClassName

Data type String

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.

Description

Data type String

The Description property describes the on-board device and is filled by the manufacturer of the device.

DeviceType

Data type UInt16

The DeviceType property indicates the type of device being represented.

$DeviceType_ReturnValue = 
@{
    1='Other'
    2='Unknown'
    3='Video'
    4='SCSI Controller'
    5='Ethernet'
    6='Token Ring'
    7='Sound'
}

Enabled

Data type Boolean

The Enabled property indicates whether or not the on-board device is available for use.

Values: $true or $false. A value of $true indicates the device is enabled for use.

HotSwappable

Data type Boolean

A physical component 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 (i.e., is ‘on’). For example, a fan component may be designed to be hot swapped. All components that can be hot swapped are inherently removable and replaceable .

InstallDate

Data type DateTime

The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.

Manufacturer

Data type String

The name of the organization responsible for producing the physical element. This may 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.

Model

Data type String

The name by which the physical element is generally known.

Name

Data type String

The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

OtherIdentifyingInfo

Data type String

OtherIdentifyingInfo captures 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/able to be used as an element key, this property would be NULL and the bar code data used as the class key, in the tag property.

PartNumber

Data type String

The part number assigned by the organization responsible for producing or manufacturing the physical element.

PoweredOn

Data type Boolean

Boolean indicating that the physical element is powered on ($true), or is currently off ($false).

Removable

Data type Boolean

A physical component 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 component can still be removable if power must be ‘off’ in order to perform the removal. If power can be ‘on’ and the component removed, then the element is removable and can be hot swapped. For example, an upgradeable processor chip is removable.

Replaceable

Data type Boolean

A physical component 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 . All removable components are inherently replaceable .

SerialNumber

Data type String

A manufacturer-allocated number used to identify the PhysicalElement.

SKU

Data type String

The stock keeping unit number for this physical element.

Status

Data type String

The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are “OK”, “Degraded” and “Pred Fail”. “Pred Fail” indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are “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 on-line, yet the managed element is neither “OK” nor in one of the other states.

'OK','Error','Degraded','Unknown','Pred Fail','Starting','Stopping','Service','Stressed','NonRecover','No Contact','Lost Comm'

Tag

Data type String

The Tag property uniquely identifies the on-board device connected to the system.

Example: On Board Device 1

Version

Data type String

A string indicating the version of the physical element.

Methods

Examples

Help and Questions

  Community Content

You are cordially invited to add knowledge to this page. If you have sample code or additional information related to this WMI class, please share it. Use the comment form to send your information. We will edit and incorparate it into the reference library. Thank you!

Please do not use the comment form to submit questions. If you have questions or need assistance, visit our free forum: Help me with WMI.

Content last updated: 2013-12-27 12:25:30 (UTC).

Facebooktwittergoogle_pluspinterestlinkedinFacebooktwittergoogle_pluspinterestlinkedin