cim_diagnosticsetting.mof

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

          "the diagnostic result. The diagnostic information is only "
          "available while the diagnostic is executing or at its "
          "conclusion. \n"
          "Value > 0 and < 0xFFFFFFFF = \"Persist With TimeOut\": \n"
          "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. \n"
          "0xFFFFFFFF = \"Persist Forever\": \n"
          "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."), 
       Units ( "Seconds" )]
   uint32 ResultPersistence;

      [Write, Description (
          "The LogOptions property is used to specify the types of "
          "data that SHOULD be logged by the diagnostic service. Any "
          "number of values may be specified in the array. Note that "
          "the default behavior is for nothing to be logged. \n"
          "The AMOUNT of data to be logged can be controlled for each "
          "value selected by specifying a VerbosityLevel value. "
          "Verbosity may not apply to all LogOptions values, in which "
          "case the default VerbosityLevel of \"Standard\" SHOULD be "
          "used. \n"
          "The RecordForLog produced by running a service MUST be "
          "tagged with a RecordType that corresponds to one of these "
          "log option values. \n"
          "Following is a brief description of the available log "
          "options: \n"
          "* \"Other\" (value = 1): Details are given in the "
          "corresponding OtherLogOptionsDescriptions entry. \n"
          "* \"Results\" (value = 2): Log the results obtained by "
          "running the service. This is the most common value for "
          "reporting the service results. \n"
          "* \"Subtests\" (value = 3): Log a test summary report upon "
          "completion of each subtest and each loop iteration. The "
          "summary reports SHOULD state whether the individual subtest "
          "or iteration passed or failed and list relevant error codes "
          "and respective error counts. \n"
          "* \"Actions\" (value = 4): Log corrective action and "
          "instructional messages to guide service personnel; for "
          "example, a prioritized list of actions to perform in order "
          "to isolate a failure or correct a problem. When ordering "
          "steps or prioritizing actions, a number should proceed the "
          "text; for example, 1) Do this first, 2) Do this next, etc. "
          "\n* \"Warnings\" (value = 5): Log warning messages; for "
          "example, 'device will be taken off line', 'test is "
          "long-running' or 'available memory is low'. The "
          "VerbosityLevel value specified for the Warnings option is "
          "related to the severity of the warnings logged; for "
          "instance, one would specify a high level of verbosity to "
          "get all warnings logged, regardless of severity, and a low "
          "level of verbosity to have only the most severe warnings "
          "logged. \n"
          "* \"Status\" (value = 6): Log status messages; for example, "
          "state information for the driver, device, or system. \n"
          "* \"Device Errors\" (value = 7): Log errors related to the "
          "managed element being serviced. \n"
          "* \"Service Errors\" (value = 8): Log errors related to the "
          "service itself rather than the element being serviced, such "
          "as 'Resource Allocaton Failure'. \n"
          "* \"Setting Data\" (value=9): Log the property values of "
          "the DiagnosticSetting object used to configure the service. "
          "\n* \"Statistics\" (value = 10): Log statistical messages; "
          "for example, packets sent per second. \n"
          "* \"Hardware Configuration\" (value = 11): Log messages "
          "that contain information about the hardware configuration "
          "as viewed by the service; for example, vendor, version, FRU "
          "identification, and location information. The format and "
          "contents of this property is element dependent. Examples "
          "are: SCSI ID, LPTx, PCI Slot Number, and Dimm#. \n"
          "* \"Software Configuration\" (value = 12): Log messages "
          "that contain information about the software environment as "
          "viewed by the service; for example, the name and version of "
          "all the critical software elements controlling the device "
          "under test. Each configuration message SHOULD have the "
          "following common format: Element name; element type; "
          "manufacturer name; version; for example, 'Miniport driver; "
          "SCSI; Intel; Version 1.2'. \n"
          "* \"Reference\" (value = 13): Log the keys of an CIM object "
          "of of interest; for example, the element under test, or a "
          "data file. \n"
          "* \"Debug\" (value = 14): Log debug messages. These "
          "messages are vendor specific."), 
       ValueMap { "0", "1", "2", "3", "4", "5", "6", "7", "8", "9",
          "10", "11", "12", "13", "14", "15" }, 
       Values { "Unknown", "Other", "Results", "Subtests", "Actions",
          "Warnings", "Status", "Device Errors", "Service Errors",
          "Setting Data", "Statistics", "Hardware Configuration",
          "Software Configuration", "References", "Debug",
          "No Log Options" }, ArrayType ( "Indexed" ), 
       ModelCorrespondence { 
          "CIM_DiagnosticSetting.OtherLogOptionsDescriptions",
          "CIM_DiagnosticServiceCapabilities.SupportedLogOptions",
          "CIM_DiagnosticServiceRecord.RecordType",
          "CIM_DiagnosticSetting.VerbosityLevel" }]
   uint16 LogOptions[];

      [Write, Description (
          "Provides additional information regarding the types of test "
          "messages that are logged when the property LogOptions "
          "includes the value 1 (\"Other\")."), 
       ModelCorrespondence { "CIM_DiagnosticSetting.LogOptions" }]
   string OtherLogOptionsDescriptions[];

      [Write, Description (
          "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. \n"
          "The values are: \n"
          "\"DiagnosticRecordLog\" (Value = 2): Use the "
          "DiagnosticRecordLog and DiagnosticRecord classes. \n"
          "\"MessageLog\" (Value = 4): Use the MessageLog class and "
          "its methods. \n"
          "\"File\" (Value = 5): Write data to a file."), 
       ValueMap { "0", "1", "2", "3", "4" }, 
       Values { "Unknown", "Other", "DiagnosticRecordLog",
          "MessageLog", "File" }, ArrayType ( "Indexed" ), 
       ModelCorrespondence { 
          "CIM_DiagnosticSetting.OtherLogStorageDescriptions",
          "CIM_DiagnosticServiceCapabilities.SupportedLogStorage" }]
   uint16 LogStorage[];

      [Write, Description (
          "This property provides additional information for "
          "LogStorage when the corresponding value is set to 1 "
          "(\"Other\")."), 
       ArrayType ( "Indexed" ), 
       ModelCorrespondence { "CIM_DiagnosticSetting.LogStorage" }]
   string OtherLogStorageDescriptions[];

      [Write, Description (
          "A client may want to specify the desired volume or detail "
          "logged by a diagnostic service. This property is applied to "
          "a corresponding logging option, acting as a qualifier on "
          "its description. Three levels of verbosity are defined as "
          "follows: \n"
          "* \"Minimum\" (value=2): Specified if the least amount of "
          "information is desired; for example, Pass or Fail. \n"
          "* \"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). \n"
          "* \"Full\" (value=4): Specified when all information, "
          "regardless of size, is desired. \n"
          "Note that VerbosityLevel is a subjective property and "
          "relates to the degree of detail, not an absolute metric. A "
          "client simply specifies its desired level of detail and the "
          "provider publishes its data in accordance with this desired "
          "level of detail. \n"
          "Verbosity may not apply to all LogOptions values, in which "
          "case the default VerbosityLevel of \"Standard\" SHOULD be "
          "used."), 
       ValueMap { "2", "3", "4" }, 
       Values { "Minimum", "Standard", "Full" },
       ArrayType ( "Indexed" ), 
       ModelCorrespondence { "CIM_DiagnosticSetting.LogOptions" }]
   uint16 VerbosityLevel[];

      [Write, Description (
          "This property, along with the locale information in "
          "LocalizationCapabilities and DiagnosticServiceRecord, meets "
          "the requirement to specify locale for results produced by a "
          "diagnostic service. A locale indicates a particular "
          "geographical, political, or cultural region. The Locales "
          "property of the DiagnosticSetting class is an array of "
          "strings whose entries specify a language to be used in the "
          "formulation of information requested by or delivered to a "
          "client as a result of running a diagnostic service. It is "
          "specified by the client as an input parameter to the "
          "RunDiagnostic method, by virtue of its inclusion in this "
          "Setting class which is a parameter of the method. A single "
          "Setting object may specify more than one Locale. In this "
          "case, information MUST be returned in each language "
          "specified. \n"
          "\n"
          "Each array entry consists of three sub-strings, separated "
          "by underscores: \n"
          "- The first sub-string is the language code, as specified "
          "in ISO639. \n"
          "- The second sub-string is the country code, as specified "
          "in ISO3166. \n"
          "- The third sub-string is a variant, which is vendor "
          "specific. \n"
          "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."), 
       ModelCorrespondence { 
          "CIM_LocalizationCapabilities.SupportedOutputLocales" }]
   string Locales[];


};