MSFT_DedupJob
Collapse the table of content
Expand the table of content

MSFT_DedupJob class

Represents a currently active data deduplication job.

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

Syntax

[dynamic, provider("DeduplicationProvider"), ClassVersion("1.0"), AMENDMENT]
class MSFT_DedupJob
{
  String   Id;
  uint32   ProcessId;
  String   Volume;
  String   VolumeId;
  uint32   Type;
  uint32   ScheduleType;
  boolean  StopWhenSystemBusy;
  uint32   Priority;
  uint32   Memory;
  uint32   Cores;
  uint32   InputOutputThrottle;
  uint32   InputOutputThrottleLevel;
  uint32   State;
  uint32   Progress;
  datetime StartTime;
  boolean  Full;
  boolean  ReadOnly;
};

Members

The MSFT_DedupJob class has these types of members:

Methods

The MSFT_DedupJob class has these methods.

MethodDescription
Start

Queues a new data deduplication job of the specified type for the specified volumes.

Stop

Cancels the specified data deduplication job or jobs.

 

Properties

The MSFT_DedupJob class has these properties.

Cores
Data type: uint32
Access type: Read/write

Windows Server 2012 R2 and Windows Server 2012:  This property is not available before Windows Server 2016 Technical Preview.

The maximum percentage of physical machine cores that the job can use.

Full
Data type: boolean
Access type: Read-only

If True, the job runs in a more thorough and resource intensive mode. This property applies to garbage collection and scrubbing jobs.

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

A string that uniquely identifies the job.

InputOutputThrottle
Data type: uint32
Access type: Read/write

Windows Server 2012 R2 and Windows Server 2012:  This property is not available before Windows Server 2016 Technical Preview.

The amount of I/O throttling of the job to ensure that it does not interfere with other heavy I/O processes on the system. This value can range from "0" to "100".

InputOutputThrottleLevel
Data type: uint32
Access type: Read/write

The level of I/O throttling of the job to ensure that it does not interfere with other heavy I/O processes on the system.

Windows Server 2012:  This property is not supported until Windows Server 2012 R2.

None (1)

Low (2)

Medium (3)

High (4)

Maximum (5)

Memory
Data type: uint32
Access type: Read-only

The maximum percentage of physical machine memory that can be consumed by this job. For optimization jobs, a range from 15-50 is suggested—with lower memory consumption for jobs that are scheduled to run when the StopWhenSystemBusy property is set to false. For garbage collection and scrubbing jobs, which are typically run at off hours, a higher memory consumption can be safely specified—for example, 50.

Priority
Data type: uint32
Access type: Read-only

The CPU and I/O priority for the deduplication job. For jobs that are scheduled to run when the StopWhenSystemBusy property is set to false, setting this property to Low might make sense. For most other optimization jobs, setting this property to Normal is the most efficient.

Low (1)

Normal (2)

High (3)

ProcessId
Data type: uint32
Access type: Read-only

Process ID of the process in which the deduplication job is running.

Progress
Data type: uint32
Access type: Read-only

The percentage of the job that is completed so far.

ReadOnly
Data type: boolean
Access type: Read-only

If true, the job runs in read-only mode. This property only applies to scrubbing jobs.

ScheduleType
Data type: uint32
Access type: Read-only

Manual jobs are given priority over scheduled jobs.

Scheduled (1)

Manual (2)

StartTime
Data type: datetime
Access type: Read-only

The time to start this job. By default, this property is set to 1:45 A. M. Type the date in a format that is standard for the system locale, such as dd-MM-yyyy (German [Germany]) or MM/dd/yyyy (English [United States]).

State
Data type: uint32
Access type: Read-only

The execution state of the job.

Queued (1)

Initializing (2)

Running (3)

Completed (4)

PendingCancel (5)

Canceled (6)

Failed (7)

StopWhenSystemBusy
Data type: boolean
Access type: Read-only

If True, the job stops running when the system is busy and retries later. If the schedule is for high priority jobs, then set this property to false.

Type
Data type: uint32
Access type: Read-only

The type of data deduplication job.

Optimization (1)

This job performs both deduplication and compression of files according data deduplication policy for the volume. After initial optimization of a file, if that file is then modified and again meets the data deduplication policy threshold for optimization, the file is optimized again.

GarbageCollection (2)

This job processes previously deleted or logically overwritten optimized content to create usable volume free space. When an optimized file is deleted or overwritten by new data, the old data in the chunk store is not deleted right away. By default, garbage collection is scheduled to run weekly. We recommend to run it manually only after large deletions have occurred.

Scrubbing (3)

This job processes data corruptions found during data integrity validation, performs possible corruption repair, and generates a scrubbing report.

Unoptimization (4)

This job undoes deduplication on all of the optimized files on the volume. At the end of a successful unoptimization job, all of the data deduplication metadata is deleted from the volume.

Volume
Data type: String
Access type: Read-only

A drive letter (for example, D:) or 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.

VolumeId
Data type: String
Access type: Read-only

A volume GUID path for the volume.

Examples

For an example that uses the MSFT_DedupJob class, please see Data deduplication backup and restore sample.

Requirements

Minimum supported client

None supported

Minimum supported server

Windows Server 2012

Namespace

Root\Microsoft\Windows\Deduplication

MOF

DeduplicationProvider.mof

DLL

DdpWmi.dll

See also

Data Deduplication Management WMI API Reference

 

 

Show:
© 2016 Microsoft