Class CIM_Service


CIM_ManagedElement
\_CIM_ManagedSystemElement
  \_CIM_LogicalElement
    \_CIM_EnabledLogicalElement


Description

A CIM_Service is a Logical Element that contains the information that is necessary to represent and manage the functionality provided by a Device or a SoftwareFeature, or both. A Service is a general-purpose object that is used to configure and manage the implementation of functionality. It is not the functionality itself.

Subclasses

CIM_AuthenticationService CIM_AuthorizationService CIM_BlockStatisticsService CIM_ControllerConfigurationService CIM_ObjectManager CIM_PrivilegeManagementService CIM_SecurityService CIM_StatisticsService CIM_StorageConfigurationService CIM_StorageHardwareIDManagementService CIM_WBEMService IBMTSDS_ControllerConfigurationService IBMTSDS_DeviceConfigurationService IBMTSDS_EncryptionGroupService IBMTSDS_ObjectManager IBMTSDS_ObjectManagerInterop IBMTSDS_PerformanceStatisticsService IBMTSDS_PrivilegeManagementService IBMTSDS_StorageConfigurationService IBMTSDS_StorageHardwareIDManagementService IBMTSDS_VolumeGroupService

Referenced By

CIM_HostedService CIM_ServiceAccessBySAP

Properties

IdTypeRangeDescription
Key
CreationClassName string
Max Length256
CreationClassName indicates the name of the class or the subclass that is 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
Max Length256
The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object.
SystemCreationClassName string
Max Length256
The CreationClassName of the scoping System.
SystemName string
Max Length256
The Name of the scoping System.
Read Only
Started boolean
Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
StartMode string
Max Length10
Note: The use of this element is deprecated in lieu of the EnabledDefault property that is inherited from EnabledLogicalElement. The EnabledLogicalElement addresses the same semantics. The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property. To remain compatible with those implementations, StartMode was grandfathered into the schema. Use of the deprecated qualifier allows the maintenance of the existing property but also permits an improved, clarified definition using EnabledDefault.Deprecated description: StartMode is a string value that indicates whether the Service is automatically started by a System, an Operating System, and so on, or is started only upon request.
Read Write
PrimaryOwnerContact string
Max Length256
A string that provides information on how the primary owner of the Service can be reached (for example, phone number, e-mail address, and so on).
PrimaryOwnerName string
Max Length64
The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service.
 
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
 

Method Summary

NameDescription
StartServiceThe StartService method places the Service in the started state.
StopServiceThe StopService method places the Service in the stopped state.
 
Inherited from class CIM_EnabledLogicalElement
RequestStateChange
 

Method Detail


StartService

Description

The StartService method places the Service in the started state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StartService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully started, 1 if the request is not supported, and any other number to indicate an error. 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 can also be specified in the subclass as a Values array qualifier.Note: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple"start"semantics are convenient to use.

Parameters

IdTypeRangeDescription
In
none
out
none
Return Codes
none

StopService

Description

The StopService method places the Service in the stopped state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StopService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully stopped, 1 if the request is not supported, and any other number to indicate an error. 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 can also be specified in the subclass as a Values array qualifier.Note: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple"stop"semantics are convenient to use.

Parameters

IdTypeRangeDescription
In
none
out
none
Return Codes
none