WT_Disk class
Describes an iSCSI virtual disk.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
class WT_Disk
{
uint32 WTD;
sint32 Type;
sint32 Flags;
sint32 Status;
string Description;
string DevicePath;
string ActiveDevicePath;
string ParentPath;
uint32 ParentWTD;
uint32 Size;
uint32 AllocatedSize;
string SerialNumber;
sint32 DVMountStatus;
datetime DVTimeStamp;
string DVDeviceId;
datetime AsyncOpStartTime;
datetime AsyncOpEndTime;
string ResourceGroup;
boolean Enabled;
string Guid;
string DeviceVolumeGuid;
WT_VDSLunInformation VdsLunInfo;
string LMSnapshotId;
uint32 InternalCode;
uint64 BlockSize;
boolean IsBasedOnUnderlyingRedundancy;
};
Members
The WT_Disk class has these types of members:
Methods
The WT_Disk class has these methods.
Method | Description |
---|---|
CancelAsyncOperation | Windows Server 2012: This method is not supported until Windows Server 2012 R2. Cancel any asynchronous operation on this disk. |
CreateRamWTDisk | Windows Server 2012: This method is not supported until Windows Server 2012 R2. Create a new RAM-based iSCSI virtual disk. |
CreateVhdWTDisk | Windows Server 2012: This method is not supported until Windows Server 2012 R2. Create a new VHDX-based iSCSI virtual disk. |
Extend | Windows Server 2012 R2: This method is deprecated. Use the Resize method instead. Extends a virtual disk. |
GetAsyncOperationProgress | Windows Server 2012: This method is not supported until Windows Server 2012 R2. Get the asynchronous operation progress information for this iSCSI virtual disk. |
GetDVMountPoints | Windows Server 2012 R2: This method is deprecated. Returns a list of all mount points that belong to the virtual disk. This is used for locally mounted shadow copies. |
GetRollbackProgress | Windows Server 2012 R2: This method is deprecated. Use GetAsyncOperationProgress instead. Retrieves the rollback progress information for the disk. |
ImportWTDisk | Windows Server 2012: This method is not supported until Windows Server 2012 R2. Import an existing VHD or SCSI device as a iSCSI virtual disk. |
NewDiffWTDisk | Windows Server 2012 R2: This method is deprecated. Use the CreateRamWTDisk, CreateVhdWTDisk, or ImportWTDisk methods instead. Creates a new differencing virtual disk. |
NewWTDisk | Windows Server 2012 R2: This method is deprecated. Use the CreateRamWTDisk, CreateVhdWTDisk, or ImportWTDisk methods instead. Creates a new virtual disk. |
Resize | Windows Server 2012: This method is not supported until Windows Server 2012 R2. Resize iSCSI virtual disk. |
Properties
The WT_Disk class has these properties.
-
ActiveDevicePath
-
-
Data type: string
-
Access type: Read-only
Full active device path to the VHD file on the Microsoft iSCSI Target Server.
For a pass-through device, this is a decorated active Win32 device path in the form "SCSI:<win32_device_path>". For other device types, this property always has the same value as the DevicePath property.
Windows Server 2012: This property is not supported until Windows Server 2012 R2.
-
-
AllocatedSize
-
-
Data type: uint32
-
Access type: Read-only
Allocated size of the virtual disk, in megabytes.
-
-
AsyncOpEndTime
-
-
Data type: datetime
-
Access type: Read-only
When an asynchronous operation ended, whether it ended successfully or not.
Windows Server 2012: This property is not supported until Windows Server 2012 R2.
-
-
AsyncOpStartTime
-
-
Data type: datetime
-
Access type: Read-only
When an asynchronous operation started.
Windows Server 2012: This property is not supported until Windows Server 2012 R2.
-
-
BlockSize
-
-
Data type: uint64
-
Access type: Read-only
Logical block or sector size of the virtual disk, in bytes.
-
-
Description
-
-
Data type: string
-
Access type: Read/write
A user-friendly description of the virtual disk.
-
-
DevicePath
-
-
Data type: string
-
Access type: Read-only
Full path to the VHD file on the Microsoft iSCSI Target Server.
-
-
DeviceVolumeGuid
-
-
Data type: string
-
Access type: Read-only
Identifier of the volume where the disk resides.
-
-
DVDeviceId
-
-
Data type: string
-
Access type: Read-only
Windows Server 2012 R2: This property is deprecated.
Reserved for system use.
-
-
DVMountStatus
-
-
Data type: sint32
-
Access type: Read-only
-
Qualifiers: Values (NotMounted, MountSnapshot), ValueMap (0, 1)
Windows Server 2012 R2: This property is deprecated.
The current data view mount status.
-
-
DVTimeStamp
-
-
Data type: datetime
-
Access type: Read-only
Windows Server 2012 R2: This property is deprecated.
If the value of DVMountStatus is MountSnapshot, DVTimeStamp contains the date and time when the snapshot was taken. Otherwise, DVTimeStamp is an empty string.
-
-
Enabled
-
-
Data type: boolean
-
Access type: Read/write
Indicates whether the disk is enabled.
-
-
Flags
-
-
Data type: sint32
-
Access type: Read-only
Flags that indicate characteristics of the disk. This property is a bitmask and may contain one of the following possible values.
-
-
ReadOnlyWTDisk (0x00000001)
-
The disk is a read-only disk.
Windows Server 2012: This property value is not supported before Windows Server 2012 R2.
-
ShadowWTDisk (0x00000002)
-
The disk is a shadow copy disk.
Guid
-
Data type: string
-
Access type: Read-only
Reserved for system use.
InternalCode
-
Data type: uint32
-
Access type: Read-only
Reserved for system use.
IsBasedOnUnderlyingRedundancy
-
Data type: boolean
-
Access type: Read-only
Indicates whether the device is based on the underlying storage redundancy.
LMSnapshotId
-
Data type: string
-
Access type: Read-only
If the disk contains a volume shadow copy that is locally mounted, this property contains the shadow copy identifier.
ParentPath
-
Data type: string
-
Access type: Read-only
Full path to the parent VHD file on the Microsoft iSCSI Target Server. The parent VHD is the base virtual disk file that the differencing VHD links to.
ParentWTD
-
Data type: uint32
-
Access type: Read-only
Parent iSCSI Disk Index.
ResourceGroup
-
Data type: string
-
Access type: Read-only
The name of the cluster group that this virtual disk belongs to. If the Microsoft iSCSI Target Server service is not running on a Microsoft Failover Cluster, this property is an empty string.
SerialNumber
-
Data type: string
-
Access type: Read-only
Serial number of the virtual disk.
Size
-
Data type: uint32
-
Access type: Read-only
Size of the virtual disk, in megabytes.
Status
-
Data type: sint32
-
Access type: Read-only
-
Qualifiers: Values (Not Connected, Connected, Reverting), ValueMap (0, 1, 2)
Status of the virtual disk.
Type
-
Data type: sint32
-
Access type: Read-only
VHD type.
Windows Server 2012: The following property values are not supported before Windows Server 2012 R2.
Fixed (2)
Dynamic (3)
Differencing (4)
ReadOnlySnapshot (30000)
WritableSnapshot (30001)
RamDisk (30002)
PassThrough (30003)
Windows Server 2012: The following property values are the only ones supported on Windows Server 2012.
Fixed (1)
Differencing (2)
VdsLunInfo
-
Data type: WT_VDSLunInformation
-
Access type: Read-only
LUN information for the disk, used by the Virtual Disk Service (VDS).
WTD
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: Key
An iSCSI disk identifier that uniquely identifies the virtual disk. This index is automatically assigned by Microsoft iSCSI Target Server during the creation process and cannot be changed.
Remarks
It is possible for one or more property values to return NULL intermittently due to transient issues. In this case, re-querying may return all property values correctly.
Requirements
Minimum supported client |
None supported |
Minimum supported server |
Windows Server 2012 |
Namespace |
Root\Wmi |
MOF |
|
DLL |
|