Class CIM_PhysicalElement
CIM_ManagedElement
CIM_ManagedSystemElement
CIM_PhysicalElement
- Known Subclasses:
- CIM_PhysicalComponent CIM_Chip CIM_PhysicalMemory CIM_PhysicalPackage CIM_Card CIM_PhysicalFrame CIM_Chassis CIM_PhysicalConnector
Abstract class CIM_PhysicalElement
- extends CIM_ManagedSystemElement
General Information:
Subclasses of CIM_PhysicalElement define any
component of a System that has a distinct physical identity. Instances of this
class can be defined as an object that can be seen or touched. All Processes,
Files, and LogicalDevices are considered not to be Physical Elements. For
example, it is not possible to touch the functionality of a 'modem.' You can
touch only the card or package that implements the modem. The same card could
also implement a LAN adapter. PhysicalElements are tangible
ManagedSystemElements that have a physical manifestation of some sort.
Note that the properties of PhysicalElement describe a hardware entity.
Possible replacement (FRU) information is defined by following the ElementFRU
association to one or more instances of the ReplacementFRU class. This
definition allows a client to determine what hardware can be replaced (FRUed)
and what 'spare' parts might be required by a customer or engineer doing the
replacement. If it can be instrumented or manually determined that an element
actually replaced (FRUed) another, then this can be described in the model using
the ElementHasBeenFRUed
association.
Qualifiers:
-------------
Abstract
Version=2.10.0
UMLPackagePath=CIM::Core::Physical
Supported Fields
Summary |
uint16
|
HealthState
Indicates the current health of the element . . .
|
string
|
Status A string
indicating the current status of the object . . .
|
string[]
|
StatusDescriptions
Strings describing the various OperationalStatus array values .
. .
|
uint16[]
|
OperationalStatus
Indicates the current statuses of the element . . .
|
string
|
Name The Name property
defines the label by which the object is known . . .
|
datetime
|
InstallDate A
datetime value that indicates when the object was installed . . .
|
string
|
Caption The Caption
property is a short textual description (one- line string) of the
object.
|
string
|
Tag An arbitrary string that uniquely identifies the
Physical Element and serves as the key of the Element . . .
|
string
|
Description A
textual description of the PhysicalElement.
|
string
|
CreationClassName CreationClassName indicates the name
of the class or the subclass used in the creation of an instance . .
.
|
string
|
ElementName
|
string
|
Manufacturer The
name of the organization responsible for producing the PhysicalElement . .
.
|
string
|
Model The name by which
the PhysicalElement is generally known.
|
string
|
SKU The stock-keeping unit
number for this PhysicalElement.
|
string
|
SerialNumber A
manufacturer-allocated number used to identify the Physical
Element.
|
string
|
Version A string that
indicates the version of the PhysicalElement.
|
string
|
PartNumber The part
number assigned by the organization that is responsible for producing or
manufacturing the PhysicalElement.
|
string
|
OtherIdentifyingInfo
OtherIdentifyingInfo captures data in addition to Tag
information . . .
|
boolean
|
PoweredOn Boolean
that indicates whether the PhysicalElement is powered on (TRUE) or is
currently off (FALSE).
|
datetime
|
ManufactureDate
The date that this PhysicalElement was manufactured.
|
string
|
VendorEquipmentType
A vendor-specific hardware type for the PhysicalElement . .
.
|
string
|
UserTracking
User-assigned and writeable asset-tracking identifier for the
PhysicalElement.
|
boolean
|
CanBeFRUed Boolean
that indicates whether this PhysicalElement can be FRUed (TRUE) or not
(FALSE).
|
Methods Summary |
|
Create(Instance,
ResourceCreated) Creates a new instance of this class
|
|
Put(Instance) Changes
properties of the selected instance
|
|
Get(Instance) Gets the
representation of the instance
|
|
Delete() Deletes an
instance
|
|
Pull(EnumerationContext,
MaxElements) Pulls instances of this class, following an
Enumerate operation
|
|
Enumerate()
Enumerates the instances of this class
|
|
Release(EnumerationContext)
Releases an enumeration context
|
|
Subscribe()
Subscribes to this resource (WS-Eventing)
|
|
Unsubscribe()
Remove subscription to this resource
(WS-Eventing)
|
HealthState
public uint16 HealthState
- General Information:
Indicates the current health of the
element. This attribute expresses the health of this element but not
necessarily that of its subcomponents. The possible values are 0 to 30, where
5 means the element is entirely healthy and 30 means the element is completely
non-functional. The following continuum is defined:
"Non-recoverable
Error" (30) - The element has completely failed, and recovery is not possible.
All functionality provided by this element has been lost.
"Critical
Failure" (25) - The element is non-functional and recovery might not be
possible.
"Major Failure" (20) - The element is failing. It is possible
that some or all of the functionality of this component is degraded or not
working.
"Minor Failure" (15) - All functionality is available but some
might be degraded.
"Degraded/Warning" (10) - The element is in working
order and all functionality is provided. However, the element is not working
to the best of its abilities. For example, the element might not be operating
at optimal performance or it might be reporting recoverable errors.
"OK"
(5) - The element is fully functional and is operating within normal
operational parameters and without error.
"Unknown" (0) - The
implementation cannot report on HealthState at this time.
DMTF has
reserved the unused portion of the continuum for additional HealthStates in
the future.
Qualifiers:
-------------
ValueMap={0, 5, 10,
15, 20, 25, 30, .., 32768..65535}
Values={Unknown, OK, Degraded/Warning,
Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF
Reserved, Vendor Specific}
Status
public string Status
- General Information:
A string indicating the current status of
the object. Various operational and non-operational statuses are defined. This
property is deprecated in lieu of OperationalStatus, which includes the same
semantics in its enumeration. This change is made for 3 reasons:
1) Status
is more correctly defined as an array. This definition overcomes the
limitation of describing status using a single value, when it is really a
multi-valued property (for example, an element might be OK AND Stopped.
2)
A MaxLen of 10 is too restrictive and leads to unclear enumerated values.
3) The change to a uint16 data type was discussed when CIM V2.0 was
defined. However, existing V1.0 implementations used the string property and
did not want to modify their code. Therefore, Status was grandfathered into
the Schema. Use of the deprecated qualifier allows the maintenance of the
existing property, but also permits an improved definition using
OperationalStatus.
Qualifiers:
-------------
Deprecated={CIM_ManagedSystemElement.OperationalStatus}
ValueMap={OK,
Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed,
NonRecover, No Contact, Lost Comm, Stopped}
MaxLen=10
StatusDescriptions
public string[] StatusDescriptions
- General Information:
Strings describing the various
OperationalStatus array values. For example, if "Stopping" is the value
assigned to OperationalStatus, then this property may contain an explanation
as to why an object is being stopped. Note that entries in this array are
correlated with those at the same array index in
OperationalStatus.
Qualifiers:
-------------
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.OperationalStatus}
MaxLen=256
OperationalStatus
public uint16[] OperationalStatus
- General Information:
Indicates the current statuses of the
element. Various operational statuses are defined. Many of the enumeration's
values are self-explanatory. However, a few are not and are described here in
more detail.
"Stressed" indicates that the element is functioning, but
needs attention. Examples of "Stressed" states are overload, overheated, and
so on.
"Predictive Failure" indicates that an element is functioning
nominally but predicting a failure in the near future.
"In Service"
describes an element being configured, maintained, cleaned, or otherwise
administered.
"No Contact" indicates that the monitoring system has
knowledge of this element, but has never been able to establish communications
with it.
"Lost Communication" indicates that the ManagedSystem Element is
known to exist and has been contacted successfully in the past, but is
currently unreachable.
"Stopped" and "Aborted" are similar, although the
former implies a clean and orderly stop, while the latter implies an abrupt
stop where the state and configuration of the element might need to be
updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" indicates that this element might be "OK" but
that another element, on which it is dependent, is in error. An example is a
network service or endpoint that cannot function due to lower-layer networking
problems.
"Completed" indicates that the element has completed its
operation. This value should be combined with either OK, Error, or Degraded so
that a client can tell if the complete operation Completed with OK (passed),
Completed with Error (failed), or Completed with Degraded (the operation
finished, but it did not complete OK or did not report an error).
"Power
Mode" indicates that the element has additional power model information
contained in the Associated PowerManagementService association.
"Relocating" indicates the element is being
relocated.
OperationalStatus replaces the Status property on
ManagedSystemElement to provide a consistent approach to enumerations, to
address implementation needs for an array property, and to provide a migration
path from today's environment to the future. This change was not made earlier
because it required the deprecated qualifier. Due to the widespread use of the
existing Status property in management applications, it is strongly
recommended that providers or instrumentation provide both the Status and
OperationalStatus properties. Further, the first value of OperationalStatus
should contain the primary status for the element. When instrumented, Status
(because it is single-valued) should also provide the primary status of the
element.
Qualifiers:
-------------
ValueMap={0, 1, 2, 3,
4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, ..,
0x8000..}
Values={Unknown, Other, OK, Degraded, Stressed, Predictive
Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In
Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity
in Error, Completed, Power Mode, Relocating, DMTF Reserved, Vendor
Reserved}
ArrayType=Indexed
ModelCorrespondence={CIM_ManagedSystemElement.StatusDescriptions}
Name
public string Name
- General Information:
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.
Qualifiers:
-------------
MaxLen=1024
InstallDate
public datetime InstallDate
- General Information:
A datetime value that indicates when the
object was installed. Lack of a value does not indicate that the object is not
installed.
Qualifiers:
-------------
MappingStrings={MIF.DMTF|ComponentID|001.5}
Caption
public string Caption
- General Information:
The Caption property is a short textual
description (one- line string) of the
object.
Qualifiers:
-------------
MaxLen=64
Tag
public string Tag
- General Information:
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.
Qualifiers:
-------------
Key
MaxLen=256
Description
public string Description
- General Information:
A textual description of the
PhysicalElement.
Qualifiers:
-------------
Override=Description
MappingStrings={MIF.DMTF|FRU|003.3}
MaxLen=256
CreationClassName
public string CreationClassName
- General Information:
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.
Qualifiers:
-------------
Key
MaxLen=256
ElementName
public string ElementName
- General
Information:
Qualifiers:
-------------
Override=ElementName
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalName}
MaxLen=256
Manufacturer
public string Manufacturer
- General Information:
The name of the organization responsible
for producing the PhysicalElement. This organization might 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.
Qualifiers:
-------------
MaxLen=256
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalMfgName,
MIF.DMTF|FRU|003.4}
Model
public string Model
- General Information:
The name by which the PhysicalElement is
generally
known.
Qualifiers:
-------------
MaxLen=256
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalDescr,
MIF.DMTF|FRU|003.5}
SKU
public string SKU
- General Information:
The stock-keeping unit number for this
PhysicalElement.
Qualifiers:
-------------
MaxLen=64
SerialNumber
public string SerialNumber
- General Information:
A manufacturer-allocated number used to
identify the Physical
Element.
Qualifiers:
-------------
MaxLen=256
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalSerialNum,
MIF.DMTF|FRU|003.7}
Version
public string Version
- General Information:
A string that indicates the version of the
PhysicalElement.
Qualifiers:
-------------
MaxLen=64
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalHardwareRev,
MIF.DMTF|FRU|003.8}
PartNumber
public string PartNumber
- General Information:
The part number assigned by the
organization that is responsible for producing or manufacturing the
PhysicalElement.
Qualifiers:
-------------
MaxLen=256
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalModelName}
OtherIdentifyingInfo
public string OtherIdentifyingInfo
- General Information:
OtherIdentifyingInfo captures data in
addition to Tag information. This information 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 would be used as the class key, in the Tag
property.
Qualifiers:
-------------
Write
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalAlias}
MaxLen=256
PoweredOn
public boolean PoweredOn
- General Information:
Boolean that indicates whether the
PhysicalElement is powered on (TRUE) or is currently off (FALSE).
ManufactureDate
public datetime ManufactureDate
- General Information:
The date that this PhysicalElement was
manufactured.
VendorEquipmentType
public string VendorEquipmentType
- General Information:
A vendor-specific hardware type for the
PhysicalElement. It describes the specific equipment type for the element, as
defined by the vendor or
manufacturer.
Qualifiers:
-------------
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalVendorType}
MaxLen=256
UserTracking
public string UserTracking
- General Information:
User-assigned and writeable asset-tracking
identifier for the
PhysicalElement.
Qualifiers:
-------------
Write
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalAssetID}
MaxLen=256
CanBeFRUed
public boolean CanBeFRUed
- General Information:
Boolean that indicates whether this
PhysicalElement can be FRUed (TRUE) or not
(FALSE).
Qualifiers:
-------------
MappingStrings={MIB.IETF|Entity-MIB.entPhysicalIsFRU}
Create
public Create([IN]CIM_PhysicalElement Instance, [OUT] REF CIM_PhysicalElement ResourceCreated)
- Permission Information:
No permissions defined
General
Information:
Creates a new instance of this class
Product
Specific Usage:
The following properties must be included in any
representation of CIM_PhysicalElement:
Tag
CreationClassName
Put
public Put([IN]CIM_PhysicalElement Instance)
- Permission Information:
No permissions defined
General
Information:
Changes properties of the selected
instance
Product Specific Usage:
The following properties
must be included in any representation of CIM_PhysicalElement:
Tag
CreationClassName
Get
public Get([OUT]CIM_PhysicalElement Instance)
- Permission Information:
No permissions defined
General
Information:
Gets the representation of the instance
Delete
public Delete()
- Permission Information:
No permissions defined
General
Information:
Deletes an instance
Pull
public Pull([IN]String EnumerationContext, [IN]String MaxElements)
- Permission Information:
All users permitted to use method, only
instances to whom the user has permissions will be returned
General
Information:
Pulls instances of this class, following an Enumerate
operation
Enumerate
public Enumerate()
- Permission Information:
All users permitted to use
method
General Information:
Enumerates the instances of this
class
Release
public Release([IN]String EnumerationContext)
- Permission Information:
All users permitted to use
method
General Information:
Releases an enumeration
context
Subscribe
public Subscribe()
- Permission Information:
No permissions defined
General
Information:
Subscribes to this resource (WS-Eventing)
Unsubscribe
public Unsubscribe()
- Permission Information:
No permissions defined
General
Information:
Remove subscription to this resource
(WS-Eventing)