ansible.builtin.lineinfile 模块 – 管理文本文件中的行

注意

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

概述 

此模块确保特定行位于文件中，或使用反向引用的正则表达式替换现有行。
这主要在您只想更改文件中的单行时很有用。
如果您想更改多个类似的行，请参阅 ansible.builtin.replace 模块，或者如果您想插入/更新/删除文件中的行块，请检查 ansible.builtin.blockinfile。对于其他情况，请参阅 ansible.builtin.copy 或 ansible.builtin.template 模块。

参数 

参数	注释
attributes 别名：attr 字符串	结果文件系统对象应具有的属性。要获得支持的标志，请查看目标系统上 `chattr` 的手册页。此字符串应包含与 `lsattr` 显示的顺序相同的属性。 `=` 运算符被认为是默认运算符，否则需要在字符串中包含 `+` 或 `-` 运算符。
backrefs 布尔值	与 `state=present` 一起使用。如果设置，`line` 可以包含反向引用（位置引用和命名引用），如果 `regexp` 匹配，这些反向引用将被填充。此参数略微改变了模块的操作；`insertbefore` 和 `insertafter` 将被忽略，如果 `regexp` 在文件中任何地方都不匹配，则文件将保持不变。如果 `regexp` 匹配，则最后匹配的行将被扩展的行参数替换。与 `search_string` 互斥。选项 `false` ← (默认) `true`
backup 布尔值	创建一个备份文件，包括时间戳信息，以便您可以在错误地覆盖文件的情况下恢复原始文件。选项 `false` ← (默认) `true`
create 布尔值	与 `state=present` 一起使用。如果指定，则如果文件不存在，将创建该文件。默认情况下，如果文件丢失，它将失败。选项 `false` ← (默认) `true`
firstmatch 布尔值	与 `insertafter` 或 `insertbefore` 一起使用。如果设置，`insertafter` 和 `insertbefore` 将与第一个与给定正则表达式匹配的行一起使用。选项 `false` ← (默认) `true`
group 字符串	应拥有文件系统对象的组的名称，如将馈送到 `chown`。如果未指定，它将使用当前用户的当前组，除非您是 root 用户，在这种情况下，它可以保留先前的所有权。
insertafter 字符串	与 `state=present` 一起使用。如果指定，则行将插入到指定正则表达式的最后一次匹配之后。如果需要第一次匹配，请使用 (firstmatch=yes)。可以使用一个特殊值；`EOF` 用于在文件末尾插入行。如果指定的正则表达式没有匹配项或没有传递值，则将使用 `EOF` 作为替代。如果 `insertbefore` 已设置，则默认值 `EOF` 将被忽略。如果将正则表达式传递给 `regexp` 和 `insertafter`，则只有在没有找到 `regexp` 的匹配项时，才会使用 `insertafter`。不能与 `backrefs` 或 `insertbefore` 一起使用。
insertbefore 字符串	与 `state=present` 一起使用。如果指定，则行将插入到指定正则表达式的最后一次匹配之前。如果需要第一次匹配，请使用 `firstmatch=yes`。可以使用一个值；`BOF` 用于在文件开头插入行。如果指定的正则表达式没有匹配项，则行将插入到文件末尾。如果将正则表达式传递给 `regexp` 和 `insertbefore`，则只有在没有找到 `regexp` 的匹配项时，才会使用 `insertbefore`。不能与 `backrefs` 或 `insertafter` 一起使用。
line 别名: value 字符串	要插入/替换到文件中的行。对于 `state=present` 而言，这是必需的。如果设置了 `backrefs`，则可以包含在 `regexp` 捕获组匹配时会被扩展的回溯引用。
mode any	生成的文件系统对象应该具有的权限。对于那些习惯使用 `/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 而不是用户名。避免使用数字用户名以避免混淆。
path 别名: dest, destfile, name path / required	要修改的文件。在 Ansible 2.3 之前，此选项只能用作 `dest`、`destfile` 和 `name`。
regexp 别名: regex 字符串	要在文件每一行中查找的正则表达式。对于 `state=present`，如果找到，则为要替换的模式。将替换最后找到的一行。对于 `state=absent`，要删除的行的模式。如果正则表达式未匹配，则根据 `insertbefore` 或 `insertafter` 设置将该行添加到文件中。修改行时，正则表达式通常应该同时匹配行的初始状态以及通过 `line` 替换后的状态，以确保幂等性。使用 Python 正则表达式。请参见 https://docs.pythonlang.cn/3/library/re.html.
search_string 字符串添加到 ansible-core 2.11 中	要在文件每一行中查找的字面字符串。它不必匹配整行。对于 `state=present`，如果在文件中找到字符串，则为要替换的行。将替换最后找到的一行。对于 `state=absent`，如果该字符串在行中，则要删除的行。如果字面表达式未匹配，则根据 `insertbefore` 或 `insertafter` 设置将该行添加到文件中。与 `backrefs` 和 `regexp` 相互排斥。
selevel 字符串	SELinux 文件系统对象上下文的级别部分。这是 MLS/MCS 属性，有时称为 `range`。设置为 `_default` 时，如果可用，它将使用策略的 `level` 部分。
serole 字符串	SELinux 文件系统对象上下文的角色部分。设置为 `_default` 时，如果可用，它将使用策略的 `role` 部分。
setype 字符串	SELinux 文件系统对象上下文的类型部分。设置为 `_default` 时，如果可用，它将使用策略的 `type` 部分。
seuser 字符串	SELinux 文件系统对象上下文的用户部分。默认情况下，它使用 `system` 策略（如果适用）。设置为 `_default` 时，如果可用，它将使用策略的 `user` 部分。
state 字符串	该行是否应该存在。选项 `"absent"` `"present"` ← (default)
unsafe_writes 布尔值	影响何时使用原子操作来防止目标文件系统对象数据损坏或不一致的读取。默认情况下，此模块使用原子操作来防止目标文件系统对象数据损坏或不一致的读取，但有时系统会以阻止此操作的方式进行配置或发生故障。一个例子是 docker 挂载的文件系统对象，它不能从容器内部以原子方式更新，只能以不安全的方式写入。此选项允许 Ansible 在原子操作失败时回退到不安全的文件系统对象更新方法（但是，它不会强制 Ansible 执行不安全写入）。重要提示！不安全写入会受到竞争条件的影响，并可能导致数据损坏。选项 `false` ← (默认) `true`
validate 字符串	在将更新后的文件复制到最终目标之前要运行的验证命令。一个临时文件路径用于验证，通过 `%s` 传递，该路径必须存在，如以下示例所示。此外，该命令以安全的方式传递，因此 shell 功能（例如扩展和管道）将不起作用。有关如何处理比此选项提供的更复杂的验证的示例，请参见处理复杂的验证.

属性 

属性	支持	描述
check_mode	支持: full	可以在 check_mode 下运行，并在不修改目标的情况下返回已更改状态的预测，如果不支持，则操作将被跳过。
diff_mode	支持: full	将在 diff 模式下返回有关更改内容（或可能需要更改内容（在 check_mode 下））的详细信息
platform	平台: posix	可以对其执行操作的目标操作系统/系列
safe_file_operations	支持: full	使用 Ansible 的严格文件操作函数来确保正确的权限并避免数据损坏
vault	支持: none	可以自动解密 Ansible 保险库文件

备注 

注意

从 Ansible 2.3 开始，dest 选项已更改为 path 作为默认值，但 dest 仍然有效。

另请参见 

另请参见

ansible.builtin.blockinfile: 插入/更新/删除由标记行包围的文本块。
ansible.builtin.copy: 将文件复制到远程位置。
ansible.builtin.file: 管理文件和文件属性。
ansible.builtin.replace: 使用带反向引用的正则表达式替换文件中所有特定字符串的实例。
ansible.builtin.template: 将文件模板化到目标主机。
community.windows.win_lineinfile: 有关 **community.windows.win_lineinfile** 模块的官方文档。

示例 

# NOTE: Before 2.3, option 'dest', 'destfile' or 'name' was used instead of 'path'
- name: Ensure SELinux is set to enforcing mode
  ansible.builtin.lineinfile:
    path: /etc/selinux/config
    regexp: '^SELINUX='
    line: SELINUX=enforcing

- name: Make sure group wheel is not in the sudoers configuration
  ansible.builtin.lineinfile:
    path: /etc/sudoers
    state: absent
    regexp: '^%wheel'

- name: Replace a localhost entry with our own
  ansible.builtin.lineinfile:
    path: /etc/hosts
    regexp: '^127\.0\.0\.1'
    line: 127.0.0.1 localhost
    owner: root
    group: root
    mode: '0644'

- name: Replace a localhost entry searching for a literal string to avoid escaping
  ansible.builtin.lineinfile:
    path: /etc/hosts
    search_string: '127.0.0.1'
    line: 127.0.0.1 localhost
    owner: root
    group: root
    mode: '0644'

- name: Ensure the default Apache port is 8080
  ansible.builtin.lineinfile:
    path: /etc/httpd/conf/httpd.conf
    regexp: '^Listen '
    insertafter: '^#Listen '
    line: Listen 8080

- name: Ensure php extension matches new pattern
  ansible.builtin.lineinfile:
    path: /etc/httpd/conf/httpd.conf
    search_string: '<FilesMatch ".php[45]?$">'
    insertafter: '^\t<Location \/>\n'
    line: '        <FilesMatch ".php[34]?$">'

- name: Ensure we have our own comment added to /etc/services
  ansible.builtin.lineinfile:
    path: /etc/services
    regexp: '^# port for http'
    insertbefore: '^www.*80/tcp'
    line: '# port for http by default'

- name: Add a line to a file if the file does not exist, without passing regexp
  ansible.builtin.lineinfile:
    path: /tmp/testfile
    line: 192.168.1.99 foo.lab.net foo
    create: yes

# NOTE: Yaml requires escaping backslashes in double quotes but not in single quotes
- name: Ensure the JBoss memory settings are exactly as needed
  ansible.builtin.lineinfile:
    path: /opt/jboss-as/bin/standalone.conf
    regexp: '^(.*)Xms(\d+)m(.*)$'
    line: '\1Xms${xms}m\3'
    backrefs: yes

# NOTE: Fully quoted because of the ': ' on the line. See the Gotchas in the YAML docs.
- name: Validate the sudoers file before saving
  ansible.builtin.lineinfile:
    path: /etc/sudoers
    state: present
    regexp: '^%ADMIN ALL='
    line: '%ADMIN ALL=(ALL) NOPASSWD: ALL'
    validate: /usr/sbin/visudo -cf %s

# See https://docs.pythonlang.cn/3/library/re.html for further details on syntax
- name: Use backrefs with alternative group syntax to avoid conflicts with variable values
  ansible.builtin.lineinfile:
    path: /tmp/config
    regexp: ^(host=).*
    line: \g<1>{{ hostname }}
    backrefs: yes

作者

Daniel Hokka Zakrissoni (@dhozac)
Ahti Kitsik (@ahtik)
Jose Angel Munoz (@imjoseangel)

ansible.builtin.lineinfile 模块 – 管理文本文件中的行

概述

参数

属性

备注

另请参见

示例

作者

集合链接

概述 

参数 

属性 

备注 

另请参见 

示例 