# 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_BasicExecutionService
CIM_BatchService
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_FileImportService
CIM_FileServerConfigurationService
CIM_FileSystemConfigurationService
CIM_FingerprintMatchingService
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_MPLSCrossConnect
CIM_MPLSService
CIM_NetworkPolicyService
CIM_NetworkPortConfigurationService
CIM_NetworkService
CIM_OOBAlertService
CIM_OpaqueManagementDataService
CIM_PersistentMemoryService
CIM_PlatformWatchdogService
CIM_PolicyActivationService
CIM_PowerManagementService
CIM_PowerTopologyService
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_VirtualSystemMigrationService
CIM_VirtualSystemSnapshotService
CIM_VLANService
CIM_VRFConfigurationService
CIM_VTLStatisticalDataService
CIM_WakeUpService
CIM_WBEMServer
CIM_WBEMServerDeviceRegistrationService
CIM_WBEMService
CIM_ZoneService
PRS_SISService

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Abstract | boolean | true
ClassConstraint | string | inv: LoSID <> null implies LoSOrgID <> null
Description | string | 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.
UMLPackagePath | string | CIM::Core::Service
Version | string | 2.45.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
CreationClassName | string |
Description | string | 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.
Key | boolean | true
MaxLen | uint32 | 256
LoSID | string |
Description | string | If 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.
ModelCorrespondence | string | CIM_Service.LoSOrgID
LoSOrgID | string |
Description | string | If 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.
ModelCorrespondence | string | CIM_Service.LoSID
Name | string |
Description | string | 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.
Key | boolean | true
MaxLen | uint32 | 256
Override | string | Name
PrimaryOwnerContact | string |
Description | string | 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).
MappingStrings | string | MIF.DMTF|General Information|001.4
MaxLen | uint32 | 256
Write | boolean | true
PrimaryOwnerName | string |
Description | string | The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service.
MappingStrings | string | MIF.DMTF|General Information|001.3
MaxLen | uint32 | 64
Write | boolean | true
Started | boolean |
Description | string | Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).
StartMode | string |
Deprecated | string | CIM_Service.EnabledDefault
Description | string | 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.
MaxLen | uint32 | 10
ValueMap | string | Automatic, Manual
SystemCreationClassName | string |
Description | string | The CreationClassName of the scoping System.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_System.CreationClassName
SystemName | string |
Description | string | The Name of the scoping System.
Key | boolean | true
MaxLen | uint32 | 256
Propagated | string | CIM_System.Name

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### StartService (uint32)

#### Method Qualifiers (StartService)

Name | Data Type | Value
--- | --- | ---
Deprecated | string | CIM_Service.RequestStateChange
Description | string | 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.

#### Method Parameters (StartService)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value

#### StopService (uint32)

#### Method Qualifiers (StopService)

Name | Data Type | Value
--- | --- | ---
Deprecated | string | CIM_Service.RequestStateChange
Description | string | 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.

#### Method Parameters (StopService)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value

#### ChangeAffectedElementsAssignedSequence (uint32)

#### Method Qualifiers (ChangeAffectedElementsAssignedSequence)

Name | Data Type | Value
--- | --- | ---
Description | string | This 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.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Error Occured, Busy, Invalid Reference, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specified

#### Method Parameters (ChangeAffectedElementsAssignedSequence)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
AssignedSequence | uint16[]
Description | string | An array of integers representing AssignedSequence for the ManagedElement in the corresponding index of the ManagedElements parameter.
Required | boolean | true
ManagedElements | CIM_ManagedElement[]
Description | string | An array of ManagedElements.
Required | boolean | true
Job | REF CIM_ConcreteJob
Description | string | Reference to the job spawned if the operation continues after the method returns. (May be null if the task is completed).
IN | boolean | false
OUT | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
RequestStateChange | uint32 | CIM_EnabledLogicalElement