community.windows.win_file_compression – Alters the compression of files and directories on NTFS partitions.
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.2.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
Parameter | Choices/Defaults | Comments |
---|---|---|
force boolean |
|
This option only has an effect when recurse is If If If the folder structure is complex or contains a lot of files, it is recommended to set this option to |
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 |
|
Whether to recursively apply changes to all subdirectories and files. This option only has an effect when path is a directory. When set to When set to |
state string |
|
Set to Set to |
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/windows/win_file_compression_module.html