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 的扩展名，则 dest 文件名将通过在 src 文件名后附加 _decompressed 来生成。 例如，如果 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

boolean

解压缩后删除原始压缩文件。

选择

  • false ← (默认)

  • true

selevel

字符串

SELinux 文件系统对象上下文的级别部分。

这是 MLS/MCS 属性，有时也称为 range。

当设置为 _default 时，如果可用，它将使用策略的 level 部分。

serole

字符串

SELinux 文件系统对象上下文的角色部分。

当设置为 _default 时，如果可用，它将使用策略的 role 部分。

setype

字符串

SELinux 文件系统对象上下文的类型部分。

当设置为 _default 时，如果可用，它将使用策略的 type 部分。

seuser

字符串

SELinux 文件系统对象上下文的用户部分。

默认情况下，它使用 system 策略（如果适用）。

当设置为 _default 时，如果可用，它将使用策略的 user 部分。

src

path / required

要解压缩的文件的远程绝对路径。

unsafe_writes

boolean

影响何时使用原子操作来防止数据损坏或从目标文件系统对象读取不一致的数据。

默认情况下，此模块使用原子操作来防止数据损坏或从目标文件系统对象读取不一致的数据，但有时系统配置不正确或损坏，从而阻止了这种情况。一个例子是 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)