community.windows.win_file_compression 模块 – 更改 NTFS 分区上文件和目录的压缩属性。

注意

此模块是 community.windows 集合 (版本 2.3.0) 的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.windows。

要在 playbook 中使用它，请指定：community.windows.win_file_compression。

概要 

此模块设置支持 NTFS 等文件系统的文件和目录的压缩属性。
NTFS 压缩可用于节省磁盘空间。

参数 

参数	注释
force 布尔值	此选项仅在 recurse 为 `true` 时有效。如果为 `true`，将检查所有子目录和文件的压缩状态，如果任何状态与 compressed 不同，则进行更改。如果为 `false`，则仅当 path 的压缩状态与 compressed 不同时才进行更改。如果文件夹结构复杂或包含大量文件，建议将此选项设置为 `false`，以便不必检查每个文件。选项 `false` `true` ← (默认)
path 路径 / 必需	要修改的文件或目录的完整路径。路径必须存在于支持压缩的文件系统（如 NTFS）上。
recurse 布尔值	是否将更改递归应用于所有子目录和文件。此选项仅当 path 是目录时有效。设置为 `false` 时，仅将更改应用于 path。设置为 `true` 时，将更改应用于 path 和所有子目录和文件。选项 `false` ← (默认) `true`
state 字符串	设置为 `present` 以确保 path 被压缩。设置为 `absent` 以确保 path 未被压缩。选项 `"absent"` `"present"` ← (默认)

备注 

注意

community.windows.win_file_compression 设置文件系统的压缩状态，它不会创建 zip 压缩文件。
有关 NTFS 压缩的更多信息，请参见 http://www.ntfs.com/ntfs-compressed.htm

示例 

- 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: true

# 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: true
    recurse: true
    force: false

返回值 

常见的返回值已在此处记录，以下是此模块特有的字段

键	描述
rc 整数	压缩/解压缩操作的返回码。如果没有进行更改或操作成功，则 rc 为 0。返回：始终示例：`0`

作者

Micah Hunsberger (@mhunsber)