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.22.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

RunDiagnostic (uint32)

Method Qualifiers (RunDiagnostic)

NameData TypeValue
DeprecatedstringCIM_DiagnosticService.RunDiagnosticService
DescriptionstringThis method is being deprecated as part of the change to have Diagnostic Settings derive from CIM_SettingData instead of CIM_Setting. The RunDiagnostic method is invoked to commence execution of a diagnostic program on a specific managed element. The input parameters specify this managed element and the settings that SHALL be applied to the diagnostic and the resultant job. The method returns a reference to the ConcreteJob instance created. Prior to invoking this method, clients SHALL examine the appropriate capabilities and create valid DiagnosticSetting and JobSettingData instances to apply as input parameters. Since settings may be changed without warning, the RunDiagnostic method SHOULD immediately evaluate and capture the attributes of DiagnsoticSetting in an instance of DiagnosticSettingRecord. This information is useful for post-mortem analysis of diagnostic results. A job SHALL be instantiated as a means for monitoring the diagnostic as it runs and to provide useful accounting and status information once the diagnostic has completed. The "Busy" return code indicates that the method cannot be invoked "at this time". It is not an error condition, but signals that the provider is doing something else and cannot respond.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x1000..0x7FFF, 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Busy, DMTF Reserved, 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, the Diagnostic's defaults MAY be used.
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReturns a reference to the resulting Job.
INbooleanfalse
OUTbooleantrue
JobSetting REF CIM_JobSettingData
DescriptionstringSpecifies the desired settings that SHALL be applied to the resulting Job. If null, the job's defaults MAY be used.
INbooleantrue
ManagedElement REF CIM_ManagedElement
DescriptionstringSpecifies the element upon which the DiagnosticService SHOULD be run.
INbooleantrue

RunDiagnosticService (uint32)

Method Qualifiers (RunDiagnosticService)

NameData TypeValue
DescriptionstringThe RunDiagnosticService method is invoked to commence execution of a diagnostic program on a specific managed element. The input parameters specify this managed element and the settings to be applied to the diagnostic and the resultant job. The method returns a reference to the ConcreteJob instance created. Prior to invoking this method, clients examine defaults and appropriate capabilities and create valid DiagnosticSettingData and JobSettingData instances to apply as input parameters. The RunDiagnosticService method SHALL evaluate and capture the attributes of DiagnosticSettingData in an instance of DiagnosticSettingDataRecord for use in post-mortem analysis of diagnostic results. A job SHALL be instantiated as a means for monitoring the diagnostic as it runs and to provide useful accounting and status information once the diagnostic has completed. The "Busy" return code indicates that the method cannot be invoked "at this time". It is not an error condition, but signals that the provider is doing something else and cannot respond.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 0x1000..0x7FFF, 0x8000..
ValuesstringSuccess, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, Busy, DMTF Reserved, Method Reserved, Vendor Specific

Method Parameters (RunDiagnosticService)

NameTypeQualifiers
NameData TypeValue
DiagnosticSettingsstring
DescriptionstringA string containing an encoding of the DiagnosticSettingData instance to be applied to the diagnostic. If null, the diagnostic's defaults are used.
EmbeddedInstancestringCIM_DiagnosticSettingData
INbooleantrue
JobSettingsstring
DescriptionstringA string containing an encoding of the JobSettingData instance to be applied to the resulting job. If null, the job's defaults are used.
EmbeddedInstancestringCIM_JobSettingData
INbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReturns a reference to the resulting Job.
INbooleanfalse
OUTbooleantrue
ManagedElement REF CIM_ManagedElement
DescriptionstringSpecifies the element upon which the DiagnosticService SHOULD be run.
INbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service