MSFT_SMPool class

Represents a storage pool. A storage pool is a logical grouping of physical disks that may be used to create virtual disks.

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

Windows Server 2012 R2 and Windows Server 2012: This class does not inherit from MSFT_SMStorageObject which is new for Windows Server 2016.

Syntax

[dynamic, provider("WMIStorage"), AMENDMENT]
class MSFT_SMPool : MSFT_SMStorageObject
{
  String  ObjectId;
  String  Identifier;
  String  DisplayName;
  String  Name;
  String  PoolID;
  Boolean Primordial;
  Uint64  RemainingManagedSpace;
  Uint64  TotalManagedSpace;
  String  DefaultSettingName;
  boolean NoSinglePointOfFailure;
  boolean NoSinglePointOfFailureDefault;
  uint16  DataRedundancyMax;
  uint16  DataRedundancyMin;
  uint16  DataRedundancyDefault;
  uint16  PackageRedundancyMax;
  uint16  PackageRedundancyMin;
  uint16  PackageRedundancyDefault;
  uint16  ExtentStripeLengthDefault;
  uint16  ParityLayoutDefault;
  uint64  UserDataStripeDepthDefault;
  uint16  Usage;
  string  UsageDescription;
  boolean SupportsStorageVolumeCreation;
  boolean SupportsThinlyProvisionedStorageVolume;
  uint64  SpaceLimit;
  uint16  SpaceLimitDetermination;
  uint16  LowSpaceWarningThreshold;
  uint64  ThinProvisionMetaDataSpace;
  uint16  OperationalStatus[];
  string  StatusDescriptions[];
  uInt16  HealthStatus;
  string  HealthStatusDescription;
};

Members

The MSFT_SMPool class has these types of members:

Methods

The MSFT_SMPool class has these methods.

Method Description
AddDiskDrives Adds disk drives to a concrete pool.
CreateFileSystem This method creates a file system
CreateStorageVolume Starts a job to create a storage volume.
Delete Starts a job to delete a Pool.
GetSizesInfo Returns the possible sizes of child storage volumes that can be created or modified by using capacity from this storage pool.

Properties

The MSFT_SMPool class has these properties.

DataRedundancyDefault

Data type: uint16

Access type: Read-only

TBD

DataRedundancyMax

Data type: uint16

Access type: Read-only

TBD

DataRedundancyMin

Data type: uint16

Access type: Read-only

TBD

DefaultSettingName

Data type: String

Access type: Read-only

TBD

DisplayName

Data type: String

Access type: Read-only

The user-friendly name of the storage pool.

ExtentStripeLengthDefault

Data type: uint16

Access type: Read-only

TBD

HealthStatus

Data type: uInt16

Access type: Read-only

The current status of the pool.

The possible values are.

Healthy (0)

Warning (1)

Unhealthy (2)

HealthStatusDescription

Data type: string

Access type: Read-only

The current status of the pool in a string format.

Identifier

Data type: String

Access type: Read-only

Qualifiers: Required

The ID of the logical instance of the object. This ID must be unique within the scope of the storage system.

This property is inherited from MSFT_SMStorageObject.

Windows Server 2012 R2 and Windows Server 2012: This property is present, but is not inherited from MSFT_SMStorageObject .

LowSpaceWarningThreshold

Data type: uint16

Access type: Read-only

Qualifiers: MinValue (0), MaxValue (100), ModelCorrespondence ("CIM_StoragePool.RemainingManagedSpace"), PUnit ("percent"), Units ("Percentage")

A low space warning is generated when the remaining space is reduced to this percentage of the total storage capacity.

Name

Data type: String

Access type: Read-only

A human-readable string used to identify the storage pool. This property is unique within the storage subsystem.

NoSinglePointOfFailure

Data type: boolean

Access type: Read-only

TBD

NoSinglePointOfFailureDefault

Data type: boolean

Access type: Read-only

TBD

ObjectId

Data type: String

Access type: Read-only

Qualifiers: Key, Required

The ID of this class instance. This ID must be unique within the scope of the Windows Storage Management server that hosts the provider object.

This property is inherited from MSFT_SMStorageObject.

Windows Server 2012 R2 and Windows Server 2012: This property is present, but is not inherited from MSFT_SMStorageObject .

OperationalStatus

Data type: uint16 array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")

The current status of the pool.

The possible values are.

Unknown (0)

Other (1)

OK (2)

Degraded (3)

Stressed (4)

Predictive Failure (5)

Error (6)

Non-Recoverable Error (7)

Starting (8)

Stopping (9)

Stopped (10)

In Service (11)

No Contact (12)

Lost Communication (13)

Aborted (14)

Dormant (15)

Supporting Entity in Error (16)

Completed (17)

Power Mode (18)

Relocating (19)

DMTF Reserved

20 32767

Vendor Reserved

32768 65535

PackageRedundancyDefault

Data type: uint16

Access type: Read-only

TBD

PackageRedundancyMax

Data type: uint16

Access type: Read-only

TBD

PackageRedundancyMin

Data type: uint16

Access type: Read-only

TBD

ParityLayoutDefault

Data type: uint16

Access type: Read-only

TBD

PoolID

Data type: String

Access type: Read-only

The storage pool ID.

Primordial

Data type: Boolean

Access type: Read-only

True if the storage pool is primordial; otherwise, False. A primordial pool, also known as the 'available storage' pool is where storage capacity is drawn and returned in the creation and deletion of concrete storage pools. Primordial pools cannot be created or deleted.

RemainingManagedSpace

Data type: Uint64

Access type: Read-only

The amount of unused space in the storage pool, in bytes.

SpaceLimit

Data type: uint64

Access type: Read-only

Qualifiers: PUnit ("byte"), Units ("Bytes")

The capacity of the storage allocated to the pool.

When the value of the SpaceLimitDetermination property is Allocated, SpaceLimit is set to the value of TotalManagedSpace.

SpaceLimitDetermination

Data type: uint16

Access type: Read-only

How the value of the SpaceLimit property is determined.

The possible values.

Allocated (2)

Quote (3)

Limitless (4)

StatusDescriptions

Data type: string array

Access type: Read-only

Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")

Describes the corresponding entry in the OperationalStatus array.

SupportsStorageVolumeCreation

Data type: boolean

Access type: Read-only

Whether the pool is capable of providing storage volumes.

SupportsThinlyProvisionedStorageVolume

Data type: boolean

Access type: Read-only

Whether the pool is capable of providing thinly provisioned storage volumes

ThinProvisionMetaDataSpace

Data type: uint64

Access type: Read-only

Qualifiers: PUnit ("byte"), Units ("Bytes")

The size, in bytes, of metadata consumed by this storage pool. This property is only defined if the pool is thinly provisioned."

TotalManagedSpace

Data type: Uint64

Access type: Read-only

The size of the storage pool, in bytes.

Usage

Data type: uint16

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_StoragePool.OtherUsageDescription")

The intended usage or any restrictions that may have been imposed on the usage of this component.

The possible values are.

Other (1)

Unrestricted (2)

Reserved for ComputerSystem (the block server) (3)

Reserved as a Delta Replica Container (4)

Reserved for Migration Services (5)

Reserved for Local Replication Services (6)

Reserved for Remote Replication Services (7)

Reserved for Sparing (8)

DMTF Reserved

9 32767

Vendor Reserved

32768 65535

UsageDescription

Data type: string

Access type: Read-only

Describes the usage when the Usage property is Other.

UserDataStripeDepthDefault

Data type: uint64

Access type: Read-only

TBD

Requirements

Minimum supported client
None supported
Minimum supported server
Windows Server 2012
Namespace
Root\Microsoft\Windows\Storage\SM
MOF
MsftStrgMan.mof
DLL
StorageService.dll

See also

MSFT_SMStorageObject

Windows Storage Management WMI Provider