Name | Data Type | Qualifiers |
Name | Data Type | Value | Scope | Flavors |
Caption | string |
Description | string | The Caption property is a short textual description (one- line string) of the object. | None | TRANSLATABLE= true |
MaxLen | uint32 | 64 | None | None |
CreationClassName | string |
Description | 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. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MaxLen | uint32 | 256 | None | None |
DeploymentDescriptor | string |
Description | string | Contains the original XML deployment descriptor that was created for this application during the deployment process. | None | TRANSLATABLE= true |
MappingStrings | string | JSR77.JCP|JSR77.3.5.0.1 deploymentDescriptor|V1.0 | None | None |
Description | string |
Description | string | The Description property provides a textual description of the object. | None | TRANSLATABLE= true |
Distribution | uint16 |
Description | string | Distribution describes how the application system is distributed with respect to its underlying servers. In general, the application system is distributed or local. This property indicates whether the application system is running on one or multiple servers. This can be determined without having to query for associated servers represented by ComputerSystems. Distributed systems also introduce a virtual notion to themselves. Note that a distributed application system is not tangible but virtual. Only its contained local systems can be found as processes or threads, and can therefore be regarded as tangible. The distributed system remains a named, virtual entity, that scopes strongly bound constituents and allows the application to be managed in its entirety.
The property is needed to help root cause analysis and operations, especially when these are automated, in order to clearly know that more than one executed application - most likely the local application systems - is affected by the management task. This is particularly true if the contained application systems provide uniform functionality like webserver or application server farms.
To express constraints between distributed and local system, this class must be derived and appropriate associations must be defined.
This property should not be confused with the Roles[] property defined in System. The latter is reserved for administrator assigned roles. | None | TRANSLATABLE= true |
ValueMap | string | 0, 1, 2, 3..32767, 32768..65535 | None | None |
Values | string | Unknown, Distributed, Local, DMTF Reserved, Vendor Specific | None | TRANSLATABLE= true |
ElementName | string |
Description | string | 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 that ManagedSystemElement's Name property 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 MAY be present in both the Name and ElementName properties. | None | TRANSLATABLE= true |
EnabledDefault | uint16 |
Description | string | An enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is "Enabled" (value=2). | None | TRANSLATABLE= true |
ValueMap | string | 2, 3, 5, 6, 7, 8..32767, 32768..65535 | None | None |
Values | string | Enabled, Disabled, Not Applicable, Enabled but Offline, No Default, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
EnabledState | uint16 |
Description | string | EnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down and starting are transient states between enabled and disabled.
In contrast to the original version defined higher in the inheritance hierarchy (EnabledLogicalElement), EnabledState is simplified. It reflects the notion of an execution status tailored to applications and represents a summary of the original property. It allows simplified and efficient determination of whether the application is started, stopped or in transition between either of these states. The property does not show any errors. Errors MUST be described in MSE.OperationalStatus, and MAY also be described in logs or other data sources.
The mapping to MSE.OperationalStatus is as follows:
ExecutionStatus <- MSE.OperationalStatus
Unknown <- Unknown, No Contact, Lost Communication,
Either of the values <- Other
Enabled (started) <- OK, Degraded, Stressed, Predictive Failure, In Service, Dormant, Supporting Entity in Error, Completed
Enabled or Disabled (Started or Stopped) <- Error, Non-Recoverable Error
Starting <- Starting
Shutting Down (Stopping) <- Stopping
Disabled (Stopped) <- Stopped, Aborted.
The mapping to the original EnabledState property is as follows:
Unknown <- Unknown, Not Applicable
Either of the values <-Other
Enabled <- Enabled, Enabled but Offline, In Test, Deferred, Quiesce
Disabled <- Disabled
ShuttingDown <- ShuttingDown
Starting <- Starting. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.OtherEnabledState | None | None |
Override | string | EnabledState | None | OVERRIDABLE= false
|
ValueMap | string | 0, 2, 3, 4, 10, 11..32767, 32768..65535 | None | None |
Values | string | Unknown, Enabled, Disabled, Shutting Down, Starting, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
InstallDate | datetime |
Description | string | A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|ComponentID|001.5 | None | None |
LastServingStatusUpdate | datetime |
Description | string | The point in time at which the ServingStatus property was last updated. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_ApplicationSystem.ServingStatus | None | None |
Name | string |
Description | string | The name of a J2EE Application. The name MUST be constructed using the form specified in JSR77.3.1.1.1 in order to avoid the need for manual key propagation. | None | TRANSLATABLE= true |
Key | boolean | true | None | OVERRIDABLE= false
|
MappingStrings | string | JSR77.JCP|JSR77.3.1.1.1 objectName|V1.0 | None | None |
MaxLen | uint32 | 256 | None | None |
Override | string | Name | None | OVERRIDABLE= false
|
NameFormat | string |
Description | string | The System object and its derivatives are Top Level Objects of CIM. They provide the scope for numerous components. Having unique System keys is required. A heuristic can be defined in individual System subclasses to attempt to always generate the same System Name Key. The NameFormat property identifies how the System name was generated, using the subclass' heuristic. | None | TRANSLATABLE= true |
MaxLen | uint32 | 64 | None | None |
OtherEnabledState | string |
Description | string | A string describing the element's enabled/disabled state when the EnabledState property is set to 1 ("Other"). This property MUST be set to NULL when EnabledState is any value other than 1. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
PrimaryOwnerContact | string |
Description | string | A string that provides information on how the primary system owner can be reached (e.g. phone number, email address, ...). | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|General Information|001.4 | None | None |
MaxLen | uint32 | 256 | None | None |
Write | boolean | true | None | None |
PrimaryOwnerName | string |
Description | string | The name of the primary system owner. The system owner is the primary user of the system. | None | TRANSLATABLE= true |
MappingStrings | string | MIF.DMTF|General Information|001.3 | None | None |
MaxLen | uint32 | 64 | None | None |
Write | boolean | true | None | None |
RequestedState | uint16 |
Description | string | RequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the element's RequestedState is 5 ("No Change"). Refer to the EnabledState's property Description for explanations of the values in the RequestedState enumeration.
It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). The former, Reboot, refers to doing a "Shut Down" and then moving to an "Enabled" state. The latter, Reset, indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests.
This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_EnabledLogicalElement.EnabledState | None | None |
ValueMap | string | 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, .., 32768..65535 | None | None |
Values | string | Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
ServingStatus | uint16 |
Description | string | ServingStatus is a summary of MSE.OperationalStatus. It allows simplified and efficient determination of whether the application is providing service or has stopped doing so for various reasons like errors, shutdown, abort, etc. Therefore, no transitional values are provided. The property does not show any errors. Errors MUST be described in MSE.OperationalStatus, and MAY also be described in logs or other data sources. Therefore, ServingStatus is suited to provide summary information for monitoring purposes and service level management.
The mapping to MSE.OperationalStatus is as follows:
ServingStatus <- MSE.OperationalStatus
Unknown <- Unknown, No Contact, Lost Communication
Either of the values <- Other
Serving <- OK, Degraded, Stressed, Predictive Failure, Completed
Not Serving <- Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, Aborted, Dormant, Supporting Entity in Error. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus | None | None |
ValueMap | string | 0, 1, 2, 5..4096, 4097..65535 | None | None |
Values | string | Unknown, Serving, Not Serving, DMTF Reserved, Vendor Specific | None | TRANSLATABLE= true |
StartupTime | datetime |
Description | string | The point in time (date and time) when the application system was last started. If the application system is in a state other the state Enabled (i.e., started and running) this value is not meaningful and the property value MUST be set to all zeros.
StartupTime is preferably the point in time when the application is available to the user. Instead, if the provider and/or the instrumentation cannot determine the point in time the application becomes available, the point in time can be used at which the underlying operating system reports successful launch of the application. If no value can be provided the property value MUST be set to all zeros. | None | TRANSLATABLE= true |
Status | string |
Deprecated | string | CIM_ManagedSystemElement.OperationalStatus | TOSUBCLASS= false | None |
Description | string | 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 overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 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. | None | TRANSLATABLE= true |
MaxLen | uint32 | 10 | None | None |
ValueMap | string | OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped | None | None |
TimeOfLastStateChange | datetime |
Description | string | The date/time when the element's EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated. | None | TRANSLATABLE= true |
OperationalStatus | uint16[] |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | Indicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration's values are self- explanatory. However, a few are not and are described in more detail.
"Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, etc.
"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 element's state and configuration may need to be updated.
"Dormant" indicates that the element is inactive or quiesced.
"Supporting Entity in Error" describes that this element may 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 the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error.
"Power Mode" indicates 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 since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/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 (since it is single-valued) SHOULD also provide the primary status of the element. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_ManagedSystemElement.StatusDescriptions | None | None |
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000.. | None | None |
Values | string | 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, DMTF Reserved, Vendor Reserved | None | TRANSLATABLE= true |
Roles | string[] |
Description | string | An array (bag) of strings that specify the administrator -defined roles this System plays in the managed environment. Examples might be 'Building 8 print server' or 'Boise user directories'. A single system may perform multiple roles.
Note that instrumentation's view of a System's 'roles' is defined by instantiating a specific subclass of System and/ or by properties in a subclass. For example, a ComputerSystem's purpose is defined using the Dedicated and OtherDedicatedDescription properties. | None | TRANSLATABLE= true |
Write | boolean | true | None | None |
StatusDescriptions | string[] |
ArrayType | string | Indexed | None | OVERRIDABLE= false
|
Description | string | 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. | None | TRANSLATABLE= true |
ModelCorrespondence | string | CIM_ManagedSystemElement.OperationalStatus | None | None |