CIM29 Class Declaration
CIM_OSPFService

Table of Contents:
Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary

Class Hierarchy

CIM_OSPFService --> CIM_RouteCalculationService --> CIM_NetworkService --> CIM_Service --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]

Class Attributes

Class Declaration Attributes
NameValue
SUPERCLASSCIM_RouteCalculationService
NAMECIM_OSPFService

Class Qualifiers

Class CIM_OSPFService Qualifiers
NameTypeValueFrom Class
Versionstring2.7.0 CIM_OSPFService
DescriptionstringThis class is used to represent the basic operation of OSPF. It is derived from the RouteCalculationService, the superclass of all routing protocols. CIM_OSPFService
DescriptionstringThis is an abstract base class, derived from Service, that represents the route calculation aspects of a system. This class also addresses functions performed by the system when it exchanges routing information. Examining the RouteCalculationService class definition, note that its superclass NetworkService is deprecated. Therefore, NetworkService ’ s properties need not be implemented in an instance of RouteCalculationService. Unfortunately, NetworkService cannot be removed from the object hierarchy without a major Schema release. When/if this occurs, the NetworkService superclass will be removed, and RouteCalculationService will subclass from CIM_Service directly. Also note that there are a large number of additional routing protocols that are not currently modeled. These will be added over time. CIM_RouteCalculationService
DescriptionstringThis is an abstract base class, derived from the Service class. It is deprecated in Version 2.7 with the recommendation that the Service class be subclassed instead. Distinguishing between services that modify traffic versus supporting basic communication has not proved useful. CIM_NetworkService
DescriptionstringA CIM_Service is a Logical Element that contains the information necessary to represent and manage the functionality provided by a Device and/or SoftwareFeature. A Service is a general-purpose object to configure and manage the implementation of functionality. It is not the functionality itself. CIM_Service
DescriptionstringThis class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement
DescriptionstringCIM_LogicalElement is a base class for all the components of a System that represent abstract system components, such as Files, Processes, or LogicalDevices. CIM_LogicalElement
DescriptionstringCIM_ManagedSystemElement is the base class for the System Element hierarchy. Any distinguishable component of a System is a candidate for inclusion in this class. Examples of system components include: - software components such as application servers, databases, and applications - operating system components such as files, processes, and threads - device components such as disk drives, controllers, processors, and printers - physical components such as chips and cards. CIM_ManagedSystemElement
DescriptionstringManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement

Properties

Properties
NameTypeValueQualifiersClassOrigin
RunningMOSPFboolean Description
MappingStrings
CIM_OSPFService
IsInterAreaMulticastForwarderboolean Description
MappingStrings
CIM_OSPFService
IsInterAsMulticastForwarderboolean Description
MappingStrings
CIM_OSPFService
ExitOverflowIntervaluint32 Description
Units
MappingStrings
CIM_OSPFService
RFC1583Compatibilityboolean Description CIM_OSPFService
RouterIDstring Description CIM_RouteCalculationService
AlgorithmTypeuint16 Description
ValueMap
Values
CIM_RouteCalculationService
Keywordsstring[] Deprecated
Description
CIM_NetworkService
ServiceURLstring Deprecated
Description
CIM_NetworkService
StartupConditionsstring[] Deprecated
Description
CIM_NetworkService
StartupParametersstring[] Deprecated
Description
CIM_NetworkService
SystemCreationClassNamestring Key
Propagated
Description
MaxLen
CIM_Service
SystemNamestring Key
Propagated
Description
MaxLen
CIM_Service
CreationClassNamestring Key
Description
MaxLen
CIM_Service
Namestring Key
Override
Description
MaxLen
CIM_Service
PrimaryOwnerNamestring Write
Description
MaxLen
MappingStrings
CIM_Service
PrimaryOwnerContactstring Write
Description
MaxLen
MappingStrings
CIM_Service
StartModestring Deprecated
Description
ValueMap
MaxLen
CIM_Service
Startedboolean Description CIM_Service
EnabledStateuint165 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
OtherEnabledStatestring Description
ModelCorrespondence
CIM_EnabledLogicalElement
RequestedStateuint165 Description
ValueMap
Values
ModelCorrespondence
CIM_EnabledLogicalElement
EnabledDefaultuint162 Write
Description
ValueMap
Values
CIM_EnabledLogicalElement
TimeOfLastStateChangedatetime Description CIM_EnabledLogicalElement
InstallDatedatetime Description
MappingStrings
CIM_ManagedSystemElement
OperationalStatusuint16[] Description
ValueMap
Values
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
StatusDescriptionsstring[] Description
ArrayType
ModelCorrespondence
CIM_ManagedSystemElement
Statusstring Deprecated
Description
ValueMap
MaxLen
CIM_ManagedSystemElement
Captionstring Description
MaxLen
CIM_ManagedElement
Descriptionstring Description CIM_ManagedElement
ElementNamestring Description CIM_ManagedElement

Property Qualifiers

Property RunningMOSPF Qualifiers
NameTypeValueFrom Class
DescriptionstringThis attribute indicates whether this router is running MOSPF (multicast enhancements to OSPF) or not, see B.1 in RFC 1584. This attribute only can be true, when the SupportMOSPF property in OSPFService Capabilities is also true. If SupportMOSPF is false, then this property has no meaning. CIM_OSPFService
MappingStringsstringMIB.IETF|OSPF-MIB.ospfMulticastExtensions CIM_OSPFService

Property IsInterAreaMulticastForwarder Qualifiers
NameTypeValueFrom Class
DescriptionstringThis attribute indicates whether this router will forward multicast datagrams between OSPF areas or not, see B.1 in RFC 1584. CIM_OSPFService
MappingStringsstringMIB.IETF|OSPF-MIB.ospfMulticastExtensions CIM_OSPFService

Property IsInterAsMulticastForwarder Qualifiers
NameTypeValueFrom Class
DescriptionstringThis attribute indicates whether this router will forward multicast datagrams between Autonomous Systems or not, see B.1 in RFC 1584. CIM_OSPFService
MappingStringsstringMIB.IETF|OSPF-MIB.ospfMulticastExtensions CIM_OSPFService

Property ExitOverflowInterval Qualifiers
NameTypeValueFrom Class
DescriptionstringThe number of seconds that, after entering OverflowState, a router will attempt to leave OverflowState. When set to 0, the router will not leave OverflowState until restarted, see 2.1 in RFC 1765. CIM_OSPFService
UnitsstringSeconds CIM_OSPFService
MappingStringsstringMIB.IETF|OSPF-MIB.ospfExitOverflowInterval CIM_OSPFService

Property RFC1583Compatibility Qualifiers
NameTypeValueFrom Class
DescriptionstringControls the preference rules used in choosing among multiple AS-external-LSAs advertising the same destination. When set to TRUE, the preference rules remain those specified by RFC 1583. When set to FALSE, the preference rules are those stated in RFC 2328, which prevent routing loops when AS-external-LSAs for the same destination have been originated from different areas. See C.1 in RFC2328. CIM_OSPFService

Property RouterID Qualifiers
NameTypeValueFrom Class
DescriptionstringThe RouterID uniquely identifies the router that is performing the route calculation. It is the highest IP address on the router (or the highest loopback interface, if there is one). CIM_RouteCalculationService

Property AlgorithmType Qualifiers
NameTypeValueFrom Class
DescriptionstringThis is an enumerated value that defines the routing algorithm used in this route calculation. CIM_RouteCalculationService
ValueMapstring
[See below.]
CIM_RouteCalculationService
ValuesstringUnknown
RIPv1
RIPv2
OSPFv1
OSPFv2
BGPv1
BGPv2
BGPv3
BGPv4
CIM_RouteCalculationService

NameValue
0Unknown
1RIPv1
2RIPv2
3OSPFv1
4OSPFv2
5BGPv1
6BGPv2
7BGPv3
8BGPv4
Property Keywords Qualifiers
NameTypeValueFrom Class
DescriptionstringThis is a free-form array of strings that provide descriptive words and phrases that can be used in queries. To-date, this property has not been implemented, since it is not standardized. Also, if this was a necessary query construct, then it would be required higher in the inheritance hierarchy. The latter has not proven necessary. Therefore, the property is deprecated. CIM_NetworkService

Property ServiceURL Qualifiers
NameTypeValueFrom Class
DescriptionstringThis is a URL that provides the protocol, network location, and other service-specific information required in order to access the service. It is deprecated with the recommendation that ServiceAccessURI be instantiated instead. This new class correctly positions the semantics of the service access, and clarifies the format of the information. CIM_NetworkService

Property StartupConditions Qualifiers
NameTypeValueFrom Class
DescriptionstringThis is a free-form array of strings that specify any specific pre-conditions that must be met in order for this service to start correctly. It was expected that subclasses would refine the inherited StartService() method to suit their specific needs. To-date, this refinement has not been necessary. Also, the property is not very useful, since it is not standardized. If this was a necessary construct, then it would be required higher in the inheritance hierarchy (on Service). The latter has not proven true. Therefore, the property is deprecated. CIM_NetworkService

Property StartupParameters Qualifiers
NameTypeValueFrom Class
DescriptionstringThis is a free-form array of strings that specify any specific parameters that must be supplied to the StartService() method in order for this service to start correctly. It was expected that subclasses would refine the inherited StartService() methods to suit their specific needs. To-date, this refinement has not been necessary. If indeed the method were refined, then its parameters would more formally convey this information. Therefore, the property is deprecated. CIM_NetworkService

Property SystemCreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
PropagatedstringCIM_System.CreationClassName CIM_Service
DescriptionstringThe scoping System ’ s CreationClassName. CIM_Service
MaxLenuint32256 CIM_Service

Property SystemName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
PropagatedstringCIM_System.Name CIM_Service
DescriptionstringThe scoping System ’ s Name. CIM_Service
MaxLenuint32256 CIM_Service

Property CreationClassName Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
DescriptionstringCreationClassName indicates the name of the class or the subclass 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. CIM_Service
MaxLenuint32256 CIM_Service

Property Name Qualifiers
NameTypeValueFrom Class
Keybooleantrue CIM_Service
OverridestringName CIM_Service
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 object ’ s Description property. CIM_Service
MaxLenuint32256 CIM_Service

Property PrimaryOwnerName Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Service
DescriptionstringThe name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. CIM_Service
MaxLenuint3264 CIM_Service
MappingStringsstringMIF.DMTF|General Information|001.3 CIM_Service

Property PrimaryOwnerContact Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_Service
DescriptionstringA string that provides information on how the primary owner of the Service can be reached (e.g. phone number, email address, ...). CIM_Service
MaxLenuint32256 CIM_Service
MappingStringsstringMIF.DMTF|General Information|001.4 CIM_Service

Property StartMode Qualifiers
NameTypeValueFrom Class
DescriptionstringStartMode is a string value indicating whether the Service is automatically started by a System, Operating System, etc. or only started upon request. This property is deprecated in lieu of the EnabledDefault property inherited from EnabledLogicalElement, which 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 and did not want to modify their code. Therefore, 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. CIM_Service
ValueMapstring
[See below.]
CIM_Service
MaxLenuint3210 CIM_Service

NameValue
Automatic[none]
Manual[none]
Property Started Qualifiers
NameTypeValueFrom Class
DescriptionstringStarted is a boolean indicating whether the Service has been started (TRUE), or stopped (FALSE). CIM_Service

Property EnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringEnabledState is an integer enumeration that indicates the enabled/disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value = 4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled/disabled states: Enabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element doesn ’ t support being enabled/disabled. Enabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element may be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The element ’ s behavior is similar to the Enabled state, but it only processes a restricted set of commands. All other requests are queued. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringUnknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement

NameValue
0Unknown
1Other
2Enabled
3Disabled
4Shutting Down
5Not Applicable
6Enabled but Offline
7In Test
8Deferred
9Quiesce
10Starting
11..32767DMTF Reserved
32768..65535Vendor Reserved
Property OtherEnabledState Qualifiers
NameTypeValueFrom Class
DescriptionstringA string describing the element ’ s enabled/disabled state when the EnabledState property is set to 1 ( " Other " ). This property MUST be set to NULL when EnabledState is any value other than 1. CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

Property RequestedState Qualifiers
NameTypeValueFrom Class
DescriptionstringRequestedState is an integer enumeration indicating the last requested or desired state for the element. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled/disabled states. Note that when EnabledState is set to 5 ( " Not Applicable " ), then this property has no meaning. By default, the element ’ s RequestedState is 5 ( " No Change " ). Refer to the EnabledState ’ s property Description for explanations of the values in the RequestedState enumeration. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are " Reboot " (10) and " Reset " (11). The former, Reboot, refers to doing a " Shut Down " and then moving to an " Enabled " state. The latter, Reset, indicates that the element is first " Disabled " and then " Enabled " . The distinction between requesting " Shut Down " and " Disabled " should also be noted. The former, Shut Down, requests an orderly transition to the Disabled state, and MAY involve removing power, to completely erase any existing state. The latter, the Disabled state, requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or may be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, since it allows an explicit invocation of the operation and the return of a result code. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
4Shut Down
5No Change
6Offline
7Test
8Deferred
9Quiesce
10Reboot
11Reset
..DMTF Reserved
32768..65535Vendor Reserved
Property EnabledDefault Qualifiers
NameTypeValueFrom Class
Writebooleantrue CIM_EnabledLogicalElement
DescriptionstringAn enumerated value indicating an administrator ’ s default/startup configuration for an element ’ s Enabled State. By default, the element is " Enabled " (value=2). CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement

NameValue
2Enabled
3Disabled
5Not Applicable
6Enabled but Offline
7No Default
8..32767DMTF Reserved
32768..65535Vendor Reserved
Property TimeOfLastStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringThe date/time when the element ’ s EnabledState last changed. If the state of the element has not changed and this property is populated, then it MUST be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property MUST NOT be updated. CIM_EnabledLogicalElement

Property InstallDate Qualifiers
NameTypeValueFrom Class
DescriptionstringA datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement
MappingStringsstringMIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement

Property Name Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property. CIM_ManagedSystemElement
MaxLenuint321024 CIM_ManagedSystemElement

Property OperationalStatus Qualifiers
NameTypeValueFrom Class
DescriptionstringIndicates the current status(es) of the element. Various health and operational statuses are defined. Many of the enumeration ’ s values are self- explanatory. However, a few are not and are described in more detail. " Stressed " indicates that the element is functioning, but needs attention. Examples of " Stressed " states are overload, overheated, etc. " Predictive Failure " indicates that an element is functioning nominally but predicting a failure in the near future. " In Service " describes an element being configured, maintained, cleaned, or otherwise administered. " No Contact " indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. " Lost Communication " indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. " Stopped " and " Aborted " are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the element ’ s state and configuration may need to be updated. " Dormant " indicates that the element is inactive or quiesced. " Supporting Entity in Error " describes that this element may be " OK " but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower layer networking problems. " Completed " indicates the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can till if the complete operation passed (Completed with OK), and failure (Completed with Error). Completed with Degraded would imply the operation finished, but did not complete OK or report an error. " Power Mode " indicates the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today ’ s environment to the future. This change was not made earlier since it required the DEPRECATED qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly RECOMMENDED that providers/instrumentation provide BOTH the Status and OperationalStatus properties. Further, the first value of OperationalStatus SHOULD contain the primary status for the element. When instrumented, Status (since it is single-valued) SHOULD also provide the primary status of the element. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
ValuesstringUnknown
Other
OK
Degraded
Stressed
Predictive Failure
Error
Non-Recoverable Error
Starting
Stopping
Stopped
In Service
No Contact
Lost Communication
Aborted
Dormant
Supporting Entity in Error
Completed
Power Mode
DMTF Reserved
Vendor Reserved
CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement

NameValue
0Unknown
1Other
2OK
3Degraded
4Stressed
5Predictive Failure
6Error
7Non-Recoverable Error
8Starting
9Stopping
10Stopped
11In Service
12No Contact
13Lost Communication
14Aborted
15Dormant
16Supporting Entity in Error
17Completed
18Power Mode
..DMTF Reserved
0x8000..Vendor Reserved
Property StatusDescriptions Qualifiers
NameTypeValueFrom Class
DescriptionstringStrings describing the various OperationalStatus array values. For example, if " Stopping " is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus. CIM_ManagedSystemElement
ArrayTypestringIndexed CIM_ManagedSystemElement
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement

Property Status Qualifiers
NameTypeValueFrom Class
DescriptionstringA string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This overcomes the limitation of describing status via a single value, when it is really a multi-valued property (for example, an element may be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. And, 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the Deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus. CIM_ManagedSystemElement
ValueMapstring
[See below.]
CIM_ManagedSystemElement
MaxLenuint3210 CIM_ManagedSystemElement

NameValue
OK[none]
Error[none]
Degraded[none]
Unknown[none]
Pred Fail[none]
Starting[none]
Stopping[none]
Service[none]
Stressed[none]
NonRecover[none]
No Contact[none]
Lost Comm[none]
Stopped[none]
Property Caption Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement
MaxLenuint3264 CIM_ManagedElement

Property Description Qualifiers
NameTypeValueFrom Class
DescriptionstringThe Description property provides a textual description of the object. CIM_ManagedElement

Property ElementName Qualifiers
NameTypeValueFrom Class
DescriptionstringA user-friendly name for the object. This property allows each instance to define a user-friendly name IN ADDITION TO its key properties/identity data, and description information. Note that ManagedSystemElement ’ s Name property is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information MAY be present in both the Name and ElementName properties. CIM_ManagedElement

Methods

NameTypeValueQualifiersParametersClassOrigin
StartServiceuint32 Description  CIM_Service
StopServiceuint32 Description  CIM_Service
RequestStateChangeuint32 Description
ValueMap
Values
ModelCorrespondence
RequestedState
TimeoutPeriod
CIM_EnabledLogicalElement

Method Qualifiers

Method StartService Qualifiers
NameTypeValueFrom Class
DescriptionstringThe StartService method places the Service in the started state. Note that this method ’ s function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., 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 ’ may also be specified in the subclass as a Values array qualifier. Note that this method overlaps in semantics with the RequestStateChange method inherited from EnabledLogicalElement. This method is maintained since it has been widely implemented, and its simple ’ start ’ semantics are convenient to use. CIM_Service

Method StopService Qualifiers
NameTypeValueFrom Class
DescriptionstringThe StopService method places the Service in the stopped state. Note that this method ’ s function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., 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 ’ may also be specified in the subclass as a Values array qualifier. Note that this method overlaps in semantics with the RequestStateChange method inherited from EnabledLogicalElement. This method is maintained since it has been widely implemented, and its simple ’ stop ’ semantics are convenient to use. CIM_Service

Method RequestStateChange Qualifiers
NameTypeValueFrom Class
DescriptionstringRequests that the element ’ s state be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the element ’ s EnabledState and RequestedState will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten/lost. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringCompleted with No Error
Not Supported
Unknown/Unspecified Error
Can NOT complete within Timeout Period
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Invalid State Transition
Use of Timeout Parameter Not Supported
Busy
Method Reserved
Vendor Specific
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameters

Method RequestStateChange Parameters
NameTypeQualifiers
RequestedStateuint16IN
Description
ValueMap
Values
ModelCorrespondence
TimeoutPerioddatetimeIN
Description

Parameter Qualifiers

Parameter RequestedState Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringThe state requested for the element. This information will be placed into the instance ’ s RequestedState property if the RequestStateChange method ’ s return code is 0, 3, or 4096 (0x1000) - ’ Completed with No Error ’ , ’ Timeout ’ , or ’ Job Started ’ respectively. Refer to the description of the EnabledState and RequestedState properties for the detailed meanings of the RequestedState values. CIM_EnabledLogicalElement
ValueMapstring
[See below.]
CIM_EnabledLogicalElement
ValuesstringEnabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor Reserved
CIM_EnabledLogicalElement
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement

Parameter TimeoutPeriod Qualifiers
NameTypeValueFrom Class
INbooleantrue CIM_EnabledLogicalElement
DescriptionstringA 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 doesn ’ t support this parameter. A return code of ’ Use Of Timeout Parameter Not Supported ’ MUST be returned. CIM_EnabledLogicalElement

Associations this class can participate in

Association
Class
Reference
Class
Role
CIM_OSPFServiceConfigurationCIM_OSPFServiceAntecedent
CIM_HostedRoutingServicesCIM_RouteCalculationServiceDependent
CIM_EGPRouteCalcDependencyCIM_RouteCalculationServiceAntecedent
CIM_EGPRouteCalcDependencyCIM_RouteCalculationServiceDependent
CIM_CalculatesAmongCIM_RouteCalculationServiceDependent
CIM_CalculatedRoutesCIM_RouteCalculationServiceAntecedent
CIM_NetworkServicesInAdminDomainCIM_NetworkServiceDependent
CIM_LogicalNetworkServiceCIM_NetworkServiceNetworkService
CIM_HostedServiceCIM_ServiceDependent
CIM_ProvidesServiceToElementCIM_ServiceAntecedent
CIM_ServiceServiceDependencyCIM_ServiceAntecedent
CIM_ServiceServiceDependencyCIM_ServiceDependent
CIM_ServiceUsesSecurityServiceCIM_ServiceDependent
CIM_ServiceSAPDependencyCIM_ServiceDependent
CIM_ServiceAccessBySAPCIM_ServiceAntecedent
CIM_ProvidesEndpointCIM_ServiceAntecedent
CIM_DeviceServiceImplementationCIM_ServiceDependent
CIM_SoftwareFeatureServiceImplementationCIM_ServiceDependent
CIM_SoftwareElementServiceImplementationCIM_ServiceDependent
CIM_ServiceComponentCIM_ServiceGroupComponent
CIM_ServiceComponentCIM_ServicePartComponent
CIM_ProductServiceComponentCIM_ServicePartComponent
CIM_ServiceAvailableToElementCIM_ServiceServiceProvided
CIM_ServiceAffectsElementCIM_ServiceAffectingElement
CIM_ServiceStatisticsCIM_ServiceElement
CIM_ServiceProcessCIM_ServiceService
CIM_ResidesOnExtentCIM_LogicalElementDependent
CIM_OperationLogCIM_LogicalElementDependent
CIM_LogicalElementUnitOfWorkDefCIM_LogicalElementAntecedent
CIM_LogicalElementPerformsUoWCIM_LogicalElementAntecedent
CIM_AllocatedFromStoragePoolCIM_LogicalElementDependent
CIM_AssociatedMemoryCIM_LogicalElementDependent
CIM_DiagnosticTestForMSECIM_ManagedSystemElementDependent
CIM_UseOfLogCIM_ManagedSystemElementDependent
CIM_SystemComponentCIM_ManagedSystemElementPartComponent
CIM_RedundancyComponentCIM_ManagedSystemElementPartComponent
CIM_CollectedMSEsCIM_ManagedSystemElementMember
CIM_ActsAsSpareCIM_ManagedSystemElementSpare
CIM_ElementSettingCIM_ManagedSystemElementElement
CIM_ElementConfigurationCIM_ManagedSystemElementElement
CIM_DiagnosticResultForMSECIM_ManagedSystemElementSystemElement
CIM_DependencyCIM_ManagedElementAntecedent
CIM_DependencyCIM_ManagedElementDependent
CIM_ConcreteDependencyCIM_ManagedElementAntecedent
CIM_ConcreteDependencyCIM_ManagedElementDependent
CIM_HostedDependencyCIM_ManagedElementAntecedent
CIM_HostedDependencyCIM_ManagedElementDependent
CIM_ScopedSettingCIM_ManagedElementAntecedent
CIM_ProvidesServiceToElementCIM_ManagedElementDependent
CIM_ElementSoftwareIdentityCIM_ManagedElementDependent
CIM_RecordAppliesToElementCIM_ManagedElementDependent
CIM_AuthenticationTargetCIM_ManagedElementDependent
CIM_ElementAsUserCIM_ManagedElementAntecedent
CIM_AuthorizationSubjectCIM_ManagedElementDependent
CIM_AuthorizationTargetCIM_ManagedElementDependent
CIM_MetricDefForMECIM_ManagedElementAntecedent
CIM_MetricForMECIM_ManagedElementAntecedent
CIM_ComponentCIM_ManagedElementGroupComponent
CIM_ComponentCIM_ManagedElementPartComponent
CIM_ConcreteComponentCIM_ManagedElementGroupComponent
CIM_ConcreteComponentCIM_ManagedElementPartComponent
CIM_LogicalIdentityCIM_ManagedElementSystemElement
CIM_LogicalIdentityCIM_ManagedElementSameElement
CIM_ConcreteIdentityCIM_ManagedElementSystemElement
CIM_ConcreteIdentityCIM_ManagedElementSameElement
CIM_SynchronizedCIM_ManagedElementSystemElement
CIM_SynchronizedCIM_ManagedElementSyncedElement
CIM_StorageSynchronizedCIM_ManagedElementSystemElement
CIM_StorageSynchronizedCIM_ManagedElementSyncedElement
CIM_ServiceAvailableToElementCIM_ManagedElementUserOfService
CIM_ServiceAffectsElementCIM_ManagedElementAffectedElement
CIM_SAPAvailableForElementCIM_ManagedElementManagedElement
CIM_ElementLocationCIM_ManagedElementElement
CIM_MemberOfCollectionCIM_ManagedElementMember
CIM_MemberPrincipalCIM_ManagedElementMember
CIM_ElementInPolicyRoleCollectionCIM_ManagedElementMember
CIM_ElementCapabilitiesCIM_ManagedElementManagedElement
CIM_ElementSettingDataCIM_ManagedElementManagedElement
CIM_ElementProfileCIM_ManagedElementManagedElement
CIM_ElementStatisticalDataCIM_ManagedElementManagedElement
CIM_StatisticsCIM_ManagedElementElement
CIM_ParameterValueSourcesCIM_ManagedElementValueSource
CIM_ParametersForMethodCIM_ManagedElementTheMethod
CIM_OwningJobElementCIM_ManagedElementOwningElement
CIM_AffectedJobElementCIM_ManagedElementAffectedElement
CIM_ElementConformsToProfileCIM_ManagedElementManagedElement
CIM_IdentityContextCIM_ManagedElementElementProvidingContext
CIM_AssignedIdentityCIM_ManagedElementManagedElement
CIM_ElementSecuritySensitivityCIM_ManagedElementManagedElement
CIM_AuthorizedSubjectCIM_ManagedElementPrivilegedElement
CIM_AuthorizedTargetCIM_ManagedElementTargetElement
CIM_PolicySetAppliesToElementCIM_ManagedElementManagedElement