Class CIM_StorageElementCompositionService
extends CIM_Service

Supplies the methods used to create and modify composite elements.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_Service
   |
   +--CIM_StorageElementCompositionService

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringSupplies the methods used to create and modify composite elements.
UMLPackagePathstringCIM::Device::StorageServices
Versionstring2.45.0

Class Properties

Inherited Properties

NameData TypeClass Origin
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_Service
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LoSIDstringCIM_Service
LoSOrgIDstringCIM_Service
NamestringCIM_Service
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PrimaryOwnerContactstringCIM_Service
PrimaryOwnerNamestringCIM_Service
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StartedbooleanCIM_Service
StartModestringCIM_Service
StatusstringCIM_ManagedSystemElement
SystemCreationClassNamestringCIM_Service
SystemNamestringCIM_Service
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TransitioningToStateuint16CIM_EnabledLogicalElement
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
OperationalStatusuint16[]CIM_ManagedSystemElement
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

CreateOrModifyCompositeElement (uint32)

Method Qualifiers (CreateOrModifyCompositeElement)

NameData TypeValue
DescriptionstringCreates (or modifies) a composite element. Note that only like elements can be combined.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Size Not Supported, Vendor Reserved

Method Parameters (CreateOrModifyCompositeElement)

NameTypeQualifiers
NameData TypeValue
CompositeTypeuint16
DescriptionstringType of composite element to create. Possible values are Concatenate, Stripe, Concatenate+Stripe, Vendor specific.
ValueMapstring2, 3, 4, .., 32768..65535
ValuesstringConcatenate elements, Stripe elements, Concatenate and stripe elements, DMTF Reserved, Vendor Reserved
ElementNamestring
DescriptionstringA 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.
ElementSourceuint16
DescriptionstringTell the instrumentation where to get the elements. Only applies when Size is specified and not InElements. Otherwise it shall be NULL. Possible values are: 1. Use existing elements only 2. Create new elements only 3. Can use existing or create new or both 4. Instrumentation decides If NULL, the instrumentation will decide.
ValueMapstring1, 2, 3, 4, .., 0x8000..0xFFFF
ValuesstringUse existing elements only, Create new elements only, Can use existing or create new or both, Instrumentation decides, DMTF Reserved, Vendor Specific
ElementTypeuint16
DescriptionstringEnumeration 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.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, StorageVolume, LogicalDisk, DMTF Reserved, Vendor Reserved
Sizeuint64
DescriptionstringAs an input parameter Size specifies the desired size. If NULL, then InElements shall be supplied. If not NULL, this parameter will supply a new size when modifying an existing element. As an output parameter Size specifies the size achieved.
OUTbooleantrue
PUNITstringbyte
InElementsCIM_StorageExtent[]
DescriptionstringThe elements from which to create the composite element. This parameter shall be NULL if Size is supplied. Once the elements are combined, they will be removed from the model and replaced with a single element. For some instrumentation, this may be one of the InElements, so in effect, all but one are removed.
Goal REF CIM_ManagedElement
DescriptionstringThe QoS requirements for the composite element to maintain. If NULL, then the QoS setting associated to RepresentativeElement will be used for the QoS goal of the composite. If both Goal and RepresentativeElement are null, the instrumentation selects an appropriate Goal from the InElements.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job - may be null if job completed.
INbooleanfalse
OUTbooleantrue
RepresentativeElement REF CIM_StorageExtent
DescriptionstringThe instrumentation will use this parameter to determine the QoS goal of the composite. It will use this parameter + Size or InElements to determine the elements used to construct the composite. This parameter may be NULL. If both Goal and RepresentativeElement are null, the instrumentation selects an appropriate Goal from the InElements.
TheElement REF CIM_LogicalElement
DescriptionstringAs an input parameter: if null, creates a new element. If not null, then the method modifies the specified element. As an output parameter, it is a reference to the resulting element.
OUTbooleantrue

ReturnElementToElements (uint32)

Method Qualifiers (ReturnElementToElements)

NameData TypeValue
DescriptionstringDissolves a composite into its constituent elements.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Vendor Reserved

Method Parameters (ReturnElementToElements)

NameTypeQualifiers
NameData TypeValue
OutElementsCIM_StorageExtent[]
DescriptionstringThe elements the extent was dissolved into.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job - may be null if job completed.
INbooleanfalse
OUTbooleantrue
TheElement REF CIM_LogicalElement
DescriptionstringThe composite element to dissolve. Possible element types are StorageVolume and LogicalDisk.

RemoveElementsFromElement (uint32)

Method Qualifiers (RemoveElementsFromElement)

NameData TypeValue
DescriptionstringRemoves one or more constituent elements from a composite volume. Note, removing a constituent element from a composite element may impact the data stored on the remaining constituent elements (see capabilities). Removing all constituent members is the same as invoking ReturnElementToElements.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Vendor Reserved

Method Parameters (RemoveElementsFromElement)

NameTypeQualifiers
NameData TypeValue
InElementsCIM_LogicalElement[]
DescriptionstringThe elements to remove.
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TheElement REF CIM_LogicalElement
DescriptionstringThe composite element to affect. Possible element types are StorageVolume and LogicalDisk.

GetAvailableElements (uint32)

Method Qualifiers (GetAvailableElements)

NameData TypeValue
DescriptionstringThis method queries the set of pools passed in and returns a set of volumes or logical disks that can be composed together based on the specified goal and element passed in. Since there are usually complicated vendor-specific rules for creating these composite volumes, using the representative element can supply more vendor-specific information than would be in a interoperable setting. The client can then use some or all of this list in a call to CreateOrModifyCompositeElement().
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Vendor Reserved

Method Parameters (GetAvailableElements)

NameTypeQualifiers
NameData TypeValue
ElementTypeuint16
DescriptionstringEnumeration indicating the type of element being created or modified.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, StorageVolume, LogicalDisk, DMTF Reserved, Vendor Reserved
CandidatesCIM_StorageExtent[]
DescriptionstringThe elements that can be used to create the composite element. These will be an array of references to StorageVolumes or LogicalDisks.
OUTbooleantrue
InPoolsCIM_StoragePool[]
DescriptionstringA list of pools to draw the candidate elements from.
Goal REF CIM_StorageSetting
DescriptionstringThe requirements for the element to maintain. This parameter should be a reference to a Setting or Profile appropriate to the element being created. .
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
RepresentativeElement REF CIM_StorageExtent
DescriptionstringServes as a guide to help the instrumentation determine which elements to return. It must be a member of one of the pools passed in. This may be NULL.

GetCompositeElements (uint32)

Method Qualifiers (GetCompositeElements)

NameData TypeValue
DescriptionstringDetermines the component elements of a composite element.
ValueMapstring0, 1, 2, 3, 4, 5, 6, .., 4096, 32768..65535
ValuesstringJob Completed with No Error, Not Supported, Unknown, Timeout, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Job Started, Vendor Reserved

Method Parameters (GetCompositeElements)

NameTypeQualifiers
NameData TypeValue
RequestTypeuint16
DescriptionstringEnumeration indicating the type of elements to return. Immediate: Immediate children of TheElement. Primordial: Dependent storage extents of TheElement at the lowest extent hierarchy.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, Immediate, Primordial, DMTF Reserved, Vendor Reserved
OutElementTypesuint16[]
DescriptionstringA parallel array to OutElements array containing: "Member of Stripe Set" or "Member of Concatenation".
OUTbooleantrue
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, Member of Stripe Set, Member of Concatenation, DMTF Reserved, Vendor Reserved
OutElementsCIM_StorageExtent[]
DescriptionstringThe elements that comprise the composite.
OUTbooleantrue
Job REF CIM_ConcreteJob
DescriptionstringReference to the job (may be null if job completed).
INbooleanfalse
OUTbooleantrue
TheElement REF CIM_LogicalElement
DescriptionstringThe composite element to query.

GetSupportedStripeLengths (uint32)

Method Qualifiers (GetSupportedStripeLengths)

NameData TypeValue
DescriptionstringThis method returns the list of possible stripe lengths which can be used in the property StorageSetting.ExtentStripeLength supplied, as the Goal, to the CreateOrModifyCompositeElement method. Note that different implementations may support either the GetSupportedStripeLengths or the GetSupportedStripeLengthRange method.
ValueMapstring0, 1, 2, 3, .., 32768..65535
ValuesstringMethod Completed with no errors, Method Not Supported, ElementType not supported, Use GetSupportedStripeLengthRange instead, DMTF Reserved, Vendor Reserved

Method Parameters (GetSupportedStripeLengths)

NameTypeQualifiers
NameData TypeValue
ElementTypeuint16
DescriptionstringType of element.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, StorageVolume, LogicalDisk, DMTF Reserved, Vendor Reserved
StripeLengthsuint64[]
DescriptionstringList of supported stripe lengths.
INbooleanfalse
OUTbooleantrue
PUNITstringcount

GetSupportedStripeLengthRange (uint32)

Method Qualifiers (GetSupportedStripeLengthRange)

NameData TypeValue
DescriptionstringFor systems that support a range of stripe lengths for composite volumes, this method can be used to retrieve the range of possible stripe lengths which can be used in the property StorageSetting.ExtentStripeLength supplied, as the Goal, to the CreateOrModifyCompositeElement method. Note that different implementations may support either the GetSupportedStripeLengths or the GetSupportedStripeLengthRange method. If the system only supports discrete values, then the return value will be set to 3.
ValueMapstring0, 1, 2, 3, .., 32768..65535
ValuesstringMethod Completed with no errors, Method Not Supported, ElementType not supported, Use GetSupportedStripeLengths instead, DMTF Reserved, Vendor Reserved

Method Parameters (GetSupportedStripeLengthRange)

NameTypeQualifiers
NameData TypeValue
ElementTypeuint16
DescriptionstringType of element.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, StorageVolume, LogicalDisk, DMTF Reserved, Vendor Reserved
MaximumStripeLengthuint64
DescriptionstringMaximum StripeLength for a composite element.
INbooleanfalse
OUTbooleantrue
MinimumStripeLengthuint64
DescriptionstringMinimum StripeLength for a composite element.
INbooleanfalse
OUTbooleantrue
StripeLengthDivisoruint64
DescriptionstringComposite elements stripe length must be a multiple of this value.
INbooleanfalse
OUTbooleantrue

GetSupportedStripeDepths (uint32)

Method Qualifiers (GetSupportedStripeDepths)

NameData TypeValue
DescriptionstringThis method returns the list of possible stripe depths (aka stripe size)to use in Goal parameter of the CreateOrModifyCompositeElement method for systems that support discrete stripe depths. Note that different implementations may support either the GetSupportedStripeDepths or the GetSupportedStripeDepthRange method.
ValueMapstring0, 1, 2, 3, .., 32768..65535
ValuesstringMethod Completed with no errors, Method Not Supported, ElementType not supported, Use GetSupportedStripeDepthRange instead, DMTF Reserved, Vendor Reserved

Method Parameters (GetSupportedStripeDepths)

NameTypeQualifiers
NameData TypeValue
ElementTypeuint16
DescriptionstringType of element.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, StorageVolume, LogicalDisk, DMTF Reserved, Vendor Reserved
StripeDepthsuint64[]
DescriptionstringList of supported stripe depths.
INbooleanfalse
OUTbooleantrue
PUNITstringbyte

GetSupportedStripeDepthRange (uint32)

Method Qualifiers (GetSupportedStripeDepthRange)

NameData TypeValue
DescriptionstringThis method returns the range of possible stripe depths (aka stripe size) to use in Goal parameter of the CreateOrModifyCompositeElement method. Note that different implementations may support either the GetSupportedStripeDepths or the GetSupportedStripeDepthRange method.
ValueMapstring0, 1, 2, 3, .., 32768..65535
ValuesstringMethod Completed with no errors, Method Not Supported, ElementType not supported, Use GetSupportedStripeDepths instead, DMTF Reserved, Vendor Reserved

Method Parameters (GetSupportedStripeDepthRange)

NameTypeQualifiers
NameData TypeValue
ElementTypeuint16
DescriptionstringType of element.
ValueMapstring0, 2, 3, .., 32768..65535
ValuesstringUnknown, StorageVolume, LogicalDisk, DMTF Reserved, Vendor Reserved
MaximumStripeDepthuint64
DescriptionstringMaximum StripeDepth for a composite element.
INbooleanfalse
OUTbooleantrue
PUNITstringbyte
MinimumStripeDepthuint64
DescriptionstringMinimum StripeDepth for a composite element.
INbooleanfalse
OUTbooleantrue
PUNITstringbyte
StripeDepthDivisoruint64
DescriptionstringComposite elements stripe depth must be a multiple of this value.
INbooleanfalse
OUTbooleantrue
PUNITstringbyte

Inherited Class Methods

NameReturn TypeClass Origin
ChangeAffectedElementsAssignedSequenceuint32CIM_Service
RequestStateChangeuint32CIM_EnabledLogicalElement
StartServiceuint32CIM_Service
StopServiceuint32CIM_Service