community.windows.win_data_deduplication – Module to enable Data Deduplication on a volume.

Note

This plugin is part of the community.windows collection (version 1.9.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.windows.

To use it in a playbook, specify: community.windows.win_data_deduplication.

Synopsis

  • This module can be used to enable Data Deduplication on a Windows volume.

  • The module will install the FS-Data-Deduplication feature (a reboot will be necessary).

Parameters

Parameter Choices/Defaults Comments
drive_letter
string / required
Windows drive letter on which to enable data deduplication.
settings
dictionary
Dictionary of settings to pass to the Set-DedupVolume powershell command.
minimum_file_age_days
integer
Default:
2
Minimum file age you want to target for deduplication.
minimum_file_size
integer
Default:
32768
Minimum file size you want to target for deduplication.
It will default to 32768 if not defined or if the value is less than 32768.
no_compress
boolean
    Choices:
  • no ←
  • yes
Wether you want to enabled filesystem compression or not.
optimize_in_use_files
boolean
    Choices:
  • no ←
  • yes
Indicates that the server attempts to optimize currently open files.
verify
boolean
    Choices:
  • no ←
  • yes
Indicates whether the deduplication engine performs a byte-for-byte verification for each duplicate chunk that optimization creates, rather than relying on a cryptographically strong hash.
This option is not recommend.
Setting this parameter to True can degrade optimization performance.
state
string
    Choices:
  • present ←
  • absent
Wether to enable or disable data deduplication on the selected volume.

Examples

- name: Enable Data Deduplication on D
  community.windows.win_data_deduplication:
    drive_letter: 'D'
    state: present

- name: Enable Data Deduplication on D
  community.windows.win_data_deduplication:
    drive_letter: 'D'
    state: present
    settings:
      no_compress: true
      minimum_file_age_days: 1
      minimum_file_size: 0

Authors

  • rnsc (@rnsc)