Ansible Core 文档

ansible.builtin.assemble 模块 – 从片段组装配置文件

注意

此模块是 ansible-core 的一部分，并包含在所有 Ansible 安装中。在大多数情况下，即使不指定 collections 关键字，也可以使用简短的模块名称 assemble。但是，我们建议您使用完全限定集合名称 (FQCN) ansible.builtin.assemble，以便轻松链接到模块文档，并避免与其他可能具有相同模块名称的集合冲突。

概要 

从片段组装配置文件。
通常，特定的程序会使用单个配置文件，并且不支持 conf.d 样式的结构，在这种结构中，可以很容易地从多个源构建配置。ansible.builtin.assemble 将获取一个目录，其中包含可以是本地的或已经传输到系统的文件，并将它们连接在一起以生成目标文件。
文件按字符串排序顺序组装。
Puppet 将此概念称为片段。

注意

此模块具有相应的操作插件。

参数 

参数	注释
attributes 别名: attr 字符串	结果文件系统对象应具有的属性。要获取支持的标志，请查看目标系统上的 `chattr` 的手册页。此字符串应包含与 `lsattr` 显示的顺序相同的属性。 `=` 运算符被假定为默认值，否则需要在字符串中包含 `+` 或 `-` 运算符。
backup 布尔值	创建备份文件（如果为 `true`），包括时间戳信息，以便您可以在以某种方式错误地覆盖它时恢复原始文件。选择 `false` ← (默认) `true`
decrypt 布尔值	此选项控制使用 vault 自动解密源文件。选择 `false` `true` ← (默认)
delimiter 字符串	用于分隔文件内容的定界符。
dest 路径 / 必需	使用所有源文件的串联创建的文件。
group 字符串	应该拥有文件系统对象的所有者的组的名称，将作为 `chown` 的输入。如果未指定，它将使用当前用户的当前组，除非您是 root，在这种情况下，它可以保留以前的所有权。
ignore_hidden 布尔值	一个布尔值，用于控制是否包含以 `.` 开头的文件。选择 `false` ← (默认) `true`
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，而不是用户名。避免使用数字用户名以避免这种混淆。
regexp 字符串	仅当给定的正则表达式与文件名匹配时才组装文件。如果未设置，则组装所有文件。每个 `\`（反斜杠）都必须转义为 `\\` 以符合 YAML 语法。使用 Python 正则表达式。
remote_src 布尔值	如果为 `false`，它将在发起/主计算机上搜索 src。如果为 `true`，它将前往远程/目标计算机查找 src。选择 `false` `true` ← (默认)
selevel 字符串	SELinux 文件系统对象上下文的级别部分。这是 MLS/MCS 属性，有时称为 `range`。设置为 `_default` 时，如果可用，它将使用策略的 `level` 部分。
serole 字符串	SELinux 文件系统对象上下文的角色部分。设置为 `_default` 时，如果可用，它将使用策略的 `role` 部分。
setype 字符串	SELinux 文件系统对象上下文的类型部分。设置为 `_default` 时，如果可用，它将使用策略的 `type` 部分。
seuser 字符串	SELinux 文件系统对象上下文的用户部分。默认情况下，它使用 `system` 策略（如果适用）。设置为 `_default` 时，如果可用，它将使用策略的 `user` 部分。
src 路径 / 必需	一个已经存在的充满源文件的目录。
unsafe_writes 布尔值	影响何时使用原子操作来防止数据损坏或从目标文件系统对象读取不一致的数据。默认情况下，此模块使用原子操作来防止数据损坏或从目标文件系统对象读取不一致的数据，但有时系统的配置方式或仅仅是损坏的方式会阻止这种情况。一个示例是 docker 安装的文件系统对象，这些对象无法从容器内部以原子方式更新，并且只能以不安全的方式写入。当原子操作失败时，此选项允许 Ansible 回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全的写入）。重要！不安全的写入会受到竞争条件的影响，并可能导致数据损坏。选择 `false` ← (默认) `true`
validate 字符串	在复制到位之前要运行的验证命令。要验证的文件的路径由 `%s` 传入，必须如以下 sshd 示例中所示。命令以安全方式传递，因此 shell 功能（如扩展和管道）将不起作用。

属性 

属性	支持	描述
action	支持: 完全	表示它具有相应的操作插件，因此某些选项部分可以在控制器上执行
async	支持: 无	支持与 `async` 关键字一起使用
bypass_host_loop	支持: 无	强制执行一个“全局”任务，该任务不针对每个主机执行。这会绕过每个主机的模板化和串行执行、节流以及其他循环考虑。条件语句的工作方式类似于使用了 `run_once`，使用的变量将来自第一个可用的主机。此操作通常不会在锁定步骤策略之外工作。
check_mode	支持: 无	可以在 check_mode 下运行，并返回更改状态预测，而无需修改目标。如果不支持，则会跳过该操作。
diff_mode	支持: 完全	在 diff 模式下，将返回已更改的内容的详细信息（或在 check_mode 下可能需要更改的内容）。
platform	平台: posix	可以操作的目标操作系统/系列
safe_file_operations	支持: 完全	使用 Ansible 严格的文件操作函数来确保适当的权限并避免数据损坏。
vault	支持: 完全	可以自动解密 Ansible 加密文件。

参见 

参见

ansible.builtin.copy: 将文件复制到远程位置。
ansible.builtin.template: 将文件模板化输出到目标主机。
ansible.windows.win_copy: 关于 ansible.windows.win_copy 模块的官方文档。

示例 

- name: Assemble from fragments from a directory
  ansible.builtin.assemble:
    src: /etc/someapp/fragments
    dest: /etc/someapp/someapp.conf

- name: Insert the provided delimiter between fragments
  ansible.builtin.assemble:
    src: /etc/someapp/fragments
    dest: /etc/someapp/someapp.conf
    delimiter: '### START FRAGMENT ###'

- name: Assemble a new "sshd_config" file into place, after passing validation with sshd
  ansible.builtin.assemble:
    src: /etc/ssh/conf.d/
    dest: /etc/ssh/sshd_config
    validate: /usr/sbin/sshd -t -f %s

作者

Stephen Fromm (@sfromm)

集合链接