ServiceMode
Class IBMTSSVC_MessageLog


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement
      \_CIM_Log
        \_CIM_MessageLog


Description

The message log for a cluster.

Subclasses


Referenced By

IBMTSSVC_UseOfMessageLog

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
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.
Name string
The inherited Name serves as part of the key (a unique identifier) for the MessageLog instance.
Read Only
Capabilities uint16
Unknown0
Other1
Write Record Supported2
Delete Record Supported3
Can Move Backward in Log4
Freeze Log Supported5
Clear Log Supported6
Supports Addressing by Ordinal Record Number7
Variable Length Records Supported8
Variable Formats for Records9
Can Flag Records for Overwrite10
An array of integers indicating the Log capabilities. Information such as"Write Record Supported"(value= 2) or"Variable Length Records Supported"(8) is specified in this property.
CapabilitiesDescriptions string
An array of free-form strings providing more detailed explanations for any of the Log features indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.
Caption string
Max Length64
The Caption property is a short textual description (one-line string) of the object.
CharacterSet uint16
Unknown0
Other1
ASCII2
Unicode3
ISO20224
ISO88595
Extended UNIX Code6
UTF-87
UCS-28
Bitmapped Data9
OctetString10
Defined by Individual Records11
An enumeration describing the character set used to record data in the individual Log entries. For example, the Log records may contain ASCII data (value=2), or be raw octet strings (value=10).
CurrentNumberOfRecords uint64
Current number of records in the Log.
Description string
The Description property provides a textual description of the object.
ElementName 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.The Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. The same property cannot 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.
EnabledState uint16
Unknown0
Other1
Enabled2
Disabled3
Shutting Down4
Not Applicable5
Enabled but Offline6
In Test7
Deferred8
Quiesce9
Starting10
DMTF Reserved11..32767
Vendor Reserved32768..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.
HeaderFormat string
If the SizeOfHeader property is non-zero, this property describes the structure and format of the Log header. It is a free-form string. If the SizeOfHeader property is 0, then the information in this property is undefined.
InstallDate datetime
A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.
IsFrozen boolean
Boolean indicating that the Log is currently frozen and modifications are not allowed.
LastChange uint16
Unknown0
Add1
Delete2
Modify3
Log Cleared4
An enumeration describing the last change to the MessageLog.
MaxLogSize uint64
The maximum size, in bytes, to which the Log can grow. If there is no maximum, then MaxLogSize should be set to 0.
MaxNumberOfRecords uint64
Maximum number of records that can be capturedin the Log. If undefined, a value of zero should be specified.
MaxRecordSize uint64
Maximum size, in bytes, to which an individual Log entry (record) can grow - if the Capabilities array includes a value of 7 ("Variable Length Records Supported"). If the Capabilities array does not include a 7, then the Log only supports fixed length entries. The size of these entries is described by this property.
OperationalStatus uint16
Unknown0
Other1
OK2
Degraded3
Stressed4
Predictive Failure5
Error6
Non-Recoverable Error7
Starting8
Stopping9
Stopped10
In Service11
No Contact12
Lost Communication13
Aborted14
Dormant15
Supporting Entity in Error16
Completed17
Power Mode18
DMTF Reserved..
Vendor Reserved0x8000..
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.
OtherPolicyDescription string
When the OverwritePolicy specifies a value of 1 ("Other"), the Log's behavior can be explained using this property. If OverwritePolicy is not 1, then this property's contents are undefined.
OverwritePolicy uint16
Unknown0
Other1
Wraps When Full2
Clear When Near Full3
Overwrite Outdated When Needed4
Remove Outdated Records5
Overwrite Specific Records6
Never Overwrite7
An enumeration describing the behavior of the Log, when it becomes full or near full. For example, the Log may wrap (value=2) or may simply stop recording entries (value =7).Some of the property's possible values need further explanation:3="Clear When Near Full"indicates that all of the Log's entries will be deleted when a specified record capacity is reached. The capacity is specified in percentage, using the property, PercentageNearFull.'Near Full'may be less than 100% if the Log takes time to clear, and a position should always be available for new records.4="Overwrite Outdated When Needed"describes that Log entries (timestamped later than the date/time specified in the property, TimeWhenOutdated) can be overwritten.5="Remove Outdated Records"specifies that records (timestamped later than the date/time specified in the property, TimeWhenOutdated) are logically and/or physically removed from the Log.6="Overwrite Specific Records"indicates that specially flagged records may be overwritten. This property only makes sense when the Capabilities array includes a value of 10,"Can Flag Records for Overwrite".
PercentageNearFull uint8
If the OverwritePolicy is based on clearing records when the Log is near full (value=3), this property defines the record capacity (in percentage) that is considered to be'near full'.
RecordHeaderFormat string
If the SizeOfRecordHeader property is non-zero, this property describes the structure and format of the record headers. It is a free-form string. If the SizeOfRecordHeader property is 0, then the information in this property is undefined.
RecordLastChanged uint64
When a change is made to the Log, the record number that was modified is captured.
RequestedState uint16
Enabled2
Disabled3
Shut Down4
No Change5
Offline6
Test7
Deferred8
Quiesce9
Reboot10
Reset11
Not Applicable12
DMTF Reserved..
Vendor Reserved32768..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.
SizeOfHeader uint64
The size of the Log header, in bytes, if one is present. If there is no Log header, then this property should be set to 0. Headers may include general information about the Log such as the current number of records, time of last update, or a pointer to the location of the first Log entry. Note that this property is not the size of the header for an individual Log entry. The latter is described by the property, SizeOfRecordHeader.
SizeOfRecordHeader uint64
The size of the header for the Log's individual entries, in bytes, if record headers are defined. If there are no record headers, then this property should be set to 0. Record headers may include information such as the type of the Log entry, the date/time that the entry was last updated, or a pointer to the start of optional data. This property defines the header size for individual records in the Log, while the SizeOfHeader property describes the Log's overall header, typically located at the start ofthe MessageLog.
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.
TimeOfLastChange datetime
When a change is made to the Log, the date/time of that modification is captured. This property could be used to event against any update to the MessageLog.
TimeWhenOutdated datetime
If the OverwritePolicy is based on'outdated'records (values 4 or 5), this property defines when a Log entry is considered to be outdated - either by time interval or at a specific date and time.
Read Write
EnabledDefault uint16
Enabled2
Disabled3
Not Applicable5
Enabled but Offline6
No Default7
DMTF Reserved8..32767
Vendor Reserved32768..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).
 
Inherited from class CIM_ManagedElement
Caption, Description, ElementName
 
Inherited from class CIM_ManagedSystemElement
HealthState, InstallDate, Name, OperationalStatus, Status, StatusDescriptions
 
Inherited from class CIM_EnabledLogicalElement
EnabledState, OtherEnabledState, RequestedState, TimeOfLastStateChange, EnabledDefault
 
Inherited from class CIM_Log
CurrentNumberOfRecords, MaxNumberOfRecords, OverwritePolicy
 
Inherited from class CIM_MessageLog
Capabilities, CapabilitiesDescriptions, CharacterSet, HeaderFormat, IsFrozen, LastChange, MaxLogSize, MaxRecordSize, OtherPolicyDescription, OverwritePolicy, PercentageNearFull, RecordHeaderFormat, RecordLastChanged, SizeOfHeader, SizeOfRecordHeader, TimeOfLastChange, TimeWhenOutdated
 

Method Summary

NameDescription
CancelIterationRequests that an iteration of the Log, identified by the IterationIdentifier input parameter, be stopped.
ClearLogRequests that the Log be cleared of all entries.
DeleteRecordRequests that the record indicated by the IterationIdentifier be deleted from the MessageLog.
FixRecordFixes one SVC log entry.
FlagRecordForOverwriteRequests that the record indicated by the IterationIdentifier be flagged as overwriteable.
GetAllRecordsThis command can be used to retrieve error records.
GetRecordRequests that the record indicated by the IterationIdentifier be retrieved from the MessageLog.
ModifyErrorSettingsModifies the error notifications methods for the SVC.
PositionAtRecordRequests that the Log's iteration identifier be advanced or retreated a specific number of records, or set to the entry at a specified numeric location.
PositionToFirstRecordRequests that an iteration of the MessageLog be established and that the iterator be set to the first entry in the Log.
UnFixRecordUnFixes one SVC log entry that has previously been fixed.
WriteRecordRequests that a record be inserted at the Log position indicated by the IterationIdentifier.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 
Inherited from class CIM_Log
ClearLog
 
Inherited from class CIM_MessageLog
CancelIteration, DeleteRecord, FlagRecordForOverwrite, FreezeLog, GetRecord, PositionAtRecord, PositionToFirstRecord, WriteRecord
 

Method Detail


CancelIteration

Description

Requests that an iteration of the Log, identified by the IterationIdentifier input parameter, be stopped. The return value from CancelIteration should be 0 if the request was successfully run, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
IterationIdentifier string
An identifier for the iterator.
out
none
Return Codes
none

ClearLog

Description

Requests that the Log be cleared of all entries.The return value should be 0 if the request was successfully run, 1 if the request is not supported, and some other value, as indicated by the ValueMap/Values qualifiers, if an error occurred.

Parameters

IdTypeRangeDescription
In
none
out
none
Return Codes
none

DeleteRecord

Description

Requests that the record indicated by the IterationIdentifier be deleted from the MessageLog. After deletion, the Iteration Identifier may be advanced to the next record by setting the PositionToNext input parameter to TRUE. If set to FALSE, then the IterationIdentifier will be positioned at the previous record. Two output parameters are defined for the method - RecordData which holds the contents of the deleted Log entry (as an array of bytes that can be recast to an appropriate format or discarded), and RecordNumber which returns the current record number addressed via the IterationIdentifier. The RecordNumber parameter is only defined/valid when the Capabilities array indicates that ordinal record number addressing is supported (a value of 7).IterationIdentifier is defined as an Input/Output method parameter to allow the Log to embed state information in the Identifier and potentially let the identifier be maintained by the using application.The return value from DeleteRecord should be 0 if the request was successfully run, 1 if the request is not supported, and some other value if an error occurred. If the request is not supported, check the Capabilities array that a value of 3 ("Delete Record Supported") is specified.Note: In a subclass, the set of possible return codes could be described using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
IterationIdentifier string
An identifier for the iterator.
PositionToNext boolean
Boolean that when set to TRUE requests the IterationIdentifier to be advanced to the next record, after the current entry is deleted. If set to FALSE, IterationIdentifier is set to the previous record.
RecordNumber uint64
The record number.
RecordData uint8
The record data.
out
IterationIdentifier string
An identifier for the iterator.
RecordNumber uint64
The record number.
RecordData uint8
The record data.
Return Codes
none

FixRecord

Description

Fixes one SVC log entry.

Parameters

IdTypeRangeDescription
In
RecordNumber uint64
The record to be fixed.
out
none
Return Codes
none

FlagRecordForOverwrite

Description

Requests that the record indicated by the IterationIdentifier be flagged as overwriteable. This method is only supported when the Capabilities array includes a value of 10,"Can Flag Records for Overwrite". After updating the entry, the IterationIdentifier may be advanced to the next record by setting the PositionToNext input parameter to TRUE. One output parameter is defined for the method RecordNumber. It returns the current record number addressed via the Iteration Identifier. This parameter is only defined/valid when the Capabilities array indicates that ordinal record number addressing is supported (a value of 7).IterationIdentifier is defined as an Input/Output method parameter to allow the Log to embed state information in the Identifier and potentially let the identifier be maintained by the using application.The return value from FlagRecordForOverwrite should be 0 if the request was successfully run, 1 if the request is not supported, and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
IterationIdentifier string
An identifier for the iterator.
PositionToNext boolean
Boolean indicating that the Iteration Identifier should be advanced to the next record, after updating the current Log entry.
RecordNumber uint64
The record number.
out
IterationIdentifier string
An identifier for the iterator.
RecordNumber uint64
The record number.
Return Codes
none

GetAllRecords

Description

This command can be used to retrieve error records. It can also retrieve config records depending on the input parameters.

Parameters

IdTypeRangeDescription
In
Records string
The file as a string array.
ErrorOnly boolean
Optionally specifies if only error records are returned (when true).
out
Records string
The file as a string array.
Return Codes
none

GetRecord

Description

Requests that the record indicated by the IterationIdentifier be retrieved from the MessageLog. After retrieval, the IterationIdentifier may be advanced to the next record by setting the PositionToNext input parameter to TRUE. Two output parameters are defined for the method - RecordData which holds the contents of the Log entry (as an array of bytes that can be recast to an appropriate format), and RecordNumber which returns the current record number addressed via the Iteration Identifier. The RecordNumber parameter is only defined/valid when the Capabilities array indicates that ordinal record number addressing is supported (a value of 7).IterationIdentifier is defined as an Input/Output method parameter to allow the Log to embed state information in the Identifier and potentially let the identifier be maintained by the using application.The return value from GetRecord should be 0 if the request was successfully run, 1 if the request is not supported, and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
IterationIdentifier string
An identifier for the iterator.
PositionToNext boolean
Boolean indicating that the Iteration Identifier should be advanced to the next record, after retrieving the current Log entry.
RecordNumber uint64
The record number.
RecordData uint8
The record data.
out
IterationIdentifier string
An identifier for the iterator.
RecordNumber uint64
The record number.
RecordData uint8
The record data.
Return Codes
none

ModifyErrorSettings

Description

Modifies the error notifications methods for the SVC.

Parameters

IdTypeRangeDescription
In
EmailAddress string
specifies the email address to send email notification to.
EmailAlert string
specifies the email setting. for example, when to raise an email notification"all"= raise email for all errors logged"no_state"= raise email for errors but not object state changes"none"= don't raise email for any errors (default cluster setting)
SNMPCommunity string
specifies the SNMP community string.
SNMPManagerIP string
specifies the IPv4 address(es) of the host system running the SNMP manager software.
SNMPTrap string
specifies the SNMP trap setting. for example, when to raise a trap. Allowed values:"all"= raise SNMP for all errors logged"no_state"= raise SNMP for errors but not object state changes"none"= don't raise SNMP for any errors (default cluster setting)
out
none
Return Codes
none

PositionAtRecord

Description

Requests that the Log's iteration identifier be advanced or retreated a specific number of records, or set to the entry at a specified numeric location. These two different behaviors are accomplished using the input parameters of the method. Advancing or retreating is achieved by setting the MoveAbsolute boolean to FALSE, and then specifying the number of entries to advance or retreat as positive or negative values in the RecordNumber parameter. Moving to a specific record numberis accomplished by setting the MoveAbsolute input parameter to TRUE, and then placing the record number into the RecordNumber parameter. This can only be done if the Capabilities array includes a value of 7,"Supports Addressing by Ordinal Record Number".After the method completes and if ordinal record numbers are supported (the Capabilities array includes a 7), the current record number is returned in the RecordNumber output parameter. Otherwise, the value of the parameter is undefined.IterationIdentifier is defined as an Input/Output method parameter to allow the Log to embed state information in the Identifier and potentially let the identifier be maintained by the using application.The return value from PositionAtRecord should be 0 if the request was successfully run, 1 if the request is not supported and some other value if an error occurred. If the request is not supported, check the Capabilities array regarding support for ordinal record number addressing and backward movement in the Log (values 7 and 4, respectively).Note: In a subclass, the set of possible return codes could be described using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
IterationIdentifier string
An identifier for the iterator.
MoveAbsolute boolean
Advancing or retreating the IterationIdentifier is achieved by setting the MoveAbsolute boolean to FALSE, and specifying the number of entries to advance or retreat as positive or negative values in the RecordNumber parameter. Moving to a specific record number is accomplished by setting the MoveAbsolute parameter to TRUE, and placing the record number into the RecordNumber parameter.
RecordNumber sint64
The relative or absolute record number.
out
IterationIdentifier string
An identifier for the iterator.
RecordNumber sint64
The relative or absolute record number.
Return Codes
none

PositionToFirstRecord

Description

Requests that an iteration of the MessageLog be established and that the iterator be set to the first entry in the Log. An identifier for the iterator is returned as an output parameter of the method.Regarding iteration, you have 2 choices: 1) Embed iteration data in the method call, and allow implementations to track/ store this data manually; or, 2) Iterate using a separate object (for example, class ActiveIterator) as an iteration agent. The first approach is used here for interoperability. The second requires an instance of the Iterator object for EACH iteration in progress. 2's function could be implemented underneath 1.The return value from PositionToFirstRecord should be 0 if the request was successfully run, 1 if the request is not supported and some other value if an error occurred. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
IterationIdentifier string
An identifier for the iterator.
out
IterationIdentifier string
An identifier for the iterator.
Return Codes
none

UnFixRecord

Description

UnFixes one SVC log entry that has previously been fixed.

Parameters

IdTypeRangeDescription
In
RecordNumber uint64
The record to be unfixed.
out
none
Return Codes
none

WriteRecord

Description

Requests that a record be inserted at the Log position indicated by the IterationIdentifier.The entry's data is provided in the RecordData input parameter. After insertion, the IterationIdentifier may be advanced to the next record by setting the PositionToNext input parameter to TRUE. The output parameter, RecordNumber, returns the current record number addressed via the IterationIdentifier. This parameter is only defined/valid when the Capabilities array indicates that ordinal record number addressing is supported (a value of 7).IterationIdentifier is defined as an Input/Output method parameter to allow the Log to embed state information in the Identifier and potentially let the identifier be maintained by the using application.The return value from WriteRecord should be 0 if the request was successfully run, 1 if the request is not supported, and some other value if an error occurred. If the request is not supported, check the Capabilities array that a value of 2 ("Write Record Supported") is specified.Note: In a subclass, the set of possible return codes could be described using a ValueMap qualifier on the method. The strings to which the ValueMap contents are'translated'may also be specified in the subclass as a Values array qualifier.

Parameters

IdTypeRangeDescription
In
IterationIdentifier string
An identifier for the iterator.
PositionToNext boolean
Boolean indicating that the Iteration Identifier should be advanced to the next record, after writing the Log entry.
RecordData uint8
The record data.
RecordNumber uint64
The record number.
out
IterationIdentifier string
An identifier for the iterator.
RecordNumber uint64
The record number.
Return Codes
none