CIM211 Class Declaration
CIM_PhysicalTape

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_PhysicalTape --> CIM_PhysicalMedia --> CIM_PhysicalComponent --> CIM_PhysicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_PhysicalMedia
NAMECIM_PhysicalTape

Class Qualifiers

Class CIM_PhysicalTape Qualifiers
NameTypeValueFrom Class
Versionstring2.6.0 CIM_PhysicalTape
DescriptionstringThe PhysicalTape class represents additional data for a Tape Media. Information on the tape length and whether it must be unloaded from BOT are properties of this class. CIM_PhysicalTape
DescriptionstringThe PhysicalMedia class represents any type of documentation or storage medium, such as tapes, CDROMs, etc. This class is typically used to locate and manage Removable Media (versus Media sealed with the MediaAccessDevice, as a single Package, as is the case with hard disks). However, ’ sealed ’ Media can also be modeled using this class, where the Media would then be associated with the PhysicalPackage using the PackagedComponent relationship. CIM_PhysicalMedia
DescriptionstringThe PhysicalComponent class represents any low-level or basic Component within a Package. A Component object either can not or does not need to be decomposed into its constituent parts. For example, an ASIC (or Chip) can not be further decomposed. A tape for data storage (PhysicalMedia) does not need to be decomposed. Any PhysicalElement that is not a Link, Connector, or Package is a descendent (or member) of this class. For example, the UART chipset on an internal modem Card would be a subclass (if additional properties or associations are defined) or an instance of PhysicalComponent. CIM_PhysicalComponent
DescriptionstringSubclasses 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. CIM_PhysicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
TapeLengthreal32 Description
Units
CIM_PhysicalTape
UnloadAnywhereboolean Description CIM_PhysicalTape
Capacityuint64 Description
Units
CIM_PhysicalMedia
MediaTypeuint16 Description
ValueMap
Values
ModelCorrespondence
CIM_PhysicalMedia
MediaDescriptionstring Description
ModelCorrespondence
CIM_PhysicalMedia
WriteProtectOnboolean Description CIM_PhysicalMedia
CleanerMediaboolean Description CIM_PhysicalMedia
MediaSizereal32 Description
Units
CIM_PhysicalMedia
MaxMountsuint64 Description CIM_PhysicalMedia
MountCountuint64 Description
Counter
ModelCorrespondence
CIM_PhysicalMedia
DualSidedboolean Description CIM_PhysicalMedia
PhysicalLabelsstring[] Description
ArrayType
ModelCorrespondence
CIM_PhysicalMedia
LabelStatesuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_PhysicalMedia
LabelFormatsuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_PhysicalMedia
TimeOfLastMountdatetime Description CIM_PhysicalMedia
TotalMountTimeuint64 Description
Units
CIM_PhysicalMedia
RemovalConditionsuint162 Description
ValueMap
Values
CIM_PhysicalComponent
Removableboolean Deprecated
Description
CIM_PhysicalComponent
Replaceableboolean Deprecated
Description
CIM_PhysicalComponent
HotSwappableboolean Deprecated
Description
CIM_PhysicalComponent
Tagstring Key
Description
MaxLen
CIM_PhysicalElement
Descriptionstring Override
Description
MappingStrings
CIM_PhysicalElement
CreationClassNamestring Key
Description
MaxLen
CIM_PhysicalElement
ElementNamestring Override
MappingStrings
Description
CIM_PhysicalElement
Manufacturerstring Description
MaxLen
MappingStrings
CIM_PhysicalElement
Modelstring Description
MaxLen
MappingStrings
CIM_PhysicalElement
SKUstring Description
MaxLen
CIM_PhysicalElement
SerialNumberstring Description
MaxLen
MappingStrings
CIM_PhysicalElement
Versionstring Description
MaxLen
MappingStrings
CIM_PhysicalElement
PartNumberstring Description
MaxLen
MappingStrings
CIM_PhysicalElement
OtherIdentifyingInfostring Write
Description
MappingStrings
CIM_PhysicalElement
PoweredOnboolean Description CIM_PhysicalElement
ManufactureDatedatetime Description CIM_PhysicalElement
VendorEquipmentTypestring Description
MappingStrings
CIM_PhysicalElement
UserTrackingstring Write
Description
MappingStrings
CIM_PhysicalElement
CanBeFRUedboolean Description
MappingStrings
CIM_PhysicalElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
Namestring Description
MaxLen
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
HealthStateuint16 Description
ValueMap
Values
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement

Property Qualifiers

Property TapeLength Qualifiers
NameTypeValueFrom Class
DescriptionstringThe physical length of the Tape in feet. CIM_PhysicalTape
UnitsstringFeet CIM_PhysicalTape

Property UnloadAnywhere Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean set to TRUE if the Tape can be unloaded at any position on the Media. It is set to FALSE if the tape must be at a certain position for unload - such as at the beginning of tape (BOT) area, or at mid-tape point for TapeDrives with mid-tape load. CIM_PhysicalTape

Property Capacity Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of bytes that can be read from or written to a Media. This property is not applicable to " Hard Copy " (documentation) or cleaner Media. Data compression should not be assumed, as it would increase the value in this property. For tapes, it should be assumed that no filemarks or blank space areas are recorded on the Media. CIM_PhysicalMedia
UnitsstringBytes CIM_PhysicalMedia

Property MediaType Qualifiers
NameTypeValueFrom Class
DescriptionstringSpecifies the type of the PhysicalMedia, as an enumerated integer. The MediaDescription property is used to provide more explicit definition of the Media type, whether it is pre-formatted, compatability features, etc. CIM_PhysicalMedia
ValueMapstring
[See below.]
CIM_PhysicalMedia
ValuesstringUnknown
Other
Tape Cartridge
QIC Cartridge
AIT Cartridge
DTF Cartridge
DAT Cartridge
8mm Tape Cartridge
19mm Tape Cartridge
DLT Cartridge
Half-Inch Magnetic Tape Cartridge
Cartridge Disk
JAZ Disk
ZIP Disk
SyQuest Disk
Winchester Removable Disk
CD-ROM
CD-ROM/XA
CD-I
CD Recordable
WORM
Magneto-Optical
DVD
DVD-RW+
DVD-RAM
DVD-ROM
DVD-Video
Divx
Floppy/Diskette
Hard Disk
Memory Card
Hard Copy
Clik Disk
CD-RW
CD-DA
CD+
DVD Recordable
DVD-RW
DVD-Audio
DVD-5
DVD-9
DVD-10
DVD-18
Magneto-Optical Rewriteable
Magneto-Optical Write Once
Magneto-Optical Rewriteable (LIMDOW)
Phase Change Write Once
Phase Change Rewriteable
Phase Change Dual Rewriteable
Ablative Write Once
Near Field Recording
MiniQic
Travan
8mm Metal Particle
8mm Advanced Metal Evaporate
NCTP
LTO Ultrium
LTO Accelis
9 Track Tape
18 Track Tape
36 Track Tape
Magstar 3590
Magstar MP
D2 Tape
Tape - DST Small
Tape - DST Medium
Tape - DST Large
CIM_PhysicalMedia
ModelCorrespondencestringCIM_PhysicalMedia.MediaDescription CIM_PhysicalMedia

NameValue
0Unknown
1Other
2Tape Cartridge
3QIC Cartridge
4AIT Cartridge
5DTF Cartridge
6DAT Cartridge
78mm Tape Cartridge
819mm Tape Cartridge
9DLT Cartridge
10Half-Inch Magnetic Tape Cartridge
11Cartridge Disk
12JAZ Disk
13ZIP Disk
14SyQuest Disk
15Winchester Removable Disk
16CD-ROM
17CD-ROM/XA
18CD-I
19CD Recordable
20WORM
21Magneto-Optical
22DVD
23DVD-RW+
24DVD-RAM
25DVD-ROM
26DVD-Video
27Divx
28Floppy/Diskette
29Hard Disk
30Memory Card
31Hard Copy
32Clik Disk
33CD-RW
34CD-DA
35CD+
36DVD Recordable
37DVD-RW
38DVD-Audio
39DVD-5
40DVD-9
41DVD-10
42DVD-18
43Magneto-Optical Rewriteable
44Magneto-Optical Write Once
45Magneto-Optical Rewriteable (LIMDOW)
46Phase Change Write Once
47Phase Change Rewriteable
48Phase Change Dual Rewriteable
49Ablative Write Once
50Near Field Recording
51MiniQic
52Travan
538mm Metal Particle
548mm Advanced Metal Evaporate
55NCTP
56LTO Ultrium
57LTO Accelis
589 Track Tape
5918 Track Tape
6036 Track Tape
61Magstar 3590
62Magstar MP
63D2 Tape
64Tape - DST Small
65Tape - DST Medium
66Tape - DST Large
Property MediaDescription Qualifiers
NameTypeValueFrom Class
DescriptionstringAdditional detail related to the MediaType enumeration. For example, if value 3 ( " QIC Cartridge " ) is specified, this property could indicate whether the tape is wide or 1/4 inch, whether it is pre-formatted, whether it is Travan compatible, etc. CIM_PhysicalMedia
ModelCorrespondencestringCIM_PhysicalMedia.MediaType CIM_PhysicalMedia

Property WriteProtectOn Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean specifying whether the Media is currently write protected by some kind of physical mechanism, such as a protect tab on a floppy diskette. CIM_PhysicalMedia

Property CleanerMedia Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean indicating that the PhysicalMedia is used for cleaning purposes and not data storage. CIM_PhysicalMedia

Property MediaSize Qualifiers
NameTypeValueFrom Class
DescriptionstringSize of the Media in inches. For example, ’ 3.5 ’ would be entered for a 3.5 inch disk, or ’ 12 ’ would be entered for a 12 inch optical disk. On the other hand, ’ 0.5 ’ would be defined for a 1/2 inch tape. CIM_PhysicalMedia
UnitsstringInches CIM_PhysicalMedia

Property MaxMounts Qualifiers
NameTypeValueFrom Class
DescriptionstringFor removable Media, the maximum number of times that the Media can be mounted before it should be retired. For cleaner Media, this is the maximum number of Drive cleans that can be performed. For nonremovable Media, such as hard disks, this property is not applicable and should be set to 0. CIM_PhysicalMedia

Property MountCount Qualifiers
NameTypeValueFrom Class
DescriptionstringFor removable or cleaner Media, the number of times that the Media has been mounted for data transfer or to clean a Drive. For nonremovable Media, such as hard disks, this property is not applicable and should be set to 0. CIM_PhysicalMedia
Counterbooleantrue CIM_PhysicalMedia
ModelCorrespondencestringCIM_PhysicalMedia.MaxMounts CIM_PhysicalMedia

Property DualSided Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean indicating that the Media has two recording sides (TRUE) or only a single side (FALSE). Examples of dual sided Media include DVD-ROM and some optical disks. Examples of single sided Media are tapes and CD-ROM. CIM_PhysicalMedia

Property PhysicalLabels Qualifiers
NameTypeValueFrom Class
DescriptionstringOne or more strings on ’ labels ’ on the PhysicalMedia. The format of the labels and their state (readable, unreadable, upside-down) are indicated in the LabelFormats and LabelStates array properties. CIM_PhysicalMedia
ArrayTypestringIndexed CIM_PhysicalMedia
ModelCorrespondencestringCIM_PhysicalMedia.LabelStates
CIM_PhysicalMedia.LabelFormats
CIM_PhysicalMedia

Property LabelStates Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of enumerated integers describing the states of each of the labels on a PhysicalMedia. The Labels themselves are listed in the PhysicalLabels property. Note, each entry of this array is related to the entry in PhysicalLabels that is located at the same index. CIM_PhysicalMedia
ValueMapstring
[See below.]
CIM_PhysicalMedia
ValuesstringOK/Readable
Unreadable
Upside Down
CIM_PhysicalMedia
ArrayTypestringIndexed CIM_PhysicalMedia
ModelCorrespondencestringCIM_PhysicalMedia.PhysicalLabels CIM_PhysicalMedia

NameValue
0OK/Readable
1Unreadable
2Upside Down
Property LabelFormats Qualifiers
NameTypeValueFrom Class
DescriptionstringAn array of enumerated integers describing the formats of each of the labels on a PhysicalMedia. The Labels themselves are listed in the PhysicalLabels property. Note, each entry of this array is related to the entry in PhysicalLabels that is located at the same index. CIM_PhysicalMedia
ValueMapstring
[See below.]
CIM_PhysicalMedia
ValuesstringBarcode
Radio Frequency Identification
OCR (Optical Character Recognition)
MICR (Magnetic Ink Character Recognition)
7 Character Barcode
9 Character Barcode
CIM_PhysicalMedia
ArrayTypestringIndexed CIM_PhysicalMedia
ModelCorrespondencestringCIM_PhysicalMedia.PhysicalLabels CIM_PhysicalMedia

NameValue
0Barcode
1Radio Frequency Identification
2OCR (Optical Character Recognition)
3MICR (Magnetic Ink Character Recognition)
47 Character Barcode
59 Character Barcode
Property TimeOfLastMount Qualifiers
NameTypeValueFrom Class
DescriptionstringFor removable or cleaner Media, the date and time that the Media was last mounted. For nonremovable Media, such as hard disks, this property has no meaning and is not applicable. CIM_PhysicalMedia

Property TotalMountTime Qualifiers
NameTypeValueFrom Class
DescriptionstringFor removable or cleaner Media, the total time (in seconds) that the Media has been mounted for data transfer or to clean a Drive. For nonremovable Media, such as hard disks, this property is not applicable and should be set to 0. CIM_PhysicalMedia
UnitsstringSeconds CIM_PhysicalMedia

Property RemovalConditions Qualifiers
NameTypeValueFrom Class
DescriptionstringThe RemovalCapabilites property is used to describe the conditions under which a PhysicalPackage can be removed. Since all PhysicalPackages are not removable, this property defaults to 2, ’ Not Applicable ’ . CIM_PhysicalComponent
ValueMapstring
[See below.]
CIM_PhysicalComponent
ValuesstringUnknown
Not Applicable
Removable when off
Removable when on or off
CIM_PhysicalComponent

NameValue
0Unknown
2Not Applicable
3Removable when off
4Removable when on or off
Property Removable Qualifiers
NameTypeValueFrom Class
DescriptionstringThe use of this property is being deprecated. Instead RemovalConditions should be used. The RemovalConditions property addresses whether a PhysicalComponent is removable with or without power being applied. A PhysicalComponent 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 both Removable and HotSwappable. For example, an upgradeable Processor chip is Removable. CIM_PhysicalComponent

Property Replaceable Qualifiers
NameTypeValueFrom Class
DescriptionstringThe use of this property is being deprecated because it is redundant with the FRU class and its associations. A PhysicalComponent is Replaceable if it is possible to replace (FRU or upgrade) the Element with a physically different one. For example, some ComputerSystems 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. CIM_PhysicalComponent

Property HotSwappable Qualifiers
NameTypeValueFrom Class
DescriptionstringThe use of this property is being deprecated. Instead RemovalConditions should be used. The RemovalConditions property addresses whether a PhysicalComponent is removable with or without power being applied. A PhysicalComponent is HotSwappable if it is possible to replace the Element with a physically different but equivalent one while the containing Package has power applied to it (ie, is ’ on ’ ). For example, a fan Component may be designed to be HotSwappable. All HotSwappable Components are inherently Removable and Replaceable. CIM_PhysicalComponent

Property Tag Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PhysicalElement
DescriptionstringAn 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. CIM_PhysicalElement
MaxLenuint32256 CIM_PhysicalElement

Property Description Qualifiers
NameTypeValueFrom Class
OverridestringDescription CIM_PhysicalElement
DescriptionstringA textual description of the PhysicalElement. CIM_PhysicalElement
MappingStringsstringMIF.DMTF|FRU|003.3 CIM_PhysicalElement

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_PhysicalElement
DescriptionstringCreationClassName 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. CIM_PhysicalElement
MaxLenuint32256 CIM_PhysicalElement

Property ElementName Qualifiers
NameTypeValueFrom Class
OverridestringElementName CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalName CIM_PhysicalElement
DescriptionstringA 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 that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed 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. CIM_PhysicalElement

Property Manufacturer Qualifiers
NameTypeValueFrom Class
DescriptionstringThe 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. CIM_PhysicalElement
MaxLenuint32256 CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalMfgName
MIF.DMTF|FRU|003.4
CIM_PhysicalElement

Property Model Qualifiers
NameTypeValueFrom Class
DescriptionstringThe name by which the PhysicalElement is generally known. CIM_PhysicalElement
MaxLenuint32256 CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalDescr
MIF.DMTF|FRU|003.5
CIM_PhysicalElement

Property SKU Qualifiers
NameTypeValueFrom Class
DescriptionstringThe stock-keeping unit number for this PhysicalElement. CIM_PhysicalElement
MaxLenuint3264 CIM_PhysicalElement

Property SerialNumber Qualifiers
NameTypeValueFrom Class
DescriptionstringA manufacturer-allocated number used to identify the Physical Element. CIM_PhysicalElement
MaxLenuint32256 CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalSerialNum
MIF.DMTF|FRU|003.7
CIM_PhysicalElement

Property Version Qualifiers
NameTypeValueFrom Class
DescriptionstringA string that indicates the version of the PhysicalElement. CIM_PhysicalElement
MaxLenuint3264 CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalHardwareRev
MIF.DMTF|FRU|003.8
CIM_PhysicalElement

Property PartNumber Qualifiers
NameTypeValueFrom Class
DescriptionstringThe part number assigned by the organization that is responsible for producing or manufacturing the PhysicalElement. CIM_PhysicalElement
MaxLenuint32256 CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalModelName CIM_PhysicalElement

Property OtherIdentifyingInfo Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_PhysicalElement
DescriptionstringOtherIdentifyingInfo 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. CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalAlias CIM_PhysicalElement

Property PoweredOn Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean that indicates whether the PhysicalElement is powered on (TRUE) or is currently off (FALSE). CIM_PhysicalElement

Property ManufactureDate Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date that this PhysicalElement was manufactured. CIM_PhysicalElement

Property VendorEquipmentType Qualifiers
NameTypeValueFrom Class
DescriptionstringA vendor-specific hardware type for the PhysicalElement. It describes the specific equipment type for the element, as defined by the vendor or manufacturer. CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalVendorType CIM_PhysicalElement

Property UserTracking Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_PhysicalElement
DescriptionstringUser-assigned and writeable asset-tracking identifier for the PhysicalElement. CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalAssetID CIM_PhysicalElement

Property CanBeFRUed Qualifiers
NameTypeValueFrom Class
DescriptionstringBoolean that indicates whether this PhysicalElement can be FRUed (TRUE) or not (FALSE). CIM_PhysicalElement
MappingStringsstringMIB.IETF|Entity-MIB.entPhysicalIsFRU CIM_PhysicalElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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. 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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
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
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings 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. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property HealthState Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates 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. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF Reserved
CIM_ManagedSystemElement

NameValue
0Unknown
5OK
10Degraded/Warning
15Minor failure
20Major failure
25Critical failure
30Non-recoverable error
..DMTF Reserved
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA 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 that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed 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. CIM_ManagedElement

Methods

Method Qualifiers

Parameters

Parameter Qualifiers

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_RealizesTapePartitionCIM_PhysicalTapeAntecedent
CIM_HomeForMediaCIM_PhysicalMediaDependent
CIM_PhysicalMediaInLocationCIM_PhysicalMediaDependent
CIM_MemoryWithMediaCIM_PhysicalMediaDependent
CIM_RealizesPExtentCIM_PhysicalMediaAntecedent
CIM_RealizedOnSideCIM_PhysicalMediaAntecedent
CIM_RealizesAggregatePExtentCIM_PhysicalMediaAntecedent
CIM_RealizesDiskPartitionCIM_PhysicalMediaAntecedent
CIM_PackagedComponentCIM_PhysicalComponentPartComponent
CIM_RealizesExtentCIM_PhysicalComponentAntecedent
CIM_ProductPhysicalComponentCIM_PhysicalElementPartComponent
CIM_ContainerCIM_PhysicalElementPartComponent
CIM_ElementsLinkedCIM_PhysicalElementDependent
CIM_RealizesCIM_PhysicalElementAntecedent
CIM_SystemPackagingCIM_PhysicalElementAntecedent
CIM_DoorAccessToPhysicalElementCIM_PhysicalElementDependent
CIM_ProductPhysicalElementsCIM_PhysicalElementComponent
CIM_PhysicalStatisticsCIM_PhysicalElementElement
CIM_ElementCapacityCIM_PhysicalElementElement
CIM_ElementFRUCIM_PhysicalElementReplaceableElement
CIM_ElementHasBeenFRUedCIM_PhysicalElementReplacedElement
CIM_ElementHasBeenFRUedCIM_PhysicalElementReplacementElement
CIM_PhysicalElementLocationCIM_PhysicalElementElement
CIM_FRUPhysicalElementsCIM_PhysicalElementComponent
CIM_ParticipatesInSetCIM_PhysicalElementElement
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_CredentialContextCIM_ManagedElementElementProvidingContext
CIM_DefaultElementCapabilitiesCIM_ManagedElementManagedElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_RelatedElementCausingErrorCIM_ManagedElementDependent
CIM_RelatedElementCausingErrorCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementAntecedent
CIM_SparedCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_IsSpareCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SWRManageableAspectCIM_ManagedElementSystemElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_OwningCollectionElementCIM_ManagedElementOwningElement
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement
CIM_AuthorizationRuleAppliesToTargetCIM_ManagedElementManagedElement
CIM_RoleLimitedToTargetCIM_ManagedElementTargetElement
CIM_StatisticsCIM_ManagedElementElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ManagementSAPCIM_ManagedElementManagedElement