Create method of the MSFT_DedupJobSchedule class
Creates a new data deduplication schedule (with default settings, if none are specified) and returns a deduplication schedule CIM object that can be used to customize the schedule.
Syntax
uint32 Create(
[in] string Name,
[in] uint32 Type,
[in] boolean Disable,
[in] datetime Start,
[in] uint32 DurationHours,
[in] sint32 Days[],
[in] boolean StopWhenSystemBusy,
[in] uint32 Memory,
[in] uint32 Cores,
[in] uint32 Priority,
[in] uint32 InputOutputThrottle,
[in] uint32 InputOutputThrottleLevel,
[in] boolean Full,
[in] boolean ReadOnly,
[out] MSFT_DedupJobSchedule DedupJobSchedule
);
Parameters
-
Name [in]
-
A friendly name for the data deduplication job schedule that will be created.
-
Type [in]
-
The type of data deduplication job to run when this schedule is triggered.
-
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 will be 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 garbage collection 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.
Disable [in]
Creates this new job schedule, but immediately disables it so that it does not run when the system clock reaches the date and time specified by the Start parameter. To re-enable the job schedule after it has been disabled, modify the Enabled property of the CIM object instance.
Start [in]
The time to start this job. By default, this parameter 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]).
DurationHours [in]
The number of hours that this job should run before it is stopped if the job is not completed prior to the elapsed hours. All deduplication jobs can be safely stopped with no impact on the files in process. If this parameter is set to zero, the scheduled job runs until completed.
Days [in]
The day of the week on which this weekly schedule runs.
Sunday (0)
Monday (1)
Tuesday (2)
Wednesday (3)
Thursday (4)
Friday (5)
Saturday (6)
StopWhenSystemBusy [in]
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 parameter to false.
Memory [in]
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 parameter 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.
Cores [in]
The maximum percentage of physical machine cores that the job can use.
Windows Server 2012 R2 and Windows Server 2012: This property is not available before Windows Server 2016.
Priority [in]
Sets the CPU and I/O priority for the optimization job run by this schedule. For jobs that are scheduled to run when the StopWhenSystemBusy parameter is set to false, setting this parameter to Low might make sense. For most other optimization jobs, setting this parameter to Normal is the most efficient.
Low (1)
Normal (2)
High (3)
InputOutputThrottle [in]
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".
Windows Server 2012 R2 and Windows Server 2012: This property is not available before Windows Server 2016.
InputOutputThrottleLevel [in]
Amount that the dedupliction job throttles I/O to limit interference with other I/O intense processes.
Windows Server 2012: This parameter is not supported until Windows Server 2012 R2.
None (1)
Low (2)
Medium (3)
High (4)
Maximum (5)
Full [in]
If True, the job runs in a more thorough and resource intensive mode. This parameter applies to garbage collection and scrubbing jobs.
ReadOnly [in]
If True, the job runs in read-only mode. This parameter only applies to scrubbing jobs.
DedupJobSchedule [out]
Array of references to the newly created deduplication jobs.
Return value
This method returns either a Windows Management Instrumentation (WMI) return code or a system error code.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\Microsoft\Windows\Deduplication |
| MOF |
|
| DLL |
|