Reference Guide

The Reference Guide contains the
file:///T|/htdocs/SOFTWARE/smcliins/cli81/en/refgd/index.html[10/19/2012 10:01:19 AM]
ElementName
Note: The Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often sub-classed to be a Key. It is not reasonable that the same property can convey both identity and a user-
friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.
LockPresent Boolean indicating whether the Frame is protected with a lock.
Manufacturer
The name of the organization responsible for producing the PhysicalElement. This organization 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 The name by which the PhysicalElement is generally known.
Name The Name property defines the label by which the object is known. When sub-classed, the Name property can be overridden to be a Key property.
PackageType
Enumeration defining the type of the PhysicalPackage.
Possible values are:
0 = Unknown - Indicates that the package type is not known.
1 = Other - The package type does not correspond to an existing enumerated value. The value is specified using the OtherPackageType property.
2 = Rack
3 = Chassis/Frame
4 = Cross Connect/Backplane
5 = Container/Frame Slot
6 = Power Supply
7 = Fan
8 = Sensor
9 = Module/Card
10 = Port/Connector
11 = Battery
12 = Processor
13 = Memory
14 = Power Source/Generator
15 = Storage Media Package (example, Disk or Tape Drive)
16 = Blade
17 = Blade Expansion
Note: This enumeration expands on the list in the Entity MIB (the attribute, entPhysicalClass). The numeric values are consistent with CIM's enum numbering guidelines, but are slightly different than the MIB's values.
The values "Rack" through "Port/Connector" are defined per the Entity-MIB (where the semantics of rack are equivalent to the MIB's 'stack' value).
The other values (for battery, processor, memory, power source/generator and storage media package) are self-explanatory. A value of "Blade" should be used when the PhysicalPackage contains the operational hardware
aspects of a ComputerSystem, without the supporting mechanicals such as power and cooling. For example, a Blade Server includes processor(s) and memory, and relies on the containing chassis to supply power and
cooling.
In many respects, a Blade can be considered a "Module/Card". However, it is tracked differently by inventory systems and differs in terms of service philosophy. For example, a Blade is intended to be hot-plugged into a
hosting enclosure without requiring additional cabling, and does not require a cover to be removed from the enclosure for installation. Similarly, a "Blade Expansion" has characteristics of a "Blade" and a "Module/Card".
However, it is distinct from both due to inventory tracking and service philosophy, and because of its hardware dependence on a Blade. A Blade Expansion must be attached to a Blade prior to inserting the resultant
assembly into an enclosure.
PartNumber The part number assigned by the organization that is responsible for producing or manufacturing the PhysicalElement.
PropertyOwnershipTag Property Ownership Tag of a system.
SecurityBreach
An enumerated, integer-valued property indicating whether a physical breach of the Frame was attempted but unsuccessful (value=4) or attempted and successful (5).
Possible values are:
1 = Other
2 = Unknown
3 = No Breach
4 = Breach Attempted
5 = Breach Successful
SKU The stock-keeping unit number for this PhysicalElement.
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.
VendorCompatibilityStrings
An array of strings that identify the component that is compatible with, and can be inserted in a slot that reports this string as one of the array element in the VendorCompatibilityStrings. This allows system administrators
to determine whether it is appropriate to insert a package into a slot to ensure uniqueness within the NameSpace, each value defined by the vendor for use in the VendorCompatibilityStrings property SHOULD be
constructed using the following 'preferred' algorithm: : Where and are separated by a colon ':', and where MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity
creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the _ structure of Schema class names.) In addition, to ensure uniqueness
MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between and . is chosen by the business entity and SHOULD not be re-used to identify different underlying
(real-world) elements.
ChangePropertyOwenershipTag (Method) This method allows a user to change the Property Ownership Tag of a system.
ChangeAssetTag (Method) This method allows a user to change the Asset Tag of a system.
DCIM_Chip
CanBeFRUed Boolean that indicates whether this PhysicalElement can be FRUed (TRUE) or not (FALSE).
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
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.
Note: The Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often sub classed to be a Key. It is not reasonable that the same property can convey both identity and a user-
friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.
Manufacturer
The name of the organization responsible for producing the PhysicalElement. This organization may be the entity from where the Element is purchased, but this is not necessarily true. The latter information is contained in
the Vendor property of CIM_Product.
Model The name by which the PhysicalElement is generally known.
PartNumber The part number assigned by the organization that is responsible for producing or manufacturing the PhysicalElement.
SerialNumber A manufacturer-allocated number used to identify the Physical Element.
SKU The stock-keeping unit number for this PhysicalElement.
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 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.