win_file_compression – Alters the compression of files and directories on NTFS partitions

Synopsis

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

Parameters

Parameter Choices/Defaults Comments
force
boolean
    Choices:
  • no
  • yes ←
This option only has an effect when recurse is true
If true, will check the compressed state of all subdirectories and files and make a change if any are different from compressed.
If false, will only make a change if the compressed state of path is different from compressed.
If the folder structure is complex or contains a lot of files, it is recommended to set this option to false so that not every file has to be checked.
path
path / required
The full path of the file or directory to modify.
The path must exist on file system that supports compression like NTFS.
recurse
boolean
    Choices:
  • no ←
  • yes
Whether to recursively apply changes to all subdirectories and files.
This option only has an effect when path is a directory.
When set to false, only applies changes to path.
When set to true, applies changes to path and all subdirectories and files.
state
string
    Choices:
  • absent
  • present ←
Set to present to ensure the path is compressed.
Set to absent to ensure the path is not compressed.

Notes

Note

Examples

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

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

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

# 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)
  win_file_compression:
    path: C:\business\reports
    compressed: yes
    recurse: yes
    force: no

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
rc
integer
always
The return code of the compress/uncompress operation.
If no changes are made or the operation is successful, rc is 0.



Status

Authors

  • Micah Hunsberger (@mhunsber)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.