Class CIM_DiagnosticService
extends CIM_Service

The CIM_DiagnosticService class provides the ability to start a service that functions to participate in a problem determination process. Specific diagnostic services SHOULD be defined by subclassing this class. Examples of a diagnostic service are tests, information retrievers, exercisers, and ports to external executives.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_DiagnosticService

Direct Known Subclasses

CIM_DiagnosticTest

Class Qualifiers

NameData TypeValue
Abstractbooleantrue
DescriptionstringThe CIM_DiagnosticService class provides the ability to start a service that functions to participate in a problem determination process. Specific diagnostic services SHOULD be defined by subclassing this class. Examples of a diagnostic service are tests, information retrievers, exercisers, and ports to external executives.
UMLPackagePathstringCIM::System::Diagnostics
Versionstring2.9.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
NamestringCIM_Service
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

RunDiagnostic (uint32)

Method Qualifiers (RunDiagnostic)

NameData TypeValue
DescriptionstringThe RunDiagnostic method executes this test for the specified ManagedSystemElement (defined using the SystemElement input parameter). The capabilities for the diagnostic service indicate where the results from the test job are stored. How the test should execute, i.e. its settings, is defined in a DiagnosticSetting object (or by a subclass of DiagnosticSetting). A reference to a Setting object is specified using the Setting input parameter. If a reference is not passed into the method, then a default DiagnosticSetting SHALL be used. When RunDiagnostic starts execution, the settings, which are time sensitive, SHOULD be evaluated and captured. This is suggested since the DiagnosticSetting object MAY be modified at any time, and therefore the current test settings could be lost. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 a ConcreteJob will be started.
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x1000, .., 0x8000..
ValuesstringJob completed with no error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, DMTF Reserved, Method parameters checked - job started, Method Reserved, Vendor Specific

Method Parameters (RunDiagnostic)

NameTypeQualifiers
NameData TypeValue
DiagSetting REF CIM_DiagnosticSetting
DescriptionstringSpecifies the desired settings that SHOULD be applied to the Diagnostic. If null, then the Diagnostic's defaults MAY be used.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReturns a handle to the resulting Job.
INbooleanfalse
OUTbooleantrue
JobSetting REF CIM_JobSettingData
DescriptionstringSpecifies the desired settings that SHOULD be applied to the resulting Job. If null and a resulting Job is required (i.e., the Diagnostic is long running), then the test's defaults MAY be used.
INbooleantrue
ManagedElement REF CIM_ManagedElement
DescriptionstringSpecifies the element upon which the DiagnosticService SHOULD be run.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service