Key |
CreationClassName
|
string
|
|
CreationClassName indicates the name of the class or the subclass that is 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. |
Name
|
string
|
|
The Name property uniquely identifies the Service and provides an indication of the function that is managed. This function is described in more detail in the Description property of the object. |
SystemCreationClassName
|
string
|
|
The CreationClassName of the scoping System. |
SystemName
|
string
|
|
The Name of the scoping System. |
Read Only |
Description
|
string
|
|
The Description property provides a textual description of the object. |
EnabledState
|
uint16
|
Unknown | 0 |
Other | 1 |
Enabled | 2 |
Disabled | 3 |
Shutting Down | 4 |
Not Applicable | 5 |
Enabled but Offline | 6 |
In Test | 7 |
Deferred | 8 |
Quiesce | 9 |
Starting | 10 |
DMTF Reserved | 11..32767 |
Vendor Reserved | 32768..65535 |
|
EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states:Enabled (2) indicates that the element is or could be running commands, will process any queued commands, and queues new requests.Disabled (3) indicates that the element will not run commands and will drop any new requests.Shutting Down (4) indicates that the element is in the process of going to a Disabled state.Not Applicable (5) indicates the element does not support being enabled or disabled.Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests.Test (7) indicates that the element is in a test state.Deferred (8)indicates that the element might be completing commands, but will queue any new requests.Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only a restricted set of commands. All other requests are queued.Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. |
OperationalStatus
|
uint16
|
Unknown | 0 |
Other | 1 |
OK | 2 |
Degraded | 3 |
Stressed | 4 |
Predictive Failure | 5 |
Error | 6 |
Non-Recoverable Error | 7 |
Starting | 8 |
Stopping | 9 |
Stopped | 10 |
In Service | 11 |
No Contact | 12 |
Lost Communication | 13 |
Aborted | 14 |
Dormant | 15 |
Supporting Entity in Error | 16 |
Completed | 17 |
Power Mode | 18 |
DMTF Reserved | .. |
Vendor Reserved | 0x8000.. |
|
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 implies 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, providers/instrumentation must provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus will contain the primary status for the element. When instrumented, Status (since it is single-valued) will also provide the primary status of the element. |
OtherEnabledState
|
string
|
|
A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1. |
RequestedState
|
uint16
|
Enabled | 2 |
Disabled | 3 |
Shut Down | 4 |
No Change | 5 |
Offline | 6 |
Test | 7 |
Deferred | 8 |
Quiesce | 9 |
Reboot | 10 |
Reset | 11 |
Not Applicable | 12 |
DMTF Reserved | .. |
Vendor Reserved | 32768..65535 |
|
RequestedState is an integer enumeration that indicates 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 or disabled states. When EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState 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). Reboot refers to doing a"Shut Down"and then moving to an"Enabled"state. Reset indicates that the element is first"Disabled"and then"Enabled". The distinction between requesting"Shut Down"and"Disabled"should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not run 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 can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code.A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used. |
Started
|
boolean
|
|
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). |
StatusDescriptions
|
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. Entries in this array are correlated with those at the same array index in OperationalStatus. |
Read Write |
EnabledDefault
|
uint16
|
Enabled | 2 |
Disabled | 3 |
Not Applicable | 5 |
Enabled but Offline | 6 |
No Default | 7 |
DMTF Reserved | 8..32767 |
Vendor Reserved | 32768..65535 |
|
An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is"Enabled"(value=2). |
PrimaryOwnerContact
|
string
|
|
A string that provides information on how the primary owner of the Service can be reached (for example, phone number, e-mail address, and so on). |
PrimaryOwnerName
|
string
|
|
The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. |
In |
RetrievalWaitSecs
|
uint32
|
|
Optionally specify a time period (in seconds) to wait for the dump file to be retrieved from the node specified above. If the file has not been retrieved within this time period, the timeouterror code (0x8006) will be returned. Passing in 0 for this parameter will cause the method to wait for the retrieval indefinitely. By default, this method does not wait for the file to be retrieved. |
FilePath
|
string
|
|
The fully specified name of the dump file. This must be the name of a file, not a directory and wildcards are not allowed. The list of available dump files can be found by enumerating the IBMTSSVC_Dump class. Dump files must be in one of the following directories on the SVC Cluster: /dumps/configs/, /dumps/elogs/, /dumps/feature/, /dumps/iostats/, /dumps/iotrace/,/home/admin/upgrade/, or /dumps/ |
Node
|
IBMTSSVC_Node
|
|
If a node is passed in this parameter then the dump file will be retrieved from this node, otherwise the dump file is assumed to exist on the config node. |
out |
File
|
string
|
|
The file as a string array. |
Return Codes |
none |