Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

MSISCSITARGET_StorageSetting class

Defines a set of properties that are related to the configuration of a storage volume.

A MSISCSITARGET_StorageSetting instance is roughly equivalent to a service-level agreement (SLA). A storage setting defines properties in two categories:

The quality of service (QoS) properties.

  • PackageRedundancyGoal
  • DataRedundancyGoal
  • NoSinglePointOfFailure

The detailed redundant array of independent disks (RAID) properties.

  • ExtentStripeLength
  • ParityLayout
  • UserDataStripeDepth
The use of these properties differs depending on whether the MSISCSITARGET_StorageSetting instance is used as a goal for a storage configuration service operation or whether it is used as a service-level agreement (SLA) for a created storage volume. In a storage setting that is used as a goal, the QoS properties are required as a set. The detailed RAID properties, if supported, can be used optionally in any combination. In a storage setting that is used as a service-level agreement for a volume, the QoS properties reflect the SLA, with a goal, a minimum, and a maximum. The actual current service level is indicated by corresponding properties in the MSISCSITARGET_StorageVolume instance.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

class MSISCSITARGET_StorageSetting : CIM_StorageSetting
{
  boolean NoSinglePointOfFailure;
  uint16  DataRedundancyMax;
  uint16  DataRedundancyMin;
  uint16  DataRedundancyGoal;
  uint16  PackageRedundancyMax;
  uint16  PackageRedundancyMin;
  uint16  PackageRedundancyGoal;
  uint8   DeltaReservationMax;
  uint8   DeltaReservationMin;
  uint8   DeltaReservationGoal;
  uint16  ChangeableType;
  uint16  ExtentStripeLength;
  uint16  ExtentStripeLengthMin;
  uint16  ExtentStripeLengthMax;
  uint16  ParityLayout;
  uint64  UserDataStripeDepth;
  uint64  UserDataStripeDepthMin;
  uint64  UserDataStripeDepthMax;
  string  InstanceID;
  string  ElementName;
  string  Caption;
  string  Description;
};

Members

The MSISCSITARGET_StorageSetting class has these types of members:

Properties

The MSISCSITARGET_StorageSetting class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Indicates a short textual description of the object.

This property is inherited from the CIM_ManagedElement class.

ChangeableType
Data type: uint16
Access type: Read-only

Indicates whether this storage setting instance is fixed or changeable.

Storage settings that are created by using the MSISCSITARGET_StorageCapabilities.CreateSetting method have this property set to Changeable - Transient. A client can request that the implementation persist a transient storage setting indefinitely. Only a Changeable - Transient storage setting can be converted to a Changeable - Persistent storage setting. After the setting is changed, it cannot be changed back.

ValuesMeaning
Fixed - Not Changeable
0

The storage setting properties are set at the creation of the instance and cannot be changed.

Changeable - Transient
1

The storage setting properties can be changed after instantiation. The storage setting instance can be deleted at any time.

Changeable - Persistent
2

The storage setting instance is persisted. It is retained after a restart or reset.

 

This property is inherited from the CIM_StorageSetting class.

DataRedundancyGoal
Data type: uint16
Access type: Read/write
Qualifiers: MinValue (1)

Specifies the requested number of complete copies of data to be maintained.

The DataRedundancyMax and DataRedundancyMin properties specify the upper and lower bounds for data redundancy.

This property is inherited from the CIM_StorageSetting class.

DataRedundancyMax
Data type: uint16
Access type: Read/write
Qualifiers: MinValue (1)

Specifies the maximum number of complete copies of data to be maintained.

This property is inherited from the CIM_StorageSetting class.

DataRedundancyMin
Data type: uint16
Access type: Read/write
Qualifiers: MinValue (1)

Specifies the minimum number of complete copies of data to be maintained.

This property is inherited from the CIM_StorageSetting class.

DeltaReservationGoal
Data type: uint8
Access type: Read/write
Qualifiers: MinValue (1) , MaxValue (100) , Units ("Percentage")

Specifies the requested amount of space to be reserved in a replica for a change cache. 100 percent specifies caching a complete copy.

The DeltaReservationMax and DeltaReservationMin properties specify the upper and lower bounds for delta reservation.

This property is inherited from the CIM_StorageSetting class.

DeltaReservationMax
Data type: uint8
Access type: Read/write
Qualifiers: MinValue (1) , MaxValue (100) , Units ("Percentage")

Specifies the maximum amount of space to be reserved in a replica for a change cache. 100 percent specifies caching a complete copy.

This property is inherited from the CIM_StorageSetting class.

DeltaReservationMin
Data type: uint8
Access type: Read/write
Qualifiers: MinValue (1) , MaxValue (100) , Units ("Percentage")

Specifies the minimum amount of space to be reserved in a replica for a change cache. 100 percent specifies caching a complete copy.

This property is inherited from the CIM_StorageSetting class.

Description
Data type: string
Access type: Read-only

Indicates a textual description of the object.

This property is inherited from the CIM_ManagedElement class.

ElementName
Data type: string
Access type: Read-only
Qualifiers: Required

Indicates a user-friendly name for the object. This property enables each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

This property is inherited from the CIM_SettingData class.

ExtentStripeLength
Data type: uint16
Access type: Read/write
Qualifiers: MinValue (1)

Specifies the number of underlying CIM_StorageExtent instances across which data is striped in the common stripe-based storage formats. It is set to NULL if the MSISCSITARGET_StorageCapabilities instance indicates that striping is not supported.

When used in a goal setting instance, ExtentStripeLength is the optimal value. The maximum and minimum bounds are specified in the ExtentStripeLengthMax and ExtentStripeLengthMin properties.

When used in a storage setting instance that is associated with a MSISCSITARGET_StorageVolume instance, this property indicates the specific value that was used to create the volume, and the ExtentStripeLengthMin and ExtentStripeLengthMax properties are set to the same specific value.

This property is inherited from the CIM_StorageSetting class.

ExtentStripeLengthMax
Data type: uint16
Access type: Read/write
Qualifiers: MinValue (1)

Specifies the maximum acceptable number of underlying CIM_StorageExtent instances across which data is striped in the common stripe-based storage formats. It is set to NULL if the MSISCSITARGET_StorageCapabilities instance indicates that striping is not supported.

When used in a storage setting instance that is associated with a MSISCSITARGET_StorageVolume instance, this property is set to the specific value of the ExtentStripeLength property.

This property is inherited from the CIM_StorageSetting class.

ExtentStripeLengthMin
Data type: uint16
Access type: Read/write
Qualifiers: MinValue (1)

Specifies the minimum acceptable number of underlying CIM_StorageExtent instances across which data is striped in the common stripe-based storage formats. It is set to NULL if the MSISCSITARGET_StorageCapabilities instance indicates that striping is not supported.

When used in a storage setting instance that is associated with a MSISCSITARGET_StorageVolume instance, this property is set to the specific value of the ExtentStripeLength property.

This property is inherited from the CIM_StorageSetting class.

InstanceID
Data type: string
Access type: Read-only
Qualifiers: Key

Uniquely and opaquely identifies an instance of this class within the scope of the containing namespace.

Important  In order to ensure uniqueness within the namespace, the value of the InstanceID property should be constructed in the following pattern:

OrgID:LocalID

OrgID must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that defines the InstanceID, or must be a registered ID that is assigned by a recognized global authority. This pattern is similar to the structure of schema class names. In addition, to ensure uniqueness, the first colon in InstanceID must be between the OrgID andLocalID. Therefore the OrgID name must not contain a colon (':').

LocalID is chosen by the business entity and should not be re-used to identify different underlying real-world elements.

If the preceding pattern is not used, the defining entity must ensure that the resultant InstanceID is not re-used across any InstanceID properties that are produced by this or other providers for this namespace.

For Distributed Management Task Force (DMTF) defined instances, the pattern must be used with the OrgID set to CIM.

This property is inherited from the CIM_SettingData class.

NoSinglePointOfFailure
Data type: boolean
Access type: Read/write

Specifies the requested value for the MSISCSITARGET_StorageCapabilities.NoSinglePointOfFailure property.

This property is inherited from the CIM_StorageSetting class.

PackageRedundancyGoal
Data type: uint16
Access type: Read/write

Specifies the requested number of redundant packages to be used.

The PackageRedundancyMax and PackageRedundancyMin properties specify the upper and lower bounds for package redundancy.

This property is inherited from the CIM_StorageSetting class.

PackageRedundancyMax
Data type: uint16
Access type: Read/write

Specifies the maximum number of redundant packages to be used.

This property is inherited from the CIM_StorageSetting class.

PackageRedundancyMin
Data type: uint16
Access type: Read/write

Specifies the minimum number of redundant packages to be used.

This property is inherited from the CIM_StorageSetting class.

ParityLayout
Data type: uint16
Access type: Read/write

Specifies whether a storage pool is using rotated or non-rotated parity.

When used in a goal setting instance, this is the requested value. It is set to NULL if the MSISCSITARGET_StorageCapabilities instance indicates that the property is not supported.

When used in a storage setting instance that is associated with a MSISCSITARGET_StorageVolume instance, this property indicates the specific value that was used to create the volume.

The possible values are.

Non-rotated Parity (1)
Rotated Parity (2)

This property is inherited from the CIM_StorageSetting class.

UserDataStripeDepth
Data type: uint64
Access type: Read/write
Qualifiers: MinValue (1) , Units ("Bytes")

Specifies the number of bytes that form 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. It is set to NULL if the MSISCSITARGET_StorageCapabilities instance indicates that striping is not supported.

When used in a goal setting instance, UserDataStripeDepth is the optimal value. The maximum and minimum bounds are specified in the UserDataStripeDepthMax and UserDataStripeDepthMin properties.

When used in a storage setting instance that is associated with a MSISCSITARGET_StorageVolume instance, this property indicates the specific value that was used to create the volume, and the UserDataStripeDepthMax and UserDataStripeDepthMin properties are set to the same specific value.

This property is inherited from the CIM_StorageSetting class.

UserDataStripeDepthMax
Data type: uint64
Access type: Read/write
Qualifiers: MinValue (1) , Units ("Bytes")

Specifies the maximum acceptable number of bytes that form a strip in common striping-based storage organizations. It is set to NULL if the MSISCSITARGET_StorageCapabilities instance indicates that striping is not supported.

When used in a storage setting instance that is associated with a MSISCSITARGET_StorageVolume instance, this property is set to the specific value of the UserDataStripeDepth property.

This property is inherited from the CIM_StorageSetting class.

UserDataStripeDepthMin
Data type: uint64
Access type: Read/write
Qualifiers: MinValue (1) , Units ("Bytes")

Specifies the minimum acceptable number of bytes that form a strip in common striping-based storage organizations. It is set to NULL if the MSISCSITARGET_StorageCapabilities instance indicates that striping is not supported.

When used in a storage setting instance that is associated with a MSISCSITARGET_StorageVolume instance, this property is set to the specific value of the UserDataStripeDepth property.

This property is inherited from the CIM_StorageSetting class.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012 R2

Namespace

\\.\root\cimv2\storage\iscsitarget

MOF

SmIscsiTarget.mof

See also

iSCSI Target Server Reference
MSISCSITARGET_StorageCapabilities
MSISCSITARGET_StorageConfigurationService
MSISCSITARGET_StorageVolume

 

 

Show:
© 2015 Microsoft