community.general.decompress 模块 – 解压缩压缩文件

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.general。您需要其他要求才能使用此模块，有关详细信息，请参阅要求。

要在 playbook 中使用它，请指定： community.general.decompress。

community.general 10.1.0 中的新增功能

概要 

解压缩压缩文件。
源（压缩）文件和目标（解压缩）文件位于远程主机上。
解压缩后可以删除源文件。

要求 

执行此模块的主机需要以下要求。

如果使用 xz 格式，则需要 lzma（Python 3 的标准库）或 backports.lzma（Python 2）。

参数 

参数	注释
attributes 别名：attr 字符串	生成的系统对象应具有的属性。要获取支持的标志，请查看目标系统上 `chattr` 的手册页。此字符串应按 `lsattr` 显示的顺序包含属性。默认情况下假定使用 `=` 运算符，否则需要在字符串中包含 `+` 或 `-` 运算符。
dest 路径	将压缩文件解压缩到的目标文件的名称。如果目标文件存在，它将被截断并覆盖。如果未指定，则目标文件名将从 `src` 中通过删除压缩格式扩展名来派生。例如，如果 `src` 是 `/path/to/file.txt.gz` 并且 `format` 是 `gz`，则 `dest` 将为 `/path/to/file.txt`。如果 `src` 文件没有当前 `format` 的扩展名，则将通过向 `src` 文件名附加 `_decompressed` 来创建 `dest` 文件名。例如，如果 `src` 是 `/path/to/file.myextension`，则 (dest) 文件名将为 `/path/to/file.myextension_decompressed`。
format 字符串	用于解压缩的压缩类型。选项 `"gz"` ← (默认) `"bz2"` `"xz"`
group 字符串	应拥有文件系统的组的名称，如同提供给 `chown` 一样。如果未指定，则它使用当前用户的当前组，除非您是 root 用户，在这种情况下，它可以保留之前的拥有者。
mode 任意	生成的系统对象应具有的权限。对于习惯使用 `/usr/bin/chmod` 的用户，请记住模式实际上是八进制数。您必须向 Ansible 提供足够的信息才能正确解析它们。为了获得一致的结果，请引用八进制数（例如，`'644'` 或 `'1777'`），以便 Ansible 接收到字符串并可以自行将字符串转换为数字。添加前导零（例如，`0755`）有时有效，但在循环和其他一些情况下可能会失败。如果不遵循这些规则中的任何一个规则就向 Ansible 提供数字，则最终会得到一个十进制数，这将产生意外的结果。从 Ansible 1.8 开始，模式可以指定为符号模式（例如，`u+rwx` 或 `u=rw,g=r,o=r`）。如果未指定 `mode` 并且目标文件系统对象不存在，则在为新创建的文件系统对象设置模式时，将使用系统上的默认 `umask`。如果未指定`mode`参数且目标文件系统对象已存在，则将使用现有文件系统对象的模式。指定`mode`是确保以正确的权限创建文件系统对象的最佳方法。有关详细信息，请参阅 CVE-2020-1736。
owner (所有者) 字符串	应该拥有文件系统对象的用户名，如同传递给`chown`命令一样。如果未指定，则使用当前用户，除非您是 root 用户，在这种情况下，它可以保留之前的拥有者。指定数字用户名将被视为用户 ID 而不是用户名。避免使用数字用户名以避免混淆。
remove (删除) 布尔值	解压缩后删除原始压缩文件。选项 `false` ← (默认值) `true`
selevel (SELinux 安全级别) 字符串	SELinux 文件系统对象上下文的级别部分。这是 MLS/MCS 属性，有时称为`range`。设置为`_default`时，如果可用，它将使用策略的`level`部分。
serole (SELinux 安全角色) 字符串	SELinux 文件系统对象上下文的角色部分。设置为`_default`时，如果可用，它将使用策略的`role`部分。
setype (SELinux 安全类型) 字符串	SELinux 文件系统对象上下文的类型部分。设置为`_default`时，如果可用，它将使用策略的`type`部分。
seuser (SELinux 安全用户) 字符串	SELinux 文件系统对象上下文的用户部分。默认情况下，它使用`system`策略（如果适用）。设置为`_default`时，如果可用，它将使用策略的`user`部分。
src (源文件) 路径 / 必需	要解压缩文件的远程绝对路径。
unsafe_writes (不安全写入) 布尔值	影响何时使用原子操作来防止数据损坏或目标文件系统对象的不一致读取。默认情况下，此模块使用原子操作来防止数据损坏或目标文件系统对象的不一致读取，但有时系统配置错误或损坏，从而阻止此操作。一个例子是 docker 挂载的文件系统对象，无法在容器内部以原子方式更新，只能以不安全的方式写入。此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全写入）。重要！不安全写入容易出现竞争条件，并可能导致数据损坏。选项 `false` ← (默认值) `true`

属性 

属性	支持	描述
check_mode	支持：完全支持	可以在`check_mode`下运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持：不支持	处于 diff 模式时，将返回有关已更改内容（或可能需要在`check_mode`下更改的内容）的详细信息。

示例 

- name: Decompress file /path/to/file.txt.gz into /path/to/file.txt (gz compression is used by default)
  community.general.decompress:
    src: /path/to/file.txt.gz
    dest: /path/to/file.txt

- name: Decompress file /path/to/file.txt.gz into /path/to/file.txt
  community.general.decompress:
    src: /path/to/file.txt.gz

- name: Decompress file compressed with bzip2
  community.general.decompress:
    src: /path/to/file.txt.bz2
    dest: /path/to/file.bz2
    format: bz2

- name: Decompress file and delete the compressed file afterwards
  community.general.decompress:
    src: /path/to/file.txt.gz
    dest: /path/to/file.txt
    remove: true

返回值 

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

键	描述
dest 字符串	解压缩文件的路径返回值：成功示例：`"/path/to/file.txt"`

作者

Stanislav Shamilov (@shamilovstas)