win_file_compression – Alters the compression of files and directories on NTFS partitions¶
- 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.
win_file_compressionsets the file system’s compression state, it does not create a zip archive file.
- For more about NTFS Compression, see http://www.ntfs.com/ntfs-compressed.htm
- 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
Common return values are documented here, the following are the fields unique to this module:
The return code of the compress/uncompress operation.
If no changes are made or the operation is successful, rc is 0.