community.windows.win_file_compression (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 sets the compressed attribute for files and directories on a filesystem that supports it like NTFS.

NTFS compression can be used to save disk space.

Usage examples

Scanned by Steampunk Spotter

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

- name: Compress log files directory
  community.windows.win_file_compression:
    path: C:\Logs
    state: present

Scanned by Steampunk Spotter

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

- name: Decompress log files directory
  community.windows.win_file_compression:
    path: C:\Logs
    state: absent

Scanned by Steampunk Spotter

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

- name: Compress reports directory and all subdirectories
  community.windows.win_file_compression:
    path: C:\business\reports
    state: present
    recurse: yes

Scanned by Steampunk Spotter

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

# This will only check C:\business\reports for the compressed state
# If C:\business\reports is compressed, it will not make a change
# even if one of the child items is uncompressed

- name: Compress reports directory and all subdirectories (quick)
  community.windows.win_file_compression:
    path: C:\business\reports
    compressed: yes
    recurse: yes
    force: no

Inputs

    
path:
    description:
    - The full path of the file or directory to modify.
    - The path must exist on file system that supports compression like NTFS.
    required: true
    type: path

force:
    default: true
    description:
    - This option only has an effect when I(recurse) is C(true)
    - If C(true), will check the compressed state of all subdirectories and files and
      make a change if any are different from I(compressed).
    - If C(false), will only make a change if the compressed state of I(path) is different
      from I(compressed).
    - If the folder structure is complex or contains a lot of files, it is recommended
      to set this option to C(false) so that not every file has to be checked.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Set to C(present) to ensure the I(path) is compressed.
    - Set to C(absent) to ensure the I(path) is not compressed.
    type: str

recurse:
    default: false
    description:
    - Whether to recursively apply changes to all subdirectories and files.
    - This option only has an effect when I(path) is a directory.
    - When set to C(false), only applies changes to I(path).
    - When set to C(true), applies changes to I(path) and all subdirectories and files.
    type: bool

Outputs

rc:
  description:
  - The return code of the compress/uncompress operation.
  - If no changes are made or the operation is successful, rc is 0.
  returned: always
  sample: 0
  type: int