Class CIM_StorageSetting

extends CIM_SettingData
StorageSetting is roughly equivalent to a Service Level Agreement (SLA) It defines the characteristics, qualities of service and goals when used in a CreateOrModifyElement FromStoragePool or CreateOrModifyStoragePool method in the StorageConfigurationService. It specifies a series of properties with Maximum and Minimum values that define the (inclusive) bounds that the object should maintain. Note that the setting is associated to a StorageVolume or LogicalDisk, using ElementSetting. The use of these properties differs depending on whether the StorageSetting instance is being used as a goal for a configuration operation or being used as a Service Level Agreement for a created Volume. In addition the properties fall into two categories: The QOS properties(PackageRedundancy, Data Redundancy, & NoSinglePointOfFailure) and the Detailed RAID properties(ExtentStripeLength, ParityLayout, and UserDataStripeDepth). In a Setting used as a goal, the QOS properties are required as a set; The Detailed RAID properties(if supported as indicated by the scoping StorageCapabilities instance) may be used optionally in any combination. The implementation MUST supply it's own best practice in the case where one or more supported RAID properties are not supplied. In this situation the use of StorageSettingWithHints can be useful to provide direction to the implementation. In a Setting used as a service agreement for a Volume, the QOS properties reflect the Service Level Agreement, with goal, min, & max. The actual current service level is exposed by corresponding values in StorageExtent. The Detailed RAID properties, by contrast, reflect specific values that reflect the RAID construction of the Volume. Only the primary values are meaningful; Min and Max are set to match. Certain StorageSetting instances may be classed as "Fixed", by using the "ChangeableType" property, indicating the setting is preset. Such settings are used when the possible setting variations are low enough to be instantiated in their entirety. The StorageCapabilities "CreateSetting" method MAY NOT be used to return settings that are not changeable. Other StorageSetting instances are created using the "CreateSetting" method. If the capabilities specifies ranges, then the setting can be used by a client to narrow the range to particular values within the range. In other words, the capabilities MAY be broad, but the related setting MUST be as capable or less capable, that is more narrowly defined, before it is used to create or modify resources. These created StorageSetting instances MUST have their "ChangeableType" property = 1, "Changeable - Transient". GeneratedSettings MAY not remain after the restart or reset of the implementation. They may be deleted by implementation at any time. A reasonable minimal time to retain the generated transient settings is five minutes, although there is no minimal retention time.
Details...
This class is not implemented.

Subclasses

CIM_StorageSettingWithHints

Class Qualifiers

Name	Data Type	Value	Scope	Flavors
Description	string	StorageSetting is roughly equivalent to a Service Level Agreement (SLA) It defines the characteristics, qualities of service and goals when used in a CreateOrModifyElement FromStoragePool or CreateOrModifyStoragePool method in the StorageConfigurationService. It specifies a series of properties with Maximum and Minimum values that define the (inclusive) bounds that the object should maintain. Note that the setting is associated to a StorageVolume or LogicalDisk, using ElementSetting. The use of these properties differs depending on whether the StorageSetting instance is being used as a goal for a configuration operation or being used as a Service Level Agreement for a created Volume. In addition the properties fall into two categories: The QOS properties(PackageRedundancy, Data Redundancy, & NoSinglePointOfFailure) and the Detailed RAID properties(ExtentStripeLength, ParityLayout, and UserDataStripeDepth). In a Setting used as a goal, the QOS properties are required as a set; The Detailed RAID properties(if supported as indicated by the scoping StorageCapabilities instance) may be used optionally in any combination. The implementation MUST supply it's own best practice in the case where one or more supported RAID properties are not supplied. In this situation the use of StorageSettingWithHints can be useful to provide direction to the implementation. In a Setting used as a service agreement for a Volume, the QOS properties reflect the Service Level Agreement, with goal, min, & max. The actual current service level is exposed by corresponding values in StorageExtent. The Detailed RAID properties, by contrast, reflect specific values that reflect the RAID construction of the Volume. Only the primary values are meaningful; Min and Max are set to match. Certain StorageSetting instances may be classed as "Fixed", by using the "ChangeableType" property, indicating the setting is preset. Such settings are used when the possible setting variations are low enough to be instantiated in their entirety. The StorageCapabilities "CreateSetting" method MAY NOT be used to return settings that are not changeable. Other StorageSetting instances are created using the "CreateSetting" method. If the capabilities specifies ranges, then the setting can be used by a client to narrow the range to particular values within the range. In other words, the capabilities MAY be broad, but the related setting MUST be as capable or less capable, that is more narrowly defined, before it is used to create or modify resources. These created StorageSetting instances MUST have their "ChangeableType" property = 1, "Changeable - Transient". GeneratedSettings MAY not remain after the restart or reset of the implementation. They may be deleted by implementation at any time. A reasonable minimal time to retain the generated transient settings is five minutes, although there is no minimal retention time.	None	TRANSLATABLE= true
UMLPackagePath	string	CIM::Device::StorageServices	None	None
Version	string	2.11.0	TOSUBCLASS= false	TRANSLATABLE= true

Local Class Properties

Name	Data Type	Qualifiers
Name	Data Type	Name	Data Type	Value	Scope	Flavors
Caption	string
		Description	string	The Caption property is a short textual description (one- line string) of the object.	None	TRANSLATABLE= true
		MaxLen	uint32	64	None	None
ChangeableType	uint16
		Description	string	Enumeration indicating the type of setting. "Fixed - Not Changeable" settings are primordial. These setting are defined at the implementor of the class. "Changeable - Transient" is the type of setting produced by the "CreateSetting" method. A client can subsequently request that the implementation persist the generated and potentially modified setting indefinately. Only a "Changeable - Transient" setting SHALL be converted to a "Changeable = Persistent" setting; the setting SHALL NOT be changed back.	None	TRANSLATABLE= true
		ValueMap	string	0, 1, 2	None	None
		Values	string	Fixed - Not Changeable, Changeable - Transient, Changeable - Persistent	None	TRANSLATABLE= true
DataRedundancyGoal	uint16
		Description	string	DataRedundancyGoal describes the desired number of complete copies of data to be maintained. Examples would be RAID 5 where 1 copy is maintained and RAID 1 where 2 or more copies are maintained. Possible values are 1 to n. The bounds (max and min) for redundancy are defined using the properties, DataRedundancyMax and DataRedundancyMin.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.DataRedundancyMax, CIM_StorageSetting.DataRedundancyMin	None	None
		Write	boolean	true	None	None
DataRedundancyMax	uint16
		Description	string	DataRedundancyMax describes the maximum number of complete copies of data to be maintained. Examples would be RAID 5 where 1 copy is maintained and RAID 1 where 2 or more copies are maintained. Possible values are 1 to n. The desired redundancy is specified using DataRedundancyGoal, while the minimum is defined by DataRedundancyMin.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.DataRedundancyMin, CIM_StorageSetting.DataRedundancyGoal	None	None
		Write	boolean	true	None	None
DataRedundancyMin	uint16
		Description	string	DataRedundancyMin describes the minimum number of complete copies of data to be maintained. Examples would be RAID 5 where 1 copy is maintained and RAID 1 where 2 or more copies are maintained. Possible values are 1 to n. The desired redundancy is specified using DataRedundancyGoal, while the maximum is defined by DataRedundancyMax.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.DataRedundancyMax, CIM_StorageSetting.DataRedundancyGoal	None	None
		Write	boolean	true	None	None
DeltaReservationGoal	uint8
		Description	string	DeltaReservationGoal is a number between 1 (1%) and a 100 (100%) which specifies the desired amount of space that should be reserved in a replica for caching changes. For a complete copy this would be 100%. The bounds (max and min) for the reservation are defined using the properties, DeltaReservationMax and DeltaReservationMin.	None	TRANSLATABLE= true
		MaxValue	sint64	100	None	None
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.DeltaReservationMin, CIM_StorageSetting.DeltaReservationMax	None	None
		Units	string	Percentage	None	TRANSLATABLE= true
		Write	boolean	true	None	None
DeltaReservationMax	uint8
		Description	string	DeltaReservationMax is a number between 1 (1%) and a 100 (100%) which specifies the maximum amount of space that should be reserved in a replica for caching changes. For a complete copy this would be 100%. The desired reservation is specified using DeltaReservationGoal, while the minimum is defined by DeltaReservationMin.	None	TRANSLATABLE= true
		MaxValue	sint64	100	None	None
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.DeltaReservationMin, CIM_StorageSetting.DeltaReservationGoal	None	None
		Units	string	Percentage	None	TRANSLATABLE= true
		Write	boolean	true	None	None
DeltaReservationMin	uint8
		Description	string	DeltaReservationMin is a number between 1 (1%) and a 100 (100%) which specifies the minimum amount of space that should be reserved in a replica for caching changes. For a complete copy this would be 100%. The desired reservation is specified using DeltaReservationGoal, while the maximum is defined by DeltaReservationMax.	None	TRANSLATABLE= true
		MaxValue	sint64	100	None	None
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.DeltaReservationMax, CIM_StorageSetting.DeltaReservationGoal	None	None
		Units	string	Percentage	None	TRANSLATABLE= true
		Write	boolean	true	None	None
Description	string
Description	string	Description	string	The Description property provides a textual description of the object.	None	TRANSLATABLE= true
ElementName	string
		Description	string	The user-friendly name for this instance of SettingData. In addition, the user-friendly name can be used as an index property for a search or query. (Note: The name does not have to be unique within a namespace.)	None	TRANSLATABLE= true
		Override	string	ElementName	TOSUBCLASS= false	None
		Required	boolean	true	None	OVERRIDABLE= false
ExtentStripeLength	uint16
		Description	string	ExtentStripeLength describes the number of underlying StorageExtents across which data is striped in the common striping-based storage organizations. This is also known as the number of 'members' or 'columns'. When used in a goal setting instance, ExtentStripeLength is the optimal desired value. The bounds (max and min) for Stripe Length are defined using the properties ExtentStripeLengthMax and ExtentStripeLengthMin. ExtentStripeLength MUST be set to NULL if the scoping StorageCapablities indicates that it is not supported in this context. ExtentStripeLength can be used in conjunction with CreateOrModifyElementFromELements to explicitly configure storage. An example would be RAID 0+1 with mirroring two stripe sets, each set being three wide. In this case CreateOrModifyElementFromElements would be passed a goal setting with DataRedundancy = 2 and ExtentStripeLength = 3. The size of the InElements array would be 6 and would contain the StorageExtents to be used to construct the StorageElement as a RAID 0+1. ExtentStripeLengthMin and ExtentStripeLengthMax are meaningless and wouldbe set to NULL. If the property is supported, and is part of StorageSettingWithHints it MAY be set to NULL. If used it will constrain the effects of Hint selections. When used in a Setting instance associated to a Volume, this property indicates the specific value that the Volume was created with, and ExtentStripeLengthMin and ExtentStripeLengthMax will be set to the same specific value.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.ExtentStripeLengthMax, CIM_StorageSetting.ExtentStripeLengthMin	None	None
		Write	boolean	true	None	None
ExtentStripeLengthMax	uint16
		Description	string	ExtentStripeLength describes the number of underlying StorageExtents across which data is striped in the common striping-based storage organizations. This is also known as the number of 'members' or 'columns'. When used in a goal setting instance, ExtentStripeLengthMax is the maximum acceptable value. The desired Stripe Length is specified using ExtentStripeLength, while the minimum is defined by ExtentStripeLengthMin. ExtentStripeLengthMax MUST be set to NULL if the scoping StorageCapablities indicates that it is not supported in this context. If the property is supported, and is part of StorageSettingWithHints it MAY be set to NULL. If used it will constrain the effects of Hint selections. When used in a Setting instance associated to a Volume, this property is set to the specific value of ExtentStripeLength.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.ExtentStripeLengthMin, CIM_StorageSetting.ExtentStripeLength	None	None
		Write	boolean	true	None	None
ExtentStripeLengthMin	uint16
		Description	string	ExtentStripeLength describes the number of underlying StorageExtents across which data is striped in the common striping-based storage organizations. This is also known as the number of 'members' or 'columns'. When used in a goal setting instance, ExtentStripeLengthMin is the minimum acceptable value. The desired Stripe Length is specified using ExtentStripeLength, while the maximum is defined by ExtentStripeLengthMax. ExtentStripeLengthMin MUST be set to NULL if the scoping StorageCapablities indicates that it is not supported in this context. If the property is supported, and is part of StorageSettingWithHints it MAY be set to NULL. If used it will constrain the effects of Hint selections. When used in a Setting instance associated to a Volume, this property is set to the specific value of ExtentStripeLength.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.ExtentStripeLengthMax, CIM_StorageSetting.ExtentStripeLength	None	None
		Write	boolean	true	None	None
InstanceID	string
		Description	string	Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.	None	TRANSLATABLE= true
		Key	boolean	true	None	OVERRIDABLE= false
		Override	string	InstanceID	TOSUBCLASS= false	None
NoSinglePointOfFailure	boolean
		Description	string	Indicates the desired value for No Single Point of Failure. Possible values are false = single point of failure, and true = no single point of failure.	None	TRANSLATABLE= true
		Write	boolean	true	None	None
PackageRedundancyGoal	uint16
		Description	string	PackageRedundancyGoal describes the desired number of redundant packages to be used. For example, in the storage domain, package redundancy describes how many disk spindles can fail without data loss including, at most, one spare. An example would be RAID5 with a spare disk which would have a PackageRedundancy of 2. Possible values are 0 to n. The bounds (max and min) for redundancy are defined using the properties, PackageRedundancyMax and PackageRedundancyMin.	None	TRANSLATABLE= true
		ModelCorrespondence	string	CIM_StorageSetting.PackageRedundancyMax, CIM_StorageSetting.PackageRedundancyMin	None	None
		Write	boolean	true	None	None
PackageRedundancyMax	uint16
		Description	string	PackageRedundancyMax describes the maximum number of redundant packages to be used. For example, in the storage domain, package redundancy describes how many disk spindles can fail without data loss including, at most, one spare. An example would be RAID5 with a spare disk which would have a PackageRedundancy of 2. Possible values are 0 to n. The desired redundancy is specified using PackageRedundancyGoal, while the minimum is defined by PackageRedundancyMin.	None	TRANSLATABLE= true
		ModelCorrespondence	string	CIM_StorageSetting.PackageRedundancyMin, CIM_StorageSetting.PackageRedundancyGoal	None	None
		Write	boolean	true	None	None
PackageRedundancyMin	uint16
		Description	string	PackageRedundancyMin describes the minimum number of redundant packages to be used. For example, in the storage domain, package redundancy describes how many disk spindles can fail without data loss including, at most, one spare. An example would be RAID5 with a spare disk which would have a PackageRedundancy of 2. Possible values are 0 to n. The desired redundancy is specified using PackageRedundancyGoal, while the maximum is defined by PackageRedundancyMax.	None	TRANSLATABLE= true
		ModelCorrespondence	string	CIM_StorageSetting.PackageRedundancyMax, CIM_StorageSetting.PackageRedundancyGoal	None	None
		Write	boolean	true	None	None
ParityLayout	uint16
		Description	string	ParityLayout specifies whether a parity-based storage organization is using rotated or non-rotated parity. When used in a goal setting instance, ParityLayout is the desired value. It MUST be set to NULL if the scoping StorageCapablities indicates that it is not supported in this context. If the property is supported, and is part of StorageSettingWithHints it MAY be set to NULL. If used it will constrain the effects of Hint selections. When used in a Setting instance associated to a Volume, this property indicates the specific value that the Volume was created with.	None	TRANSLATABLE= true
		ValueMap	string	1, 2	None	None
		Values	string	Non-rotated Parity, Rotated Parity	None	TRANSLATABLE= true
		Write	boolean	true	None	None
UserDataStripeDepth	uint64
		Description	string	UserDataStripeDepth describes the number of bytes forming a strip in common striping-based storage organizations. The strip is defined as the size of the portion of a stripe that lies on one extent. Thus, ExtentStripeLength * UserDataStripeDepth will yield the size of one stripe of user data. When used in a goal setting instance, UserDataStripeDepth is the optimal desired value. The bounds (max and min) for Stripe Depth are defined using the properties UserDataStripeDepthMax and UserDataStripeDepthMin. UserDataStripeDepth MUST be set to NULL if the scoping StorageCapablities indicates that it is not supported in this context. If the property is supported, and is part of StorageSettingWithHints it MAY be set to NULL. If used it will constrain the effects of Hint selections. When used in a Setting instance associated to a Volume, this property indicates the specific value that the Volume was created with, and UserDataStripeDepthMin and UserDataStripeDepthMax will be set to the same specific value.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.UserDataStripeDepthMax, CIM_StorageSetting.UserDataStripeDepthMin	None	None
		Units	string	Bytes	None	TRANSLATABLE= true
		Write	boolean	true	None	None
UserDataStripeDepthMax	uint64
		Description	string	UserDataStripeDepth describes the number of bytes forming a strip in common striping-based storage organizations. The strip is defined as the size of the portion of a stripe that lies on one extent. Thus, ExtentStripeLength * UserDataStripeDepth will yield the size of one stripe of user data. When used in a goal setting instance, UserDataStripeDepthMax is the maximum acceptable value. The desired Stripe Depth is specified using UserDataStripeDepthGoal, while the minimum is defined by UserDataStripeDepthMin. UserDataStripeDepthMax MUST be set to NULL if the scoping StorageCapablities indicates that it is not supported in this context. If the property is supported, and is part of StorageSettingwWithHints it MAY be set to NULL. If used it will constrain the effects of Hint selections. When used in a Setting instance associated to a Volume, this property is set to the specific value of UserDataStripeDepth.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.UserDataStripeDepthMin, CIM_StorageSetting.UserDataStripeDepth	None	None
		Units	string	Bytes	None	TRANSLATABLE= true
		Write	boolean	true	None	None
UserDataStripeDepthMin	uint64
		Description	string	UserDataStripeDepth describes the number of bytes forming a strip in common striping-based storage organizations. The strip is defined as the size of the portion of a stripe that lies on one extent. Thus, ExtentStripeLength * UserDataStripeDepth will yield the size of one stripe of user data. When used in a goal setting instance, UserDataStripeDepthMin is the minimum acceptable value. The desired Stripe Depth is specified using UserDataStripeDepth, while the maximum is defined by UserDataStripeDepthMax. UserDataStripeDepthMin MUST be set to NULL if the scoping StorageCapablities indicates that it is not supported in this context. If the property is supported, and is part of StorageSettingWithHints it MAY be set to NULL. If used it will constrain the effects of Hint selections. When used in a Setting instance associated to a Volume, this property is set to the specific value of UserDataStripeDepth.	None	TRANSLATABLE= true
		MinValue	sint64	1	None	None
		ModelCorrespondence	string	CIM_StorageSetting.UserDataStripeDepthMax, CIM_StorageSetting.UserDataStripeDepth	None	None
		Units	string	Bytes	None	TRANSLATABLE= true
		Write	boolean	true	None	None