CIM_Product class

The CIM_Product class represents a set of goods or services produced by a supplier as a single unit for a user. A product can include physical elements, software, or services.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[UMLPackagePath("CIM::Core::ProductFRU"), Version("2.7.0"), AMENDMENT]
class CIM_Product : CIM_ManagedElement
{
  string   InstanceID;
  string   Caption;
  string   Description;
  string   ElementName;
  string   Name;
  string   IdentifyingNumber;
  string   Vendor;
  string   Version;
  string   SKUNumber;
  datetime WarrantyStartDate;
  uint32   WarrantyDuration;
};

Members

The CIM_Product class has these types of members:

• Properties

Properties

The CIM_Product class has these properties.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

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

This property is inherited from CIM_ManagedElement.

Description

Data type: string

Access type: Read-only

The Description property provides a textual description of the object.

This property is inherited from CIM_ManagedElement.

ElementName

Data type: string

Access type: Read-only

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from CIM_ManagedElement.

IdentifyingNumber

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (64)

The ID of the product, such as a serial number on software, a die number on a hardware chip, or (for non-commercial Products) a project number.

InstanceID

Data type: string

Access type: Read-only

An optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.

To ensure uniqueness within the namespace, the value of InstanceID should be constructed using the following "preferred" algorithm:

<OrgID>:<LocalID>

Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the namespace of this instance.

If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.

This property is inherited from CIM_ManagedElement.

Name

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), ModelCorrespondence ("PRS_Product.ProductName")

The user friendly name of the product.

SKUNumber

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64)

The product SKU (stock keeping unit).

Vendor

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (256), ModelCorrespondence ("PRS_Product.Vendor")

The name of the product's supplier.

Version

Data type: string

Access type: Read-only

Qualifiers: key, MaxLen (64), ModelCorrespondence ("PRS_Product.Version")

The product version.

WarrantyDuration

Data type: uint32

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Product.WarrantyStartDate"), PUnit ("day"), Units ("Days")

If the product is under warranty, the duration of the warranty in days.

WarrantyStartDate

Data type: datetime

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_Product.WarrantyDuration")

If the product is under warranty, the start date of the warranty.

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012 R2
Namespace	Root\Microsoft\IPAM
MOF	IPAMServerPSProvider.mof
DLL	IPAMServerPSProvider.dll