community.windows.win_data_deduplication (2.2.0) — module

Install collection

Install with ansible-galaxy collection install community.windows:==2.2.0

Add to requirements.yml

  collections:
    - name: community.windows
      version: 2.2.0

Description

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).

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Wether to enable or disable data deduplication on the selected volume.
    type: str

settings:
    description:
    - Dictionary of settings to pass to the Set-DedupVolume powershell command.
    suboptions:
      minimum_file_age_days:
        default: 2
        description:
        - Minimum file age you want to target for deduplication.
        type: int
      minimum_file_size:
        default: 32768
        description:
        - 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.
        type: int
      no_compress:
        default: false
        description:
        - Wether you want to enabled filesystem compression or not.
        type: bool
      optimize_in_use_files:
        default: false
        description:
        - Indicates that the server attempts to optimize currently open files.
        type: bool
      verify:
        default: false
        description:
        - 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.
        type: bool
    type: dict

drive_letter:
    description:
    - Windows drive letter on which to enable data deduplication.
    required: true
    type: str