Class CIM_Service
extends CIM_EnabledLogicalElement

A Service is a LogicalElement that represents the availability of functionality that can be managed. This functionality may be provided by a seperately modeled entity such as a LogicalDevice or a SoftwareFeature, or both. The modeled Service typically provides only functionality required for management of itself or the elements it affects.

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

Direct Known Subclasses

CIM_BIOSService
CIM_BootService
CIM_ClusteringService
CIM_ConditioningService
CIM_ConfigurationReportingService
CIM_ControllerConfigurationService
CIM_DatabaseService
CIM_DiagnosticService
CIM_DiskPartitionConfigurationService
CIM_DropThresholdCalculationService
CIM_FibreProtocolService
CIM_FileExportService
CIM_FileServerConfigurationService
CIM_FileSystemConfigurationService
CIM_FSQuotaManagementService
CIM_HelpService
CIM_IBSubnetManager
CIM_IndicationService
CIM_IPConfigurationService
CIM_iSCSIConfigurationService
CIM_J2eeDeployedObject
CIM_J2eeEJB
CIM_J2eeResourceAdapter
CIM_J2eeServlet
CIM_LaunchInContextService
CIM_MemoryConfigurationService
CIM_MetricService
CIM_NetworkPortConfigurationService
CIM_NetworkService
CIM_OOBAlertService
CIM_OpaqueManagementDataService
CIM_PersistentMemoryService
CIM_PlatformWatchdogService
CIM_PowerManagementService
CIM_PowerUtilizationManagementService
CIM_PrintService
CIM_ProtocolService
CIM_QoSService
CIM_RedirectionService
CIM_ReplicationService
CIM_ResourcePoolConfigurationService
CIM_SCSIPathConfigurationService
CIM_SecurityService
CIM_SharedDeviceManagementService
CIM_SNMPService
CIM_SoftwareInstallationService
CIM_SpareConfigurationService
CIM_StatisticsService
CIM_StorageConfigurationService
CIM_StorageElementCompositionService
CIM_StorageErasureService
CIM_StorageProtectionService
CIM_StorageRelocationService
CIM_TierService
CIM_TimeService
CIM_VirtualSystemManagementService
CIM_VirtualSystemSnapshotService
CIM_VLANService
CIM_VTLStatisticalDataService
CIM_WakeUpService
CIM_WBEMServer
CIM_WBEMServerDeviceRegistrationService
CIM_WBEMService
CIM_ZoneService
PRS_SISService

Class Qualifiers

NameData TypeValue
Abstractbooleantrue
ClassConstraintstringinv: LoSID <> null implies LoSOrgID <> null
DescriptionstringA Service is a LogicalElement that represents the availability of functionality that can be managed. This functionality may be provided by a seperately modeled entity such as a LogicalDevice or a SoftwareFeature, or both. The modeled Service typically provides only functionality required for management of itself or the elements it affects.
UMLPackagePathstringCIM::Core::Service
Versionstring2.45.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
CreationClassNamestring
DescriptionstringCreationClassName 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.
Keybooleantrue
MaxLenuint32256
LoSIDstring
DescriptionstringIf not Null, the CIM_Service instance represents a line of service, as defined by ITIL, identified by the value of LoSID, which must be unique in the context of an unique identifier for an Organization specified in LoSOrgID.
ModelCorrespondencestringCIM_Service.LoSOrgID
LoSOrgIDstring
DescriptionstringIf not null, this CIM_Service instance represents an ITIL line of service and the value of LoSOrgID shall be a unique identifier for the organization that defines the value of LoSID.
ModelCorrespondencestringCIM_Service.LoSID
Namestring
DescriptionstringThe 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.
Keybooleantrue
MaxLenuint32256
OverridestringName
PrimaryOwnerContactstring
DescriptionstringA 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).
MappingStringsstringMIF.DMTF|General Information|001.4
MaxLenuint32256
Writebooleantrue
PrimaryOwnerNamestring
DescriptionstringThe name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service.
MappingStringsstringMIF.DMTF|General Information|001.3
MaxLenuint3264
Writebooleantrue
Startedboolean
DescriptionstringStarted is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
StartModestring
DeprecatedstringCIM_Service.EnabledDefault
DescriptionstringNote: 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.
MaxLenuint3210
ValueMapstringAutomatic, Manual
SystemCreationClassNamestring
DescriptionstringThe CreationClassName of the scoping System.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_System.CreationClassName
SystemNamestring
DescriptionstringThe Name of the scoping System.
Keybooleantrue
MaxLenuint32256
PropagatedstringCIM_System.Name

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

StartService (uint32)

Method Qualifiers (StartService)

NameData TypeValue
DeprecatedstringCIM_Service.RequestStateChange
DescriptionstringThe 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.

Method Parameters (StartService)

NameTypeQualifiers
NameData TypeValue

StopService (uint32)

Method Qualifiers (StopService)

NameData TypeValue
DeprecatedstringCIM_Service.RequestStateChange
DescriptionstringThe 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.

Method Parameters (StopService)

NameTypeQualifiers
NameData TypeValue

ChangeAffectedElementsAssignedSequence (uint32)

Method Qualifiers (ChangeAffectedElementsAssignedSequence)

NameData TypeValue
DescriptionstringThis method is called to change relative sequence in which order the ManagedElements associated to the Service through CIM_ServiceAffectsElement association are affected. In the case when the Service represents an interface for client to execute extrinsic methods and when it is used for grouping of the managed elements that could be affected, the ordering represents the relevant priority of the affected managed elements with respect to each other. An ordered array of ManagedElement instances is passed to this method, where each ManagedElement instance shall be already be associated with this Service instance via CIM_ServiceAffectsElement association. If one of the ManagedElements is not associated to the Service through CIM_ServiceAffectsElement association, the implementation shall return a value of 2 ("Error Occured"). Upon successful execution of this method, if the AssignedSequence parameter is NULL, the value of the AssignedSequence property on each instance of CIM_ServiceAffectsElement shall be updated such that the values of AssignedSequence properties shall be monotonically increasing in correlation with the position of the referenced ManagedElement instance in the ManagedElements input parameter. That is, the first position in the array shall have the lowest value for AssignedSequence. The second position shall have the second lowest value, and so on. Upon successful execution, if the AssignedSequence parameter is not NULL, the value of the AssignedSequence property of each instance of CIM_ServiceAffectsElement referencing the ManagedElement instance in the ManagedElements array shall be assigned the value of the corresponding index of the AssignedSequence parameter array. For ManagedElements instances which are associated with the Service instance via CIM_ServiceAffectsElement and are not present in the ManagedElements parameter array, the AssignedSequence property on the CIM_ServiceAffects association shall be assigned a value of 0.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
ValuesstringCompleted with No Error, Not Supported, Error Occured, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

Method Parameters (ChangeAffectedElementsAssignedSequence)

NameTypeQualifiers
NameData TypeValue
AssignedSequenceuint16[]
DescriptionstringAn array of integers representing AssignedSequence for the ManagedElement in the corresponding index of the ManagedElements parameter.
Requiredbooleantrue
ManagedElementsCIM_ManagedElement[]
DescriptionstringAn array of ManagedElements.
Requiredbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
RequestStateChangeuint32CIM_EnabledLogicalElement