CIM_Service, ROOT\virtualization\v2

Class | Childs (12) | Methods (3) | Properties (28) | Qualifiers (5) | Instances (1) | Namespaces (12)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

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.

CIM_Service - child subclasses in ROOT\virtualization\v2

Number of classes:12

CIM_Service methods

CIM_Service has 3 methods (2 Local, 1 Derived)

NameOriginReturn
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
StartServiceCIM_Serviceuint32 {'out':True}
StopServiceCIM_Serviceuint32 {'out':True}

CIM_Service properties

CIM_Service has 28 properties (7 Local, 21 Derived)

NameOriginCIMType
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_Service8 [string]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
HealthStateCIM_ManagedSystemElement18 [uint16]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
key
Name
CIM_ManagedSystemElement8 [string]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
PrimaryOwnerContactCIM_Service8 [string]
PrimaryOwnerNameCIM_Service8 [string]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
StartedCIM_Service11 [boolean]
StartModeCIM_Service8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
key
SystemCreationClassName
CIM_Service8 [string]
key
SystemName
CIM_Service8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]

Detailed description of CIM_Service methods

Local methods (2) of CIM_Service class

StartService method
Returnuint32 {'out':True}
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.'
StartService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StopService method
Returnuint32 {'out':True}
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.'
StopService method is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces

Derived methods (1) of CIM_Service class

RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces

Detailed description of CIM_Service properties

Local properties (7) of CIM_Service class

CreationClassName property
CIMTYPE'string'
Description'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.'
keyTrue
MaxLen256
CreationClassName property is in 113 classes of ROOT\virtualization\v2 and in 20 namespaces
PrimaryOwnerContact property
CIMTYPE'string'
Description'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['MIF.DMTF|General Information|001.4']
MaxLen256
writeTrue
PrimaryOwnerContact property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
PrimaryOwnerName property
CIMTYPE'string'
Description'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['MIF.DMTF|General Information|001.3']
MaxLen64
writeTrue
PrimaryOwnerName property is in 30 classes of ROOT\virtualization\v2 and in 15 namespaces
Started property
CIMTYPE'boolean'
Description'Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE).'
Started property is in 23 classes of ROOT\virtualization\v2 and in 11 namespaces
StartMode property
CIMTYPE'string'
Deprecated['CIM_Service.EnabledDefault']
Description'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.'
MaxLen10
ValueMap['Automatic', 'Manual']
StartMode property is in 23 classes of ROOT\virtualization\v2 and in 15 namespaces
SystemCreationClassName property
CIMTYPE'string'
Description'The CreationClassName of the scoping System.'
keyTrue
MaxLen256
Propagated'CIM_System.CreationClassName'
SystemCreationClassName property is in 109 classes of ROOT\virtualization\v2 and in 20 namespaces
SystemName property
CIMTYPE'string'
Description'The Name of the scoping System.'
keyTrue
MaxLen256
Propagated'CIM_System.Name'
SystemName property is in 109 classes of ROOT\virtualization\v2 and in 22 namespaces

Derived properties (21) of CIM_Service class

AvailableRequestedStates property
CIMTYPE'uint16'
AvailableRequestedStates property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces
Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 106 classes of ROOT\virtualization\v2 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 116 classes of ROOT\virtualization\v2 and in 13 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
Name property
CIMTYPE'string'
Description'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.'
keyTrue
MaxLen256
Override'Name'
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 106 classes of ROOT\virtualization\v2 and in 12 namespaces
Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
TransitioningToState property
CIMTYPE'uint16'
TransitioningToState property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces

CIM_Service Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'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.'
LOCALE1033
UMLPackagePath'CIM::Core::Service'
Version'2.14.0'

CIM_Service System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:CIM_Service'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT28___SYSTEM3
__RELPATH'CIM_Service'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_EnabledLogicalElement'___SYSTEM8
__CLASS'CIM_Service'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_Service

Number of classes:43
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
CIM_ForwardingService2343---
CIM_HostedService220-10-
CIM_MetricService1289-1-
CIM_MetricServiceCapabilities1130-1-
CIM_NetworkService1323---
CIM_ResourcePoolConfigurationService0289---
CIM_ServiceAccessPoint1241---
CIM_ServiceAffectsElement140-40-
CIM_ServiceComponent120---
CIM_ServiceSAPDependency120---
CIM_SwitchService0383---
CIM_SwitchServiceTransparentBridging020---
CIM_TransparentBridgingService1363---
CIM_VirtualSystemManagementService2289-2-
CIM_VirtualSystemMigrationService1287-1-
CIM_VirtualSystemSnapshotService1286-1-
Msvm_GuestFileService0284----
Msvm_GuestService1283----
Msvm_GuestServiceInterfaceComponent0388----
Msvm_GuestServiceInterfaceComponentSettingData02401---
Msvm_HostedService02010---
Msvm_HostedSwitchService020----
Msvm_ImageManagementService028161---
Msvm_MetricService028101---
Msvm_MetricServiceCapabilities01301---
Msvm_MetricServiceSettingData0501---
Msvm_RegisteredGuestService020----
Msvm_ReplicationService028291---
Msvm_ReplicationServiceSettingData01101---
Msvm_ResourcePoolConfigurationService02871---
Msvm_ServiceAffectsElement04040---
Msvm_Synthetic3DService02861---
Msvm_Synthetic3DServiceSettingData0501---
Msvm_TerminalService02871---
Msvm_TerminalServiceSettingData0901---
Msvm_TransparentBridgingService0363----
Msvm_VirtualEthernetSwitchManagementService028121---
Msvm_VirtualSystemManagementService028331---
Msvm_VirtualSystemManagementServiceSettingData01701---
Msvm_VirtualSystemMigrationService031151---
Msvm_VirtualSystemMigrationServiceSettingData01001---
Msvm_VirtualSystemMigrationServiceSettingDataComponent020----
Msvm_VirtualSystemSnapshotService02881---
comments powered by Disqus
WUtils.com