Disable method of the MSFT_DedupVolume class

Disables further data deduplication activity on one or more volumes.

Syntax


uint32 Disable(
  [in]  string           Volume[],
  [in]  boolean          DataAccess,
  [out] MSFT_DedupVolume DedupVolume[]
);

Parameters

Volume [in]

A list of file system volumes for which to disable data deduplication. Volumes can be specified by drive letter (for example, D:) or volume GUID path. A volume GUID path is a string of the form "\\?\Volume{GUID}\" where GUID is a GUID that identifies the volume.

DataAccess [in]

Set to TRUE to cause data access to deduplicated files on the volume to be disabled.

DedupVolume [out]

Array of references to the disabled volumes.

Return value

This method returns either a WMI return code or a system error code.

Remarks

After data deduplication is disabled, the volume remains in its deduplicated state, but no more data deduplication jobs will be run for the specified volumes; new data will not be deduplicated. Previously deduplicated data is accessible. To undo deduplication on the volume, call the MSFT_DedupJob::Start method and pass Unoptimization for the Type parameter.

When a volume is Dedup-disabled, all read-only deduplication operations will continue to work (for example, the Get methods for deduplication class properties), but calls to deduplication job-related methods will fail, with the exception of unoptimization and read-only scrubbing jobs.

Examples

For an example that uses the Disable method, 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

MSFT_DedupVolume
MSFT_DedupVolume::Enable

 

 

Show: