MSFT_DedupVolumeStatus class

Article
05/31/2018

Represents the data deduplication status for a volume.

The following syntax is simplified from MOF code and includes all inherited properties.

Syntax

[dynamic, provider("DeduplicationProvider"), ClassVersion("1.0"), AMENDMENT]
class MSFT_DedupVolumeStatus
{
  String   VolumeId;
  String   Volume;
  uint64   Capacity;
  uint64   FreeSpace;
  uint64   UsedSpace;
  uint64   SavedSpace;
  uint32   SavingsRate;
  uint64   OptimizedFilesCount;
  uint64   OptimizedFilesSize;
  uint64   InPolicyFilesCount;
  uint64   InPolicyFilesSize;
  datetime LastOptimizationTime;
  datetime LastGarbageCollectionTime;
  datetime LastScrubbingTime;
  uint32   LastOptimizationResult;
  uint32   LastGarbageCollectionResult;
  uint32   LastScrubbingResult;
  string   LastOptimizationResultMessage;
  string   LastGarbageCollectionResultMessage;
  string   LastScrubbingResultMessage;
  uint64   UnoptimizedSize;
  uint32   OptimizedFilesSavingsRate;
};

Members

The MSFT_DedupVolumeStatus class has these types of members:

Methods
Properties

Methods

The MSFT_DedupVolumeStatus class has these methods.

Method	Description
Update	Scans the specified volumes to compute fresh data deduplication savings information and returns a deduplication status object containing fresh metadata, not cached.

Properties

The MSFT_DedupVolumeStatus class has these properties.

Capacity

Data type: uint64
Access type: Read-only

The capacity of the volume, in bytes.

FreeSpace

Data type: uint64
Access type: Read-only

The amount of free space on the volume, in bytes.

InPolicyFilesCount

Data type: uint64
Access type: Read-only

The number of files that currently qualify for optimization. This number will stay relatively constant between optimization jobs.

InPolicyFilesSize

Data type: uint64
Access type: Read-only

The aggregate size of all files that currently qualify for optimization. This number will stay relatively constant between optimization jobs.

LastGarbageCollectionResult

Data type: uint32
Access type: Read-only

The error code from when a garbage collection job was run last on the volume. A value of zero means the job ran successfully.

LastGarbageCollectionResultMessage

Data type: string
Access type: Read-only

The error message from when a garbage collection job was run last on the volume. A null value or empty string means the job ran successfully.

LastGarbageCollectionTime

Data type: datetime
Access type: Read-only

The date and time when a garbage collection job was run last on the volume. This date and time will stay constant between garbage collection jobs.

LastOptimizationResult

Data type: uint32
Access type: Read-only

The error code from when an optimization job was run last on the volume. A value of zero means the job ran successfully.

LastOptimizationResultMessage

Data type: string
Access type: Read-only

The error message from when an optimization job was run last on the volume. A null value or empty string means the job ran successfully.

LastOptimizationTime

Data type: datetime
Access type: Read-only

The data and time when an optimization job was run last on the volume. This date and time will stay constant between optimization jobs.

LastScrubbingResult

Data type: uint32
Access type: Read-only

The error code from when a scrubbing job was run last on the volume. A value of zero means the job ran successfully.

LastScrubbingResultMessage

Data type: string
Access type: Read-only

The error message from when a scrubbing job was run last on the volume. A null value or empty string means the job ran successfully.

LastScrubbingTime

Data type: datetime
Access type: Read-only

The data and time when a scrubbing job was run last on the volume. This date and time will stay constant between scrubbing jobs.

OptimizedFilesCount

Data type: uint64
Access type: Read-only

The number of optimized files on the volume. Note that this number will remain steady (instead of decrease) as users delete files from, or add files to, the volume until you run a garbage collection job. This count is most accurate after a garbage collection job runs.

OptimizedFilesSavingsRate

Data type: uint32
Access type: Read-only

The ratio of deduplication saved space to the logical size of all optimized files on the volume, expressed as a percentage. Note that this number will remain steady as users delete files from, or add new files to, the volume-until you run an optimization job or execute the Update method of the MSFT_DedupVolumeStatus class. This number is most accurate after an optimization job runs or the Update method is executed.

OptimizedFilesSize

Data type: uint64
Access type: Read-only

The aggregate size of all optimized files on the volume. Note that this number will remain steady (instead of decrease) as users delete files from, or add new files to, the volume until you run a garbage collection job. This number is most accurate after a garbage collection job runs.

SavedSpace

Data type: uint64
Access type: Read-only

Saved space is the difference between the logical size of the optimized files and the logical size of the store (the deduplicated user data plus deduplication metadata). Note that this number will remain steady as users delete files from, or add new files to, the volume until you run an optimization job or execute the Update method. This number is most accurate after an optimization job runs or the Update method is executed.

SavingsRate

Data type: uint32
Access type: Read-only

The ratio of deduplication saved space to the logical size of all of the files on the volume and is expressed in percentage. Note that this number will remain steady as users delete files from, or add new files to, the volume until you run an optimization job or execute the Update method. This number is most accurate after an optimization job runs or the Update method is executed.

UnoptimizedSize

Data type: uint64
Access type: Read-only

The total logical size of all files on the volume, in bytes. This includes all files, optimized and non-optimized. Note that this number will remain steady as users delete optimized files from the volume-until you run an optimization job or execute the Update method of the MSFT_DedupVolumeStatus class. This number is most accurate after an optimization job runs or the Update method is executed.

UsedSpace

Data type: uint64
Access type: Read-only

The amount of used space on the volume, in bytes.

Volume

Data type: String
Access type: Read-only

A drive letter (for example, D:) or volume GUID path for the volume.

VolumeId

Data type: String
Access type: Read-only
Qualifiers: key

A volume GUID path for the volume. A volume GUID path is a string of the form "\\?\Volume{GUID}\" where GUID is a GUID that identifies the volume.

Requirements


Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\Deduplication
MOF	DeduplicationProvider.mof
DLL	DdpWmi.dll

Share via