MSFT_SMStorageVolume class
Represents a storage volume.
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_SMStorageVolume : MSFT_SMStorageObject
{
String ObjectId;
String Identifier;
String DisplayName;
String Name;
Uint16 NameFormat;
Uint16 NameNamespace;
String OtherNameFormat;
String OtherNameNamespace;
String SMLunId;
Uint16 SMLunIdFormat;
String SMLunIdFormatDescription;
Uint16 SMLunIdNamespace;
String SMLunIdNamespaceDescription;
uint16 HealthStatus;
string HealthStatusDescription;
uint16 OperationalStatus[];
string StatusDescription;
Uint64 BlockSize;
Uint64 NumberOfBlocks;
Uint64 ConsumableBlocks;
Boolean Primordial;
String OtherIdentifyingInfo[];
String IdentifyingDescriptions[];
boolean NoSinglePointOfFailure;
uint16 ExtentStripeLength;
uint64 UserDataStripeDepth;
uint16 DataRedundancy;
uint16 PackageRedundancy;
uint16 ParityLayout;
uint16 Access;
String AccessDescription;
Boolean ThinlyProvisioned = FALSE;
uint16 Usage;
Boolean IsSnapshot;
};
Members
The MSFT_SMStorageVolume class has these types of members:
Methods
The MSFT_SMStorageVolume class has these methods.
| Method | Description |
|---|---|
| CreateClone | Starts a job to create an associated un-synced Clone of the MSFT_SMStorageVolume. |
| CreateReplica | Creates a replication relationship between virtual disks. Windows Server 2012 R2 and Windows Server 2012: This method is not available before Windows Server 2016. |
| CreateSnapshot | Starts a job to create an associated un-synced snapshot of the MSFT_SMStorageVolume. |
| Delete | Starts a job to delete a storage volume previously created from a storage pool. |
| ModifySize | Starts a job to modify the size of a storage volume. |
| SetReadonly | Changes the device access of the storage volume to Readable. |
| SetReadWrite | Changes the device access of the storage volume to Read/Write. |
| SetReplicationRelationship | Updates a replication relationship between virtual disks. Windows Server 2012 R2 and Windows Server 2012: This method is not available before Windows Server 2016. |
Properties
The MSFT_SMStorageVolume class has these properties.
-
Access
-
-
Data type: uint16
-
Access type: Read-only
Indicates read and write access on the volume.
The possible values are.
-
-
Unknown (0)
-
Readable (1)
-
Writeable (2)
-
Read/Write Supported (3)
-
Write Once (4)
AccessDescription
-
Data type: String
-
Access type: Read-only
A description of the Access value.
BlockSize
-
Data type: Uint64
-
Access type: Read-only
The size, in bytes, of the blocks in this storage extent. If there is a variable block size, then the maximum block size in bytes is specified. If the block size is "unknown" or if a block concept is not valid (for example, for Aggregate Extents, Memory, or LogicalDisks), the value is "1" (one).
ConsumableBlocks
-
Data type: Uint64
-
Access type: Read-only
TBD
DataRedundancy
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageExtent.DataRedundancy")
Number of complete copies of data currently maintained.
DisplayName
-
Data type: String
-
Access type: Read-only
The user-friendly name of the storage volume.
ExtentStripeLength
-
Data type: uint16
-
Access type: Read-only
TBD
HealthStatus
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed")
The current status of the LUN (StorageVolume).
The possible values are.
Healthy (0)
Warning (1)
Unhealthy (2)
HealthStatusDescription
-
Data type: string
-
Access type: Read-only
The current status of the LUN (StorageVolume) 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 .
IdentifyingDescriptions
-
Data type: String array
-
Access type: Read-only
An array that contains descriptions of the format used in the custom identifiers in OtherIdentifyingInfo. There must be a 1:1 mapping between this array and OtherIdentifyingInfo.
IsSnapshot
-
Data type: Boolean
-
Access type: Read-only
True if the volume is a snapshot volume.
Name
-
Data type: String
-
Access type: Read-only
The system defined name of the storage volume.
NameFormat
-
Data type: Uint16
-
Access type: Read-only
Indicates the format of the Name property.
NameNamespace
-
Data type: Uint16
-
Access type: Read-only
The namespace of Name value.
NoSinglePointOfFailure
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageExtent.NoSinglePointOfFailure")
Whether or not there exists no single point of failure.
NumberOfBlocks
-
Data type: Uint64
-
Access type: Read-only
The total number of consecutive blocks that form this storage extent. Total size of the storage extent can be calculated by multiplying the value of the BlockSize property by the value of this property. If the value of BlockSize is "1", this property is the total size of the storage extent.
ObjectId
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_StorageVolume.OperationalStatus")
The current SMIS status of the LUN (StorageVolume).
The possible values are.
OK (2)
Degraded (3)
Error (6)
Starting (8)
Dormant (15)
OtherIdentifyingInfo
-
Data type: String array
-
Access type: Read-only
An array that contains custom identifiers for the switch. If this property is set, IdentifyingDescriptions must also be set.
OtherNameFormat
-
Data type: String
-
Access type: Read-only
TBD
OtherNameNamespace
-
Data type: String
-
Access type: Read-only
TBD
PackageRedundancy
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageExtent.PackageRedundancy")
Indicates how many physical packages can fail without data loss.
ParityLayout
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_StorageSetting.ParityLayout")
Indicates whether a parity-based storage organization is using rotated or non-rotated parity.
The possible values are.
Non-rotated Parity (1)
Rotated Parity (2)
Primordial
-
Data type: Boolean
-
Access type: Read-only
True if the storage volume is a member of a primordial pool; otherwise, False.
SMLunId
-
Data type: String
-
Access type: Read-only
TBD
SMLunIdFormat
-
Data type: Uint16
-
Access type: Read-only
TBD
SMLunIdFormatDescription
-
Data type: String
-
Access type: Read-only
TBD
SMLunIdNamespace
-
Data type: Uint16
-
Access type: Read-only
TBD
SMLunIdNamespaceDescription
-
Data type: String
-
Access type: Read-only
TBD
StatusDescription
-
Data type: string
-
Access type: Read-only
The current SMIS status of the LUN (StorageVolume) in a string format.
ThinlyProvisioned
-
Data type: Boolean
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("SNIA_StorageVolume.ThinlyProvisioned")
True if the volume is thinly provisioned; otherwise False.
Usage
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Experimental, ModelCorrespondence ("CIM_StorageExtent.Usage")
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 by Replication Services (4)
Reserved by Migration Services (5)
Local Replica Source (6)
Remote Replica Source (7)
Local Replica Target (8)
Remote Replica Target (9)
Local Replica Source or Target (10)
Remote Replica Source or Target (11)
Delta Replica Target (12)
Element Component (13)
Reserved as Pool Contributor (14)
Composite Volume Member (15)
Composite LogicalDisk Member (16)
Reserved for Sparing (17)
DMTF Reserved
Vendor Reserved
UserDataStripeDepth
-
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 |
|
| DLL |
|