The PRS_SISService is used as a class factory for PRS_Transactions. | Qualifiers:Version ( "2.6.0" ) | Parameters (local in grey) | | uint32EndSISTransaction( | | Status indicates whether the transaction is to be committed or aborted. If Status is zero, the transaction is to be committed. If Status is non-zero, it indicates the transaction is to be aborted. If the transaction is being aborted, the Status field is passed back to the originating system as the CompletionStatus parameter for the PRS_SISService SetSISCompletionStatus method. See the description for PRS_SISService.StartSISTransaction for the definition of the contents of this property. Qualifiers:IN
| | uint32 Status | | | TransactionRef identifies the PRS_Transaction to commit or abort. If this property is NULL or does not identify an 'Open' transaction, this method returns an error. Qualifiers:IN
| | PRS_Transaction REF TransactionRef | ) The EndSISTransaction method is used to handle committing or aborting a transaction. For commit, the method is invoked by a remote system when all of the objects associated with the transaction have been placed in the child namespace created by StartSISTransaction. For abort, the method cleans up the child namespace and closes the specified PRS_Transaction, setting the Transaction's CompletionStatus to the method parameter of the same name. | uint32StartSISTransaction( | | The specific SIS transaction represented by this instance. Qualifiers:ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "254" , "255" }
Values { "Service_Request" , "Entitlement" , "Problem_Submittal" , "Accept_Problem" , "Problem_Resolution" , "Request_Problem_Information" , "Provide_Problem_Information" , "Provide_Admin_Information" , "Query_Incident" , "Confirm_Close" , "Reject_Resolution" , "Request_Closure" , "Other" , "Unknown" }
IN
| | uint8 TransactionType | | | TransactionRef identifies the PRS_Transaction to commit or abort. If this property is NULL or does not identify an 'Open' transaction, this method returns an error. Qualifiers:IN
| | PRS_Activity REF ActivityRef | | | ActivityRef associates a time and description of the activity involved in the service incident transaction. Qualifiers:OUT
IN
| | PRS_Transaction REF TransactionRef | ) When invoked on a local system, this method validates the objects in the local repository, to determine if they are sufficient for the indicated (input parameter) TransactionType. If not, an error is returned and no additional processing is performed. If the repository is successfully validated, this method creates a PRS_Transaction instance for return to the caller. The method also reviews the repository looking for new, modified or deleted objects. As these objects are located, their keys are appended to the related strings in the PRS_Activity instance referenced by another parameter of this method. After all the appropriate new, modified or deleted objects have been located, this method invokes the PRS_SISService's StartSISTransaction method on the remote system specified by the objects related to the Service Incident, associated with the PRS_Activity instance specified as a method parameter. The TransactionType and PRS_Activity REF is forwarded to the remote system as method parameters as well as the PRS_Transaction REF for the instance created by this method. The remote system creates a child namespace using the PRS_Transaction REF for the name. The local system then transfers all of the new, modified and deleted objects to the namespace on the remote system. Once all objects have been successfully transferred, the PRS_SISService's EndSISTransaction method is invoked on the remote system with a Status value of zero to indicate that the remote system should attempt to commit the transaction to the remote repository. The remote system passes the results of the remote commit back to the originating system by invoking the PRS_SISService's SetSISCompletionStatus method on the system that originated the SIS transaction. The CompletionStatus method parameter indicates whether the remote commit was successful. If the CompletionStatis is zero, the remote commit was successful. If it was unsuccessful, the objects were not applied to the remote repository and the CompletionStatus is non-zero, indicating the error. The local invocation of the SetSIS CompletionStatus method updates the specified PRS_Transaction's TransactionState to Closed and CompletionStatus to the value provided by the remote system in the CompletionStatus method parameter. In order to promote extensibility, the uint32 return values for PRS_SISService's methods and Status-related parameters are mapped into three sections. The first describes the type of value being reported. It indicates Error versus Notification, and Standard versus Vendor-Specific. The second section describes the source of the value. It indicates Method, Operating System, Repository, or Transport. In addition, this section indicates whether the value was created locally or remotely. The third section is the specific return value. If all 32 bits of the return value are reset, the method completed successfully. Any other value indicates an error condition or notification. If D31 is set, the method did not complete successfully. If D31 is reset, but the rest of the return value is non-zero, this is a Notification that the operation did complete successfully, but that there is a conditon of which the caller should be aware. If D30 is set, the return value is vendor specific. If D30 is reset, the return value is defined by the standard. If D29 is set, the return value was generated by a remote system. If D29 is reset, the return value was generated locally. The bit is always set or reset by the local system. The local system sets the bit if it receives a non-zero return value from a remote method invocation. Bit D28 is reserved for future use and shall be reset on all return values. When there is an error or notification, D24 through D27 indicate its source. The following sources are currently defined (D24 is the least significant bit below): 0000 Method 0001 Operating System 0010 Repository 0011 Transport All remaining values are reserved. Bits D16 through D23 are reserved for future use and shall be reset to zero. Bits D0 through D15 indicate the specific return value. If zero, all other bits in the return value must be zero, indicating successful completion of the method (or Transaction). | uint32SetSISCompletionStatus( | | This parameter is used to set the CompletionStatus field of the specified PRS_Transaction. If zero, the Transaction was completed successfully. If non-zero, an error occurred and the objects provided in StartSISTransaction were not submitted to the remote repository. See the description for PRS_SISService.StartSISTransaction for the definition of the contents of this property. Qualifiers:IN
| | uint32 CompletionStatus | | | TransactionRef identifies the PRS_Transaction that has completed. If this property is NULL or does not identify an 'Open' transaction, this method returns an error. Qualifiers:IN
| | PRS_Transaction REF TransactionRef | ) SetSISCompletionStatus is used to signal the system that originated a PRS_Transaction that the remote system has completed processing of the transaction. If the processing was successful, as indicated by the CompletionStatus parameter, the local system resets the DirtyFlag for all of the objects identified in the PRS_Activity instance associated with the PRS_Transaction. | MaxLen ( 256 ) Propagated ( "CIM_System.Name" ) Key string SystemName ; The Name of the scoping System. | boolean Started ; Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). | uint32StopService() 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. | MaxLen ( 256 ) Propagated ( "CIM_System.CreationClassName" ) Key string SystemCreationClassName ; The CreationClassName of the scoping System. | MaxLen ( 64 ) MappingStrings { "MIF.DMTF|General Information|001.3" } Write string PrimaryOwnerName ; The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. | uint32StartService() 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. | MaxLen ( 256 ) Key Override ( "Name" ) string Name ; 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. | MaxLen ( 256 ) Key string CreationClassName ; 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. | ValueMap { "Automatic" , "Manual" } MaxLen ( 10 ) Deprecated { "CIM_Service.EnabledDefault" } string StartMode ; 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 ( 256 ) MappingStrings { "MIF.DMTF|General Information|001.4" } Write string PrimaryOwnerContact ; 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). | datetime TimeOfLastStateChange ; The date or time when the EnabledState of the element 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. | ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } string OtherEnabledState ; A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ('Other'). This property must be set to null when EnabledState is any value other than 1. | ValueMap { "2" , "3" , "5" , "6" , "7" , "8..32767" , "32768..65535" } Values { "Enabled" , "Disabled" , "Not Applicable" , "Enabled but Offline" , "No Default" , "DMTF Reserved" , "Vendor Reserved" } Write uint16 EnabledDefault = 2 ; An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is 'Enabled' (value=2). | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , ".." , "4096" , "4097" , "4098" , "4099" , "4100..32767" , "32768..65535" } Values { "Completed with No Error" , "Not Supported" , "Unknown or Unspecified Error" , "Cannot 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" } ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" } uint32RequestStateChange( | | 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'), 3 ('Timeout'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values. Qualifiers: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" }
ModelCorrespondence { "CIM_EnabledLogicalElement.RequestedState" }
IN
| | uint16 RequestedState | | | Reference to the job (can be null if the task is completed). Qualifiers:OUT
IN ( false )
| | CIM_ConcreteJob REF Job | | | 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' must be returned. Qualifiers:IN
| | datetime TimeoutPeriod | ) Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or 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. | ValueMap { "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , ".." , "32768..65535" } Values { "Enabled" , "Disabled" , "Shut Down" , "No Change" , "Offline" , "Test" , "Deferred" , "Quiesce" , "Reboot" , "Reset" , "Not Applicable" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.EnabledState" } uint16 RequestedState = 12 ; RequestedState is an integer enumeration that indicates 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 or disabled states. Note that when EnabledState is set to 5 ('Not Applicable'), then this property has no meaning. By default, the RequestedState of the element is 5 ('No Change'). Refer to the EnabledState 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). Reboot refers to doing a 'Shut Down' and then moving to an 'Enabled' state. Reset indicates that the element is first 'Disabled' and then 'Enabled'. The distinction between requesting 'Shut Down' and 'Disabled' should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. 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 can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ('Not Applicable') is used. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11..32767" , "32768..65535" } Values { "Unknown" , "Other" , "Enabled" , "Disabled" , "Shutting Down" , "Not Applicable" , "Enabled but Offline" , "In Test" , "Deferred" , "Quiesce" , "Starting" , "DMTF Reserved" , "Vendor Reserved" } ModelCorrespondence { "CIM_EnabledLogicalElement.OtherEnabledState" } uint16 EnabledState = 5 ; EnabledState is an integer enumeration that indicates the enabled and 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 and disabled states: Enabled (2) indicates that the element is or 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 does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might 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 might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. The behavior of the element is similar to the Enabled state, but it processes only 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. | ValueMap { "0" , "1" , "2" , "3" , "4" , "5" , "6" , "7" , "8" , "9" , "10" , "11" , "12" , "13" , "14" , "15" , "16" , "17" , "18" , ".." , "0x8000.." } ArrayType ( "Indexed" ) Values { "Unknown" , "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" } ModelCorrespondence { "CIM_ManagedSystemElement.StatusDescriptions" } uint16 OperationalStatus [ ] ; Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail. 'Stressed' indicates that the element is functioning, but needs attention. Examples of 'Stressed' states are overload, overheated, and so on. '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 state and configuration of the element might need to be updated. 'Dormant' indicates that the element is inactive or quiesced. 'Supporting Entity in Error' indicates that this element might 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 that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). 'Power Mode' indicates that 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 because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or 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 (because it is single-valued) should also provide the primary status of the element. | ArrayType ( "Indexed" ) ModelCorrespondence { "CIM_ManagedSystemElement.OperationalStatus" } string StatusDescriptions [ ] ; Strings 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. | ValueMap { "OK" , "Error" , "Degraded" , "Unknown" , "Pred Fail" , "Starting" , "Stopping" , "Service" , "Stressed" , "NonRecover" , "No Contact" , "Lost Comm" , "Stopped" } MaxLen ( 10 ) Deprecated { "CIM_ManagedSystemElement.OperationalStatus" } string Status ; A 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 definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 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. | MappingStrings { "MIF.DMTF|ComponentID|001.5" } datetime InstallDate ; A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. | ValueMap { "0" , "5" , "10" , "15" , "20" , "25" , "30" , ".." } Values { "Unknown" , "OK" , "Degraded/Warning" , "Minor failure" , "Major failure" , "Critical failure" , "Non-recoverable error" , "DMTF Reserved" } uint16 HealthState ; Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: 'Non-recoverable Error' (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. 'Critical Failure' (25) - The element is non-functional and recovery might not be possible. 'Major Failure' (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. 'Minor Failure' (15) - All functionality is available but some might be degraded. 'Degraded/Warning' (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. 'OK' (5) - The element is fully functional and is operating within normal operational parameters and without error. 'Unknown' (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future. | string ElementName ; A 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 the Name property of ManagedSystemElement 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 can be present in both the Name and ElementName properties. | MaxLen ( 64 ) string Caption ; The Caption property is a short textual description (one- line string) of the object. | string Description ; The Description property provides a textual description of the object. |
| | | | |
|