| 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 |
| CreationTimeStamp | datetime |
| Description | string | A LogEntry may include a timestamp for the entry. | None | TRANSLATABLE= true |
| Description | string |
| Description | string | The Description property provides a textual description of the object. | 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 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. | None | TRANSLATABLE= true |
| ExpirationDate | datetime |
| Description | string | The date and time that the record instance should be deleted. The expiration datetime SHOULD be set when the record is fully populated with record data. The value SHOULD be calculated using the ResultPersistence property of the DiagnosticSettingData class. Once the Expiration Date has been reached, record instances SHOULD be deleted as soon as possible.
If a ResultPersistence value is not provided, records MAY be deleted at any time. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_DiagnosticSettingData.ResultPersistence | None | None |
| Generation | uint64 |
| Description | string | Generation is an optional, monotonically increasing property that may be used to identify a particular generation of the resource represented by this class.
If Generation is supported by the implementation, its value shall not be null.
Except as otherwise specified, a value (including null) of Generation specified at creation time shall be replaced by null if Generation is not supported by the implementation or shall be a, (possibly different), non-null value if the implementation does support Generation.
After creation and if supported, Generation shall be updated, at least once per access, whenever the represented resource is modified, regardless of the source of the modification.
Note: the Generation value only needs to be updated once between references, even if the resource is updated many times. The key point is to assure that it will be different if there have been updates, not to count each update.
Note: unless otherwise specified, the value of Generation within one instance is not required to be coordinated with the value of Generation in any other instance.
Note:the semantics of the instance, (as defined by its creation class), define the underlying resource. That underlying resource may be a collection or aggregation of resources. And, in that case, the semantics of the instance further define when updates to constituent resources also require updates to the Generation of the collective resource. Default behavior of composite aggregations should be to update the Generation of the composite whenever the Generation of a component is updated.
Subclasses may define additional requirements for updates on some or all of related instances.
For a particular instance, the value of Generation may wrap through zero, but the elapsed time between wraps shall be greater than 10's of years.
This class does not require Generation to be unique across instances of other classes nor across instances of the same class that have different keys. Generation shall be different across power cycles, resets, or reboots if any of those actions results in an update. Generation may be different across power cycles, resets, or reboots if those actions do not result in an update. If the Generation property of an instance is non-null, and if any attempt to update the instance includes the Generation property, then if it doesn't match the current value, the update shall fail.
The usage of this property is intended to be further specified by applicable management profiles.
Typically, a client will read the value of this property and then supply that value as input to an operation that modifies the instance in some means. This may be via an explicit parameter in an extrinsic method or via an embedded value in an extrinsic method or intrinsic operation.
For example: a profile may require that an intrinsic instance modification supply the Generation property and that it must match for the modification to succeed. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| HaltOnError | boolean |
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | When this flag is true, the test will halt after finding the first error. | None | TRANSLATABLE= true |
| InstanceID | string |
| Description | string | Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm:
<OrgID>:<LocalID>
Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity creating/defining the InstanceID, or is a registered ID that is assigned to the business entity by a recognized global authority (This is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> MUST NOT contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID MUST appear between <OrgID> and <LocalID>.
<LocalID> is chosen by the business entity and SHOULD not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity MUST assure that the resultant InstanceID is not re-used across any InstanceIDs produced by this or other providers for this instance's NameSpace.
For DMTF defined instances, the 'preferred' algorithm MUST be used with the <OrgID> set to 'CIM'. | None | TRANSLATABLE= true |
| Key | boolean | true | None | OVERRIDABLE= false
|
| Override | string | InstanceID | TOSUBCLASS= false | None |
| Locale | string |
| Deprecated | string | No Value | TOSUBCLASS= false | None |
| Description | string | This property is being deprecated to avoid conflicts with localization implementations using CIM/XML over HTTP protocol, the preferred mechanism.
A locale indicates a particular geographical, political, or cultural region. The Locale specifies the language used in creating the RecordForLog data. If the Locale property is empty, it is assumed that the default locale is en_US (English).
The locale string consists of three sub-strings, separated by underscores:
- The first sub-string is the language code, as specified in ISO639.
- The second sub-string is the country code, as specified in ISO3166.
- The third sub-string is a variant, which is vendor specific.
For example, US English appears as: "en_US_WIN", where the "WIN" variant would specify a Windows browser-specific collation (if one exists). Since the variant is not standardized, it is not commonly used and generally is limited to easily recognizable values ("WIN", "UNIX", "EURO", etc.) used in standard environments. The language and country codes are required; the variant may be empty. | None | TRANSLATABLE= true |
| LogInstanceID | string |
| Description | string | The containing Log's InstanceID. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 256 | None | None |
| LogName | string |
| Description | string | The containing Log's Name. This property is available for backwards continuity with CIM_LogRecord. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 256 | None | None |
| LogOptions | uint16 |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | The LogOptions property lists the log options that were requested for the Diagnostic Service. A brief summary of the various log options can be found in CIM_DiagnosticSetting.LogOptions. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 0x8000 | None | None |
| Values | string | Unknown, Other, Results, Subtests, Actions, Warnings, Status, Device Errors, Service Errors, Setting Data, Statistics, Hardware Configuration, Software Configuration, References, Debug, No Log Options | None | TRANSLATABLE= true |
| LogStorage | uint16 |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | The LogStorage setting property indicates which types of supported storage should be used by the Diagnostic Service for logging of the data specified in LogOptions.
The values are:
"DiagnosticRecordLog" (Value = 2): Use the DiagnosticRecordLog and DiagnosticRecord classes.
"MessageLog" (Value = 4): Use the MessageLog class and its methods.
"File" (Value = 5): Write data to a file. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ValueMap | string | 0, 1, 2, 3, 4 | None | None |
| Values | string | Unknown, Other, DiagnosticRecordLog, MessageLog, File | None | TRANSLATABLE= true |
| LoopControl | uint16 |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | LoopControl, used in conjunction with LoopControlParameter, sets one or more loop control mechanisms that limits the number of times a test should be repeated with a single invocation of RunTest by a CIM client. There is an array-positional correspondence between LoopControl entries & LoopControlParameter entries. The entries in these coupled arrays of loop controls can be used in a logical OR fashion to achieve the desired loop control. For example, if a client wants to loop a test 1000 times, but quit if a timer runs out, it could set both controls into the LoopControl array as two separate entries in each array. The looping test will terminate when the first of the two Ored conditions are met.
A brief description for each loop control can be found in the description of DiagnosticSetting.LoopControl. | None | TRANSLATABLE= true |
| ValueMap | string | 0, 1, 2, 3, 4, 5 | None | None |
| Values | string | Unknown, Other, Continuous, Count, Timer, Error Count | None | TRANSLATABLE= true |
| LoopControlParameter | string |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | Array entries contain parameters corresponding to entries in the LoopControl array, limiting the number of times a test should be repeated with a single invocation of RunTest by a CIM client. | None | TRANSLATABLE= true |
| ManagedElementName | string |
| Description | string | This property SHOULD reflect the value of the underlying ManagedElement.ElementName property. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_ManagedElement.ElementName | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| Message | string |
| Description | string | The formatted message. This message is constructed by combining some or all of the dynamic elements specified in the MessageArguments property with the static elements uniquely identified by the MessageID in a message registry or other catalog associated with the OwningEntity. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_LogEntry.MessageID, CIM_LogEntry.MessageArguments | None | None |
| MessageArguments | string |
| Description | string | An array containing the dynamic content of the message. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_LogEntry.Message, CIM_LogEntry.MessageID | None | None |
| MessageID | string |
| Description | string | A string that uniquely identifies, within the scope of the OwningEntity, the format of the Message. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| ModelCorrespondence | string | CIM_LogEntry.Message, CIM_LogEntry.MessageArguments | None | None |
| OtherLogOptionsDescriptions | string |
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | Provides additional information regarding the types of test messages that are logged when the property LogOptions includes the value 1 ("Other"). | None | TRANSLATABLE= true |
| OtherLogStorageDescriptions | string |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | This property provides additional information for LogStorage when the corresponding value is set to 1 ("Other"). | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| OtherLoopControlDescriptions | string |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | Provides additional information for LoopControl when its value is set to 1 ('Other'). | None | TRANSLATABLE= true |
| OtherRecordTypeDescription | string |
| Description | string | When "Other" (value=1) is entered in the RecordType property, OtherRecordTypeDescription can be used to describe the message type. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_DiagnosticSettingData.OtherLogOptionsDescriptions, CIM_DiagnosticRecord.RecordType | None | None |
| OwningEntity | string |
| Description | string | A string that uniquely identifies the entity that owns the definition of the format of the Message described in this instance. OwningEntity MUST include a copyrighted, trademarked or otherwise unique name that is owned by the business entity or standards body defining the format. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| PerceivedSeverity | uint16 |
| Description | string | An enumerated value that describes the severity of the Indication from the notifier's point of view:
1 - Other, by CIM convention, is used to indicate that the Severity's value can be found in the OtherSeverity property.
3 - Degraded/Warning should be used when its appropriate to let the user decide if action is needed.
4 - Minor should be used to indicate action is needed, but the situation is not serious at this time.
5 - Major should be used to indicate action is needed NOW.
6 - Critical should be used to indicate action is needed NOW and the scope is broad (perhaps an imminent outage to a critical resource will result).
7 - Fatal/NonRecoverable should be used to indicate an error occurred, but it's too late to take remedial action.
2 and 0 - Information and Unknown (respectively) follow common usage. Literally, the Indication is purely informational or its severity is simply unknown. | None | TRANSLATABLE= true |
| Experimental | boolean | true | TOSUBCLASS= false | None |
| MappingStrings | string | Recommendation.ITU|X733.Perceived severity | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7 | None | None |
| Values | string | Unknown, Other, Information, Degraded/Warning, Minor, Major, Critical, Fatal/NonRecoverable | None | TRANSLATABLE= true |
| PercentOfTestCoverage | uint8 |
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | The requested percentage of coverage for the diagnostic service. For example, a hard drive scan test could be asked to run at 50%. Permissible values for this property range from 0 to 100. | None | TRANSLATABLE= true |
| MaxValue | sint64 | 100 | None | None |
| MinValue | sint64 | 0 | None | None |
| PUnit | string | percent | None | None |
| Units | string | Percent | None | TRANSLATABLE= true |
| QuickMode | boolean |
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | When this flag is true, the test software should attempt to run in an accelerated fashion either by reducing the coverage or number of tests performed. | None | TRANSLATABLE= true |
| RecordData | string |
| Description | string | A string containing LogRecord data.
If the corresponding RecordFormat property is <empty>, or cannot be parsed according to the recommended format, RecordData should be interpreted as a free-form string. If the RecordFormat property contains parseable format information (as recommended in the RecordFormat Description qualifier), the RecordData string SHOULD be parsed in accordance with this format. In this case, RecordData SHOULD begin with the delimiter character and this character SHOULD be used to separate substrings in the manner described. The RecordData string can then be parsed by the data consumer and appropriately typed. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_RecordForLog.RecordFormat | None | None |
| RecordFormat | string |
| Description | string | A string describing the data structure of the information in the property, RecordData. If the RecordFormat string is <empty>, RecordData should be interpreted as a free-form string.
To describe the data structure of RecordData, the RecordFormat string should be constructed as follows:
- The first character is a delimiter character and is used to parse the remainder of the string into sub-strings.
- Each sub-string is separated by the delimiter character and should be in the form of a CIM property declaration (i.e., datatype and property name). This set of declarations may be used to interpret the similarly delimited RecordData property.
For example, using a '*' delimiter, RecordFormat = "*string ThisDay*uint32 ThisYear*datetime SomeTime"
may be used to interpret: RecordData = "*This is Friday*2002*20020807141000.000000-300". | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_RecordForLog.RecordData | None | None |
| RecordID | string |
| Description | string | RecordID may be used to provide a representation of log entry ordering or pointers/handles for log entries. | None | TRANSLATABLE= true |
| MaxLen | uint32 | 256 | None | None |
| RecordType | uint16 |
| Description | string | The RecordType property specifies the nature of the data being entered into the ServiceRecord. The value in this property should match one of the values indicated by the DiagnosticSettingData.LogOptions property. A brief summary of the various log options can be found in CIM_DiagnosticSettingData.LogOptions. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_DiagnosticSettingData.LogOptions, CIM_DiagnosticRecord.OtherRecordTypeDescription | None | None |
| ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 | None | None |
| Values | string | Unknown, Other, Results, Subtests, Actions, Warnings, Status, Device Errors, Service Errors, Setting Data, Statistics, Hardware Configuration, Software Configuration, References, Debug | None | TRANSLATABLE= true |
| ResultPersistence | uint32 |
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | The desired length of time to persist the messages that result from execution of a diagnostic service. Here is a summary of the choices and behaviors for different ResultPersistence values:
0 = "No Persistence":
Setting the timer to zero tells the provider not to persist the diagnostic result. The diagnostic information is only available while the diagnostic is executing or at its conclusion.
Value > 0 and < 0xFFFFFFFF = "Persist With TimeOut":
Setting the ResultPersistenceOption to a integer will cause the DiagnosticResult to be persisted for that number of seconds. At the end of that time, the DiagnosticResult may be deleted by the diagnostic service provider.
0xFFFFFFFF = "Persist Forever":
By setting the timeout value to the very large value, 0xFFFFFFFF, the provider shall persist results forever. In this case, the client MUST bear the responsibility for deleting them. | None | TRANSLATABLE= true |
| PUnit | string | second | None | None |
| Units | string | Seconds | None | TRANSLATABLE= true |
| ServiceName | string |
| Description | string | This property should reflect the value of the underlying DiagnosticService.Name property. | None | TRANSLATABLE= true |
| ModelCorrespondence | string | CIM_DiagnosticService.Name | None | None |
| Required | boolean | true | None | OVERRIDABLE= false
|
| VerbosityLevel | uint16 |
| ArrayType | string | Indexed | None | OVERRIDABLE= false
|
| Deprecated | string | CIM_DiagnosticSettingDataRecord.Settings | TOSUBCLASS= false | None |
| Description | string | A client may want to specify the volume or detail of information logged by a diagnostic service. This metric is applied to a corresponding logging option, acting as a qualifier on its description. Three levels of verbosity are defined as follows:
* "Minimum" (value=2): Specified if the least amount of information is desired; for example, Pass or Fail.
* "Standard" (value=3): This is the standard level of messaging provided by the service. It is the form most likely to be used if no verbosity value is specified (default).
* "Full" (value=4): Specified when all information, regardless of size, is desired.
Verbosity may not apply to all LogOptions values, in which case the default VerbosityLevel of "Standard" SHOULD be used. | None | TRANSLATABLE= true |
| ValueMap | string | 2, 3, 4 | None | None |
| Values | string | Minimum, Standard, Full | None | TRANSLATABLE= true |
Copyright © 2008-2010 VMware, Inc. All rights reserved.