Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_StorageConfigurationService --> CIM_Service --> CIM_EnabledLogicalElement --> CIM_LogicalElement --> CIM_ManagedSystemElement --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_Service NAME CIM_StorageConfigurationService
Class CIM_StorageConfigurationService Qualifiers Name Type Value From Class Version string 2.11.0 CIM_StorageConfigurationService Description string 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, StorageVolumes and LogicalDisks). CIM_StorageConfigurationService Description string A CIM_Service is a Logical Element that contains the information that is necessary to represent and manage the functionality provided by a Device or a SoftwareFeature, or both. A Service is a general-purpose object that is used to configure and manage the implementation of functionality. It is not the functionality itself. CIM_Service Description string This class extends LogicalElement to abstract the concept of an element that is enabled and disabled, such as a LogicalDevice or a ServiceAccessPoint. CIM_EnabledLogicalElement Description string CIM_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 Description string CIM_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 Description string ManagedElement 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
Property Qualifiers
Property SystemCreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_Service Propagated string CIM_System.CreationClassName CIM_Service Description string The CreationClassName of the scoping System. CIM_Service MaxLen uint32 256 CIM_Service
Property SystemName Qualifiers Name Type Value From Class Key boolean true CIM_Service Propagated string CIM_System.Name CIM_Service Description string The Name of the scoping System. CIM_Service MaxLen uint32 256 CIM_Service
Property CreationClassName Qualifiers Name Type Value From Class Key boolean true CIM_Service Description string CreationClassName indicates the name of the class or the subclass that is used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified. CIM_Service MaxLen uint32 256 CIM_Service
Property Name Qualifiers Name Type Value From Class Key boolean true CIM_Service Override string Name CIM_Service Description string The Name property uniquely identifies the Service and provides an indication of the functionality that is managed. This functionality is described in more detail in the Description property of the object. CIM_Service MaxLen uint32 256 CIM_Service
Property PrimaryOwnerName Qualifiers Name Type Value From Class Write boolean true CIM_Service Description string The name of the primary owner for the service, if one is defined. The primary owner is the initial support contact for the Service. CIM_Service MaxLen uint32 64 CIM_Service MappingStrings string MIF.DMTF|General Information|001.3 CIM_Service
Property PrimaryOwnerContact Qualifiers Name Type Value From Class Write boolean true CIM_Service Description string A string that provides information on how the primary owner of the Service can be reached (for example, phone number, e-mail address, and so on). CIM_Service MaxLen uint32 256 CIM_Service MappingStrings string MIF.DMTF|General Information|001.4 CIM_Service
Property StartMode Qualifiers Name Type Value From Class Description string Note: The use of this element is deprecated in lieu of the EnabledDefault property that is inherited from EnabledLogicalElement. The EnabledLogicalElement addresses the same semantics. The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property. To remain compatible with those implementations, StartMode was grandfathered into the schema. Use of the deprecated qualifier allows the maintenance of the existing property but also permits an improved, clarified definition using EnabledDefault. Deprecated description: StartMode is a string value that indicates whether the Service is automatically started by a System, an Operating System, and so on, or is started only upon request. CIM_Service ValueMap string [See below.] CIM_Service MaxLen uint32 10 CIM_Service
Name Value Automatic [none] Manual [none]
Property Started Qualifiers Name Type Value From Class Description string Started is a Boolean that indicates whether the Service has been started (TRUE), or stopped (FALSE). CIM_Service
Property EnabledState Qualifiers Name Type Value From Class Description string 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. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Unknown
Other
Enabled
Disabled
Shutting Down
Not Applicable
Enabled but Offline
In Test
Deferred
Quiesce
Starting
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.OtherEnabledState CIM_EnabledLogicalElement
Name Value 0 Unknown 1 Other 2 Enabled 3 Disabled 4 Shutting Down 5 Not Applicable 6 Enabled but Offline 7 In Test 8 Deferred 9 Quiesce 10 Starting 11..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property OtherEnabledState Qualifiers Name Type Value From Class Description string 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. CIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Property RequestedState Qualifiers Name Type Value From Class Description string 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. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
No Change
Offline
Test
Deferred
Quiesce
Reboot
Reset
Not Applicable
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.EnabledState CIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 4 Shut Down 5 No Change 6 Offline 7 Test 8 Deferred 9 Quiesce 10 Reboot 11 Reset 12 Not Applicable .. DMTF Reserved 32768..65535 Vendor Reserved
Property EnabledDefault Qualifiers Name Type Value From Class Write boolean true CIM_EnabledLogicalElement Description string 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). CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Not Applicable
Enabled but Offline
No Default
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement
Name Value 2 Enabled 3 Disabled 5 Not Applicable 6 Enabled but Offline 7 No Default 8..32767 DMTF Reserved 32768..65535 Vendor Reserved
Property TimeOfLastStateChange Qualifiers Name Type Value From Class Description string 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. CIM_EnabledLogicalElement
Property InstallDate Qualifiers Name Type Value From Class Description string A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed. CIM_ManagedSystemElement MappingStrings string MIF.DMTF|ComponentID|001.5 CIM_ManagedSystemElement
Property Name Qualifiers Name Type Value From Class Description string The 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 MaxLen uint32 1024 CIM_ManagedSystemElement
Property OperationalStatus Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string 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 ReservedCIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.StatusDescriptions CIM_ManagedSystemElement
Name Value 0 Unknown 1 Other 2 OK 3 Degraded 4 Stressed 5 Predictive Failure 6 Error 7 Non-Recoverable Error 8 Starting 9 Stopping 10 Stopped 11 In Service 12 No Contact 13 Lost Communication 14 Aborted 15 Dormant 16 Supporting Entity in Error 17 Completed 18 Power Mode .. DMTF Reserved 0x8000.. Vendor Reserved
Property StatusDescriptions Qualifiers Name Type Value From Class Description 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. CIM_ManagedSystemElement ArrayType string Indexed CIM_ManagedSystemElement ModelCorrespondence string CIM_ManagedSystemElement.OperationalStatus CIM_ManagedSystemElement
Property Status Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement MaxLen uint32 10 CIM_ManagedSystemElement
Name Value 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 HealthState Qualifiers Name Type Value From Class Description string 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. CIM_ManagedSystemElement ValueMap string [See below.] CIM_ManagedSystemElement Values string Unknown
OK
Degraded/Warning
Minor failure
Major failure
Critical failure
Non-recoverable error
DMTF ReservedCIM_ManagedSystemElement
Name Value 0 Unknown 5 OK 10 Degraded/Warning 15 Minor failure 20 Major failure 25 Critical failure 30 Non-recoverable error .. DMTF Reserved
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description 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. 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. CIM_ManagedElement
Method Qualifiers
Method CreateOrModifyStoragePool Qualifiers Name Type Value From Class Description string Starts 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Size Not Supported
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method CreateOrModifyElementFromStoragePool Qualifiers Name Type Value From Class Description string Start 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Size Not Supported
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method DeleteStoragePool Qualifiers Name Type Value From Class Description string Start a job to delete a StoragePool. The freed space is returned source StoragePools (indicated by AllocatedFrom StoragePool) 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method ReturnToStoragePool Qualifiers Name Type Value From Class Description string Start 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method CreateReplica Qualifiers Name Type Value From Class Description string Start 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method ModifySynchronization Qualifiers Name Type Value From Class Description string Modify (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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unspecified Error
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method AttachReplica Qualifiers Name Type Value From Class Description string Create (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 source and 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unspecified Error
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method AttachOrModifyReplica Qualifiers Name Type Value From Class Description string Create (or start a job to create) a StorageSynchronized mirror relationship between two storage elements. The target element may be a local or a remote storage element. A remote mirror pair may be scoped by a peer-to-peer connection modeled as a NetworkPipe between peers. If Job Completed with No Error (0) is returned, the function completed successfully and a ConcreteJob instance is not created. If Method Parameters Checked - Job Started (0x1000) is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of Not Supported (1) indicates the method is not supported. All other values indicate some type of error condition. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unspecified Error
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method CreateOrModifyReplicationPipe Qualifiers Name Type Value From Class Description string This method establishes a peer-to-peer connection identified by a NetworkPipe element and two ProtocolEndpoint elements created by the method provider. The NetworkPipe is associated to a special peer-to-peer Network element. The provider will verify that two systems are capable of a peer relationship. If endpoints are assigned to the pipe, the same number of source and target endpoints must be supplied by the client to form a set of endpoint pairs. If ReplicationPipe is not supplied as an input parameter, a new pipe is created. If a pipe is supplied, a new set of endpoints is assigned to the existing pipe. If Success (0) is returned, the function completed successfully. A return value of Not Supported (1) indicates the method is not supported. A return value of Busy (0x1000) indicates the method is not supported. All other values indicate some type of error condition. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Success
Not Supported
Unspecified Error
Timeout
Failed
Invalid Parameter
DMTF Reserved
Busy
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method CreateReplicationBuffer Qualifiers Name Type Value From Class Description string Create (or start a job to create) a replication buffer that buffers asynchronous write operations for remote mirror pairs. The buffer is an instance of CIM_Memory with an AssociatedMemory association to a hosting system or to a replication network pipe. The buffer element may be created based on a StorageExtent, in a pool or in a manner opaque to a client. 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. If Job Completed with No Error (0) is returned, the function completed successfully and a ConcreteJob instance is not created. If Method Parameters Checked - Job Started (0x1000) is returned, a ConcreteJob is started, a reference to which is returned in the Job output parameter. A return value of Not Supported (1) indicates the method is not supported. All other values indicate some type of error condition. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Job Completed with No Error
Not Supported
Unspecified Error
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method CreateOrModifyElementFromElements Qualifiers Name Type Value From Class Description string Start a job to create (or modify) a specified storage element from specified input StorageExtents. The created or modified storage element can be a StorageExtent, StorageVolume, LogicalDisk, or StoragePool. An input list of InElements must be specified. The GetAvailableExtents method can be used to get a list of valid extents that can be used to achieve a desired goal. Validity of the extents is determined by the implementation. 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 InElements. The desired Settings for the element are specified by the Goal parameter. If the size of Extents passed is less than the size requested, then the capacity is drawn from the extents in the order, left to right, that the Extents were specified. The partial consumption of an Extent is represented by an Extent for the capacity used and an Extent for the capacity not used. If the Size is NULL, then a configuration using all Extents passed will be attempted. 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Completed with No Error
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
In Use
DMTF Reserved
Method Parameters Checked - Job Started
Size Not Supported
Method Reserved
Vendor SpecificCIM_StorageConfigurationService
Method ScsiScan Qualifiers Name Type Value From Class Description string This method requests that the system rescan SCSI devices for changes in their configuration. If called on a general-purpose host, the changes are reflected in the list of devices available to applications (for example, the UNIX ’ device tree ’ . This method may also be used on a storage appliance to force rescanning of attached SCSI devices. This operation can be disruptive; optional parameters allow the caller to limit the scan to a single or set of SCSI device elements. All parameters are optional; if parameters other Job are passed in as null, a full scan is invoked. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Success
Not Supported
Unknown
Timeout
Failed
Invalid Parameter
DMTF Reserved
Invalid connection type
Invalid Initiator
No matching target found
No matching LUs found
Prohibited by name binding configuration
DMTF Reserved
Vendor SpecificCIM_StorageConfigurationService
Method StartService Qualifiers Name Type Value From Class Description string The StartService method places the Service in the started state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StartService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully started, 1 if the request is not supported, and any other number to indicate an error. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are translated can also be specified in the subclass as a Values array qualifier. Note: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple " start " semantics are convenient to use. CIM_Service
Method StopService Qualifiers Name Type Value From Class Description string The StopService method places the Service in the stopped state. Note that the function of this method overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (such as a persisted value) of the last state request. Invoking the StopService method should set the RequestedState property appropriately. The method returns an integer value of 0 if the Service was successfully stopped, 1 if the request is not supported, and any other number to indicate an error. In a subclass, the set of possible return codes could be specified using a ValueMap qualifier on the method. The strings to which the ValueMap contents are translated can also be specified in the subclass as a Values array qualifier. Note: The semantics of this method overlap with the RequestStateChange method that is inherited from EnabledLogicalElement. This method is maintained because it has been widely implemented, and its simple " stop " semantics are convenient to use. CIM_Service
Method RequestStateChange Qualifiers Name Type Value From Class Description string 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. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string 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 SpecificCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement Parameters
Method CreateOrModifyStoragePool Parameters Name Type Qualifiers ElementName string IN
DescriptionSize uint64 IN
OUT
Description
UnitsInPools string IN
DescriptionInExtents string IN
Description
Method CreateOrModifyElementFromStoragePool Parameters Name Type Qualifiers ElementName string IN
DescriptionElementType uint16 IN
Description
ValueMap
ValuesSize uint64 IN
OUT
Description
Units
Method CreateReplica Parameters Name Type Qualifiers ElementName string IN
DescriptionCopyType uint16 IN
Description
ValueMap
Values
Method ModifySynchronization Parameters Name Type Qualifiers Operation uint16 IN
Description
ValueMap
Values
Method AttachReplica Parameters Name Type Qualifiers CopyType uint16 IN
Description
ValueMap
Values
Method AttachOrModifyReplica Parameters Name Type Qualifiers CopyType uint16 Required
IN
Description
ValueMap
ValuesGoal string IN
Description
EmbeddedInstance
Method CreateOrModifyReplicationPipe Parameters Name Type Qualifiers PipeElementName string IN
DescriptionGoal string IN
Description
EmbeddedInstance
Method CreateOrModifyElementFromElements Parameters Name Type Qualifiers ElementName string IN
DescriptionElementType uint16 Required
IN
Description
ValueMap
ValuesSize uint64 IN
OUT
Description
Units
Method ScsiScan Parameters Name Type Qualifiers ConnectionType uint16 Description
ValueMap
Values
ModelCorrespondenceOtherConnectionType string Description Targets string Description LogicalUnits string Description
Method RequestStateChange Parameters Name Type Qualifiers RequestedState uint16 IN
Description
ValueMap
Values
ModelCorrespondenceTimeoutPeriod datetime IN
DescriptionParameter Qualifiers
Parameter ElementName Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description 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. CIM_StorageConfigurationService
Parameter Size Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService OUT boolean true CIM_StorageConfigurationService Description string As an input parameter this specifies the desired pool size in bytes. As an output parameter this specifies the size achieved. CIM_StorageConfigurationService Units string Bytes CIM_StorageConfigurationService
Parameter InPools Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string Array of strings containing representations of references to CIM_StoragePool instances, that are used to create the Pool or modify the source pools. CIM_StorageConfigurationService
Parameter InExtents Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string Array of strings containing representations of references to CIM_StorageExtent instances, that are used to create the Pool or modify the source extents. CIM_StorageConfigurationService
Parameter ElementName Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description 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. CIM_StorageConfigurationService
Parameter ElementType Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string Enumeration 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. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Unknown
Reserved
StorageVolume
StorageExtent
LogicalDisk
DMTF Reserved
Vendor SpecificCIM_StorageConfigurationService
Parameter Size Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService OUT boolean true CIM_StorageConfigurationService Description string 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. CIM_StorageConfigurationService Units string Bytes CIM_StorageConfigurationService
Parameter ElementName Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description 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. CIM_StorageConfigurationService
Parameter CopyType Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string CopyType describes the type of copy that will be made. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. UnSyncUnAssoc: Create unassociated copy of the source element. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Async
Sync
UnSyncAssoc
UnSyncUnAssoc
DMTF Reserved
Vendor SpecificCIM_StorageConfigurationService
Parameter Operation Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string Operation describes the type of modification to be made to the replica. Values are: Detach: ’ Forget ’ the synchronization between two storage objects. Start to treat the objects as independent. Fracture: Suspend the synchronization between two storage objects using Sync or Async replication. 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. Resync Replica: Re-establish the synchronization of a Sync or Async replication. This will negate the action of a previous Fracture operation. Recreate a Point In Time image for an UnSyncAssoc replication. Restore from Replica: Renew the contents of the original storage object from a replica. 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. May start the copy engine. Unprepare: Clear a prepared state if a Prepare is not to be followed by a Resync operation. Quiesce: Some applications require notification so that they can ready the link for an operation. For example flush any cached data or buffered changes. The copy engine is stopped for UnSyncAssoc replications. Unquiesce: Take the link from the quiesced state (without executing the intended operation. Start Copy: initiate a full background copy of the source to the UnSyncAssoc replica. Replica enters Frozen state when copy operation is completed. Stop Copy: stop the background copy previously started. Reset To Sync: Change the CopyType of the association to Sync (e.g., from the Async CopyType). Reset To Async: Change the CopyType of the association to Async (e.g., from the Sync CopyType). CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string DMTF Reserved
DMTF Reserved
Detach
Fracture
Resync Replica
Restore from Replica
Prepare
Unprepare
Quiesce
Unquiesce
Reset To Sync
Reset To Async
Start Copy
Stop Copy
DMTF Reserved
Vendor SpecificCIM_StorageConfigurationService
Parameter CopyType Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string CopyType describes the type of Synchronized relationship that will be created. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source. UnSyncUnAssoc: Create unassociated copy of the source element. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Async
Sync
UnSyncAssoc
UnSyncUnAssoc
DMTF Reserved
Vendor SpecificCIM_StorageConfigurationService
Parameter CopyType Qualifiers Name Type Value From Class Required boolean true CIM_StorageConfigurationService IN boolean true CIM_StorageConfigurationService Description string CopyType describes the type of Synchronized relationship that will be created. Values are: Async: Create and maintain an asynchronous copy of the source. Sync: Create and maintain a synchronized copy of the source. UnSyncAssoc: Create an unsynchronized copy and maintain an association to the source element. UnSyncUnAssoc: Create an unassociated copy of the source element. UnSyncAssoc and UnSyncUnAssoc are not supported for remote mirror replicas. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Async
Sync
UnSyncAssoc
UnSyncUnAssoc
DMTF Reserved
Vendor SpecificCIM_StorageConfigurationService
Parameter Goal Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string The StorageSetting properties to be created or modified for the target element. CIM_StorageConfigurationService EmbeddedInstance string CIM_SettingData CIM_StorageConfigurationService
Parameter PipeElementName Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string A user-friendly name for the element created. CIM_StorageConfigurationService
Parameter Goal Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description string The setting properties to be maintained for the peer-to-peer connection. CIM_StorageConfigurationService EmbeddedInstance string CIM_SettingData CIM_StorageConfigurationService
Parameter ElementName Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService Description 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. CIM_StorageConfigurationService
Parameter ElementType Qualifiers Name Type Value From Class Required boolean true CIM_StorageConfigurationService IN boolean true CIM_StorageConfigurationService Description string Enumeration 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. The actual CIM class of the created TheElement can be vendor-specific, but it must be a derived class of the appropriate CIM class -- i.e., CIM_StorageVolume, CIM_StorageExtent, CIM_LogicalDisk, or CIM_StoragePool. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Unknown
Reserved
Storage Volume
Storage Extent
Storage Pool
Logical Disk
DMTF Reserved
Vendor SpecificCIM_StorageConfigurationService
Parameter Size Qualifiers Name Type Value From Class IN boolean true CIM_StorageConfigurationService OUT boolean true CIM_StorageConfigurationService Description string 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. CIM_StorageConfigurationService Units string Bytes CIM_StorageConfigurationService
Parameter ConnectionType Qualifiers Name Type Value From Class Description string The type of connection, constrains the scan to initiator ports of this type. Only used if the Initiators parameter is null. CIM_StorageConfigurationService ValueMap string [See below.] CIM_StorageConfigurationService Values string Other
Fibre Channel
Parallel SCSI
SSA
IEEE 1394
RDMA
iSCSI
SAS
ADTCIM_StorageConfigurationService ModelCorrespondence string CIM_SCSIProtocolEndpoint.ConnectionType CIM_StorageConfigurationService
Parameter OtherConnectionType Qualifiers Name Type Value From Class Description string The connection type, if the ConnectionType parameter is " Other " . CIM_StorageConfigurationService
Parameter Targets Qualifiers Name Type Value From Class Description string A list of names or numbers for targets. These should be formatted to match the appropriate connection type, For example, PortWWNs would be specified for Fibre Channel targets. CIM_StorageConfigurationService
Parameter LogicalUnits Qualifiers Name Type Value From Class Description string A list of SCSI logical unit numbers representing logical units hosted on the targets specified in the Targets argument. CIM_StorageConfigurationService
Parameter RequestedState Qualifiers Name Type Value From Class IN boolean true CIM_EnabledLogicalElement Description string 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. CIM_EnabledLogicalElement ValueMap string [See below.] CIM_EnabledLogicalElement Values string Enabled
Disabled
Shut Down
Offline
Test
Defer
Quiesce
Reboot
Reset
DMTF Reserved
Vendor ReservedCIM_EnabledLogicalElement ModelCorrespondence string CIM_EnabledLogicalElement.RequestedState CIM_EnabledLogicalElement
Parameter TimeoutPeriod Qualifiers Name Type Value From Class IN boolean true CIM_EnabledLogicalElement Description string 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. CIM_EnabledLogicalElement