Index | Tree | ||
Subclasses | Referenced By | Properties | Methods |
Superclasses
Subclasses
IBMTSESS_StorageConfigurationService,IBMTSESS_AsyncPPRCServiceReferenced By
none
Description
This service allows the active management of a Storage Server. It allows jobs to be started for the creation, modification and deletion of storage objects (StoragePools and StorageVolumes).Properties
Id Type Range Description Keys SystemCreationClassName string Max = 256 The scoping System's CreationClassName. SystemName string Max = 256 The scoping System's Name. CreationClassName string Max = 256 CreationClassName 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. Name string Max = 256 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 object's Description property. Writeable PrimaryOwnerName string Max = 64 The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. PrimaryOwnerContact string Max = 256 A string that provides information on how the primary owner of the Service can be reached (e.g. phone number, email address, ...). EnabledDefault uint16 Enabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor ReservedAn enumerated value indicating an administrator's default/startup configuration for an element's Enabled State. By default, the element is \"Enabled\" (value=2). Read only StartMode string Automatic
ManualStartMode 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. Started boolean - Started is a boolean indicating whether the Service has been started (TRUE), or stopped (FALSE). EnabledState uint16 Unknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor ReservedEnabledState 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: \nEnabled (2) indicates that the element is/could be executing commands, will process any queued commands, and queues new requests. \nDisabled (3) indicates that the element will not execute commands and will drop any new requests. \nShutting Down (4) indicates that the element is in the process of going to a Disabled state. \nNot Applicable (5) indicates the element doesn't support being enabled/disabled. \nEnabled but Offline (6) indicates that the element may be completing commands, and will drop any new requests. \nTest (7) indicates that the element is in a test state. \nDeferred (8) indicates that the element may be completing commands, but will queue any new requests. \nQuiesce (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. \nStarting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued. OtherEnabledState string - A 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. RequestedState uint16 Enabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
DMTF Reserved
Vendor ReservedRequestedState 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. \n\nIt 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. \n\nThis 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. TimeOfLastStateChange datetime - The 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. InstallDate datetime - A datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed. OperationalStatus uint16[ ] 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 ReservedIndicates 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. \n\"Stressed\" indicates that the element is functioning, but needs attention. Examples of \"Stressed\" states are overload, overheated, etc. \n\"Predictive Failure\" indicates that an element is functioning nominally but predicting a failure in the near future. \n\"In Service\" describes an element being configured, maintained, cleaned, or otherwise administered. \n\"No Contact\" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. \n\"Lost Communication\" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. \n\"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. \n\"Dormant\" indicates that the element is inactive or quiesced. \n\"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. \n\"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. \n\"Power Mode\" indicates the element has additional power model information contained in the Associated PowerManagementService association. \nOperationalStatus 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. StatusDescriptions string[ ] - 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. Status string OK
Error
Degraded
Unknown
Pred Fail
Starting
Stopping
Service
Stressed
NonRecover
No Contact
Lost Comm
StoppedA 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. Caption string Max = 64 The Caption property is a short textual description (one- line string) of the object. Description string - The Description property provides a textual description of the object. ElementName string - 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. \nNote 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. Method Summary
Name Description CreateOrModifyStoragePool Starts a job to create (or modify) a StoragePool. CreateOrModifyElementFromStoragePool Start a job to create (or modify) a specified element (for example a StorageVolume or StorageExtent) from a StoragePool. DeleteStoragePool Start a job to delete a StoragePool. ReturnToStoragePool Start a job to delete an element previously created from a StoragePool. CreateReplica Start a job to create a new storage object which is a replica of the specified source storage object. ModifySynchronization Modify (or start a job to modify) the synchronization association between two storage objects. ModifyConsistencySet Method to manipulate ConsistencySets. CreateSynchronization Method to create a StorageSynchronized association. DeleteSynchronization Method to delete a StorageSynchronized association. CreateConsistencySet Method to create a ConsistencySet. DeleteConsistencySet Method to delete a ConsistencySet. CreateSynchronizedSet Method to create a SynchronizedSet. DeleteSynchronizedSet Method to delete a SynchronizedSet. ModifySynchronizedSet Method to manipulate SynchronizedSets. GetSupportedSetTypes This method returns the types of sets that are supported by the device. AttachReplica Create (or start a job to create) a StorageSynchronized relationship between two existing storage objects. StartService The StartService method places the Service in the started state. StopService The StopService method places the Service in the stopped state. RequestStateChange Requests that the element's state be changed to the value specified in the RequestedState parameter. Method Detail
CreateOrModifyStoragePool
StaticStarts a job to create (or modify) a StoragePool. The StoragePool will be (or must be) scoped to the same System as this Service. One of the parameters for this method is Size. As an input parameter, Size specifies the desired size of the pool. As an output parameter, it specifies the size achieved. Space is taken from either or both of the specified input StoragePools and StorageExtents (InPools and InExtents). The capability requirements that the Pool must support are defined using the Goal parameter. If the requested pool size cannot be created, no action will be taken, the Return Value will be 4097/0x1001, and the output value of Size will be set to the nearest possible size. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If the task will take some time to complete, a ConcreteJob will be created and its reference returned in the output parameter Job.Parameters
Id Type Range Description In ElementName string - A end user relevant name for the pool being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created pool. If not NULL, this parameter will supply a new name when modifying an existing pool. Size uint64 - As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved. Out Size uint64 - As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved.
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 4096 Size Not Supported 4097 Method Reserved 4098..32767 Vendor Specific 32768..65535
CreateOrModifyElementFromStoragePool
StaticStart a job to create (or modify) a specified element (for example a StorageVolume or StorageExtent) from a StoragePool. One of the parameters for this method is Size. As an input parameter, Size specifies the desired size of the element. As an output parameter, it specifies the size achieved. Space is taken from the input StoragePool. The desired settings for the element are specified by the Goal parameter. If the requested size cannot be created, no action will be taken, and the Return Value will be 4097/0x1001. Also, the output value of Size is set to the nearest possible size. If 0 is returned, the function completed successfully and no ConcreteJob instance was required. If 4096/0x1000 is returned, a ConcreteJob will be started to create the element. The Job's reference will be returned in the output parameter Job.Parameters
Id Type Range Description In ElementName string - A end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element. If not NULL, this parameter will supply a new name when modifying an existing element. ElementType uint16 Unknown
Reserved
StorageVolume
StorageExtent
DMTF Reserved
Vendor SpecificEnumeration indicating the type of element being created or modified. If the input parameter TheElement is specified when the operation is a 'modify', this type value must match the type of that instance. Size uint64 - As an input parameter Size specifies the desired size. If not NULL, this parameter will supply a new size when modifying an existing element. As an output parameter Size specifies the size achieved. Out Size uint64 - As an input parameter Size specifies the desired size. If not NULL, this parameter will supply a new size when modifying an existing element. As an output parameter Size specifies the size achieved.
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 4096 Size Not Supported 4097 Method Reserved 4098..32767 Vendor Specific 32768..65535
DeleteStoragePool
StaticStart a job to delete a StoragePool. The freed space is returned source StoragePools (indicated by AllocatedFromStoragePool) or back to underlying storage extents. If 0 is returned, the function completed successfully, and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the StoragePool. A reference to the Job is returned in the Job parameter.Parameters
Id Type Range Description
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 4096 Method Reserved 4097..32767 Vendor Specific 32768..65535
ReturnToStoragePool
StaticStart a job to delete an element previously created from a StoragePool. The freed space is returned to the source StoragePool. If 0 is returned, the function completed successfully and no ConcreteJob was required. If 4096/0x1000 is returned, a ConcreteJob will be started to delete the element. A reference to the Job is returned in the Job parameter.Parameters
Id Type Range Description
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 4096 Method Reserved 4097..32767 Vendor Specific 32768..65535
CreateReplica
StaticStart a job to create a new storage object which is a replica of the specified source storage object. (SourceElement). Note that using the input paramter, CopyType, this function can be used to instantiate the replica, and to create an ongoing association between the source and replica. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 4096/0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.Parameters
Id Type Range Description In ElementName string - A end user relevant name for the element being created. If NULL, then a system supplied default name can be used. The value will be stored in the 'ElementName' property for the created element. CopyType uint16 Async
Sync
UnSyncAssoc
UnSyncUnAssoc
DMTF Reserved
Vendor SpecificCopyType describes the type of copy that will be made. Values are: \n Async: Create and maintain an asynchronous copy of the source. \n Sync: Create and maintain a synchronized copy of the source. \n UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. \n UnSyncUnAssoc: Create unassociated copy of the source element.
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 4096 Method Reserved 4097..32767 Vendor Specific 32768..65535
ModifySynchronization
StaticModify (or start a job to modify) the synchronization association between two storage objects. If 0 is returned, the function completed successfully and no ConcreteJob instance was created. If 0x1000 is returned, a ConcreteJob was started and a reference to this Job is returned in the Job output parameter. A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.Parameters
Id Type Range Description In Operation uint16 DMTF Reserved
DMTF Reserved
Detach
Fracture
Resync Replica
Restore from Replica
Prepare
Unprepare
Quiesce
Unquiesce
Reset To Sync
Reset To Async
DMTF Reserved
Vendor SpecificOperation describes the type of modification to be made to the replica. Values are: \n Detach: 'Forget' the synchronization between two storage objects. Start to treat the objects as independent. \n Fracture: Suspend the synchronization between two storage objects. The association and (typically) changes are remembered to allow a fast resynchronization. This may be used during a backup cycle to allow one of the objects to be copied while the other remains in production. \n Resync Replica: Re-establish the synchronization of a replica. This will negate the action of a previous Fracture operation. \n Restore from Replica: Renew the contents of the original storage object from a replica. \n Prepare: Get the link ready for a Resync operation to take place. Some implementations will require this operation to be invoked to keep the Resync operation as fast as possible.\n Unprepare: Clear a prepared state if a Prepare is not to be followed by a Resync operation. \n Quiesce: Some applications require notification so that they can ready the link for an operation. For example flush any cached data or buffered changes.\n Unquiesce: Take the link from the quiesced state (without executing the intended operation.\n Reset To Sync: Change the CopyType of the association to Sync (e.g., from the Async CopyType). \n Reset To Async: Change the CopyType of the association to Async (e.g., from the Sync CopyType).
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unspecified Error 2 Timeout 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 0x1000 Method Reserved 0x1001..0x7FFF Vendor Specific 0x8000..0xFFFF
ModifyConsistencySet
StaticMethod to manipulate ConsistencySets. Since thereare two types of ConsistencySets the error Wrong Member Typeis thrown when it is attempted to add a volume to aConistencySet whose MemberType is 1 (aggregating StorageSynchrnoizeds)and vice versa (adding StorageSynchrnoizeds to a set with MemberType 0)or invoking a method that operates onStorageSynchrnoized when the ConsistencySet has a MemberTypeof 0 (aggreagating volumesParameters
Id Type Range Description In Operation uint16 DMTF Reserved
DMTF Reserved
Add
Remove
DMTF Reserved
Vendor SpecificOperation describes the type of modification to bemade to the ConsistencySet. Values are: Add: Add the passed StorageElement to the set. Remove: Remove the passed StorageElement from the set.
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 Wrong Member Type 6 DMTF Reserved .. Method Parameters Checked - Job Started 0x1000 Method Reserved 0x1001..0x7777 Vendor Specific 0x8000..
CreateSynchronization
StaticMethod to create a StorageSynchronized association. Optionallythis association can be added to a ConsistencySet which has beencreated before. If the device doesn't support aggregating associationsin ConsistencySets it is not permitted to pass in a ConsistencySet.In order to find out what kind of ConsistencySets a device supportscall GetSupportedSetTypes.Parameters
Id Type Range Description In CopyType uint16 - The copy type of this copy relation. SeeStorageSynchronized.CopyType. ElementName string - The ElementName property of the StorageSynchronizedto be created.
Return Codes Id Success 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 CopyType not supported 6 ConsistencySets not supported 7 SynchronizedSets not supported 8 System- and SyncedElement must be volumes if Set is passed in 9 DMTF Reserved .. Vendor Specific 0x8000..
DeleteSynchronization
StaticMethod to delete a StorageSynchronized association. If thecopy relation is part of a SynchronizedSet it may have to be removedfrom this set before this method is called by calling:ModifySynchronizedSet('Remove'). If there is a copyjob started and not yet finished the association cannot be deleteduntil the job is completed. This method does not delete theconnected volumes.Parameters
Id Type Range Description
Return Codes Id Success 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 Synchronization is member of SynchronizedSet 6 Copy in process 7 DMTF Reserved .. Vendor Specific 0x8000..
CreateConsistencySet
StaticMethod to create a ConsistencySet. Some devices may not supportConsistencySets. In order to find out if ConsistencySets are supportedcall GetSupportedSetTypes.Parameters
Id Type Range Description In CopyType uint16 - The copy type for associations in this set. SeeStorageSynchronized.CopyType. This parameter may be optional forsome devices ElementName string - The ElementName property of the ConsistencySet thatwill be created. See ConsistencySet.ElementName
Return Codes Id Success 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 CopyType not supported 6 ConsistencySets not supported 7 DMTF Reserved .. Vendor Specific 0x8000..
DeleteConsistencySet
StaticMethod to delete a ConsistencySet.Parameters
Id Type Range Description
Return Codes Id Success 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 ConsistencySet is not empty 6 DMTF Reserved .. Vendor Specific 0x8000..
CreateSynchronizedSet
StaticMethod to create a SynchronizedSet. Some devices may not supportSynchronizedSets. In order to find out if SynchronizedSets are supportedcall GetSupportedSetTypes.Parameters
Id Type Range Description In CopyType uint16 - The copy type for associations in this set. SeeStorageSynchronized.CopyType. This parameter may be optional forsome devices ElementName string - The ElementName property of the SynchronizedSet thatwill be created. See SynchronizedSet.ElementName
Return Codes Id Success 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 CopyType not supported 6 SynchronizedSets not supported 8 DMTF Reserved .. Vendor Specific 0x8000..
DeleteSynchronizedSet
StaticMethod to delete a SynchronizedSet. If the set containsStorageSynchronized associations they have to be removedfrom this set before this method is called by calling:ModifySynchronizedSet('Remove').Parameters
Id Type Range Description
Return Codes Id Success 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 SynchronizedSet is not empty 6 DMTF Reserved .. Vendor Specific 0x8000..
ModifySynchronizedSet
StaticMethod to manipulate SynchronizedSets.Parameters
Id Type Range Description In Operation uint16 DMTF Reserved
DMTF Reserved
Add
Remove
Delete Synchronizations
Fracture Replicas
Resync Replicas
Restore From Replicas
Prepare All
DMTF Reserved
Vendor SpecificOperation describes the type of modification to bemade to the SynchronizedSet. Values are: Add: Add the passed StorageElement to the set. Remove: Remove the passed StorageElement from the set. Delete Synchronizations: All StorageSynchronized associationsin this SynchronizedSet are deleted. Fracture Replicas: Suspend the synchronizationw between all storage objects in the set. The associations and (typically) changes are remembered to allow a fast resynchronization. This may be used during a backup cycle to allow one of the objects to be copied while the other remains in production. \n Resync Replicas: Re-establish the synchronizations of all replicas in the set. If CopyType is Sync or Async, this will negate the action of a previous Fracture operation. \n Restore from Replica: Renew the contents of the original storage objects from tbe replicas. Prepare All: Prepare the participating volumes fora point in time copy.
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 Invalid Parameter 5 Operatio not supported 6 StorageSynchronized not in the Set 7 StorageSynchronized already in a Set 8 DMTF Reserved .. Method Parameters Checked - Job Started 0x1000 Method Reserved 0x1001..0x7777 Vendor Specific 0x8000..
GetSupportedSetTypes
StaticThis method returns the types of sets that are supported by the device.Parameters
Id Type Range Description
Return Codes Id Success 0 Not Supported 1 Unknown 2 Timeout 3 Failed 4 DMTF Reserved .. Vendor Specific 0x8000..
AttachReplica
StaticCreate (or start a job to create) a StorageSynchronized relationship between two existing storage objects. Note that using the input parameter, CopyType, this function can be used to to create an ongoing association between the sourceand replica. If 0 is returned, the function completed successfully and no ConcreteJob instance is created. If 0x1000 is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter.A return value of 1 indicates the method is not supported. All other values indicate some type of error condition.Parameters
Id Type Range Description In CopyType uint16 Async
Sync
UnSyncAssoc
UnSyncUnAssoc
DMTF Reserved
Vendor SpecificCopyType describes the type of Synchronized relationship that will be created. Values are: \n Async: Create and maintain an asynchronous copy of the source. \n Sync: Create and maintain a synchronized copy of the source. \n UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. \n UnSyncUnAssoc: Create unassociated copy of the source element.
Return Codes Id Job Completed with No Error 0 Not Supported 1 Unspecified Error 2 Timeout 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 0x1000 Method Reserved 0x1001..0x7FFF Vendor Specific 0x8000..0xFFFF
StartService
StaticThe 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. \n\nNote 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.Parameters
Id Type Range Description
Return Codes Id
StopService
StaticThe 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. \n\nNote 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.Parameters
Id Type Range Description
Return Codes Id
RequestStateChange
StaticRequests 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. \nIf 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.Parameters
Id Type Range Description In RequestedState uint16 Enabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor ReservedThe 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. TimeoutPeriod datetime - 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. \nIf 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.
Return Codes Id Completed with No Error 0 Not Supported 1 Unknown/Unspecified Error 2 Can NOT complete within Timeout Period 3 Failed 4 Invalid Parameter 5 In Use 6 DMTF Reserved .. Method Parameters Checked - Job Started 4096 Invalid State Transition 4097 Use of Timeout Parameter Not Supported 4098 Busy 4099 Method Reserved 4100..32767 Vendor Specific 32768..65535