community.windows.win_file_compression – Alters the compression of files and directories on NTFS partitions.¶
Note
This plugin is part of the community.windows collection (version 1.3.0).
To install it use: ansible-galaxy collection install community.windows
.
To use it in a playbook, specify: community.windows.win_file_compression
.
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¶
Notes¶
Note
community.windows.win_file_compression sets 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
Examples¶
- name: Compress log files directory
community.windows.win_file_compression:
path: C:\Logs
state: present
- name: Decompress log files directory
community.windows.win_file_compression:
path: C:\Logs
state: absent
- name: Compress reports directory and all subdirectories
community.windows.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)
community.windows.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.
|
Authors¶
Micah Hunsberger (@mhunsber)