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

注意

此模块是 ansible-core 的一部分，包含在所有 Ansible 安装中。在大多数情况下，即使不指定集合关键字，也可以使用短模块名 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"` ← (默认)
unsafe_writes 布尔值	影响何时使用原子操作以防止数据损坏或从目标文件系统对象读取不一致。默认情况下，此模块使用原子操作来防止数据损坏或从目标文件系统对象读取不一致，但有时系统的配置或损坏的方式会阻止这种情况。一个示例是 docker 挂载的文件系统对象，它不能从容器内部以原子方式更新，并且只能以不安全的方式写入。此选项允许 Ansible 在原子操作失败时回退到更新文件系统对象的不安全方法（但是，它不会强制 Ansible 执行不安全写入）。重要！不安全写入容易出现竞争条件，并可能导致数据损坏。选项 `false` ← (默认) `true`
validate 字符串	将更新后的文件复制到最终目标之前要运行的验证命令。临时文件路径用于验证，通过 `%s` 传递，该路径必须像以下示例中一样存在。此外，该命令是安全传递的，因此 shell 功能（例如扩展和管道）将不起作用。有关如何处理比此选项提供的更复杂的验证的示例，请参见处理复杂验证。

属性 

属性	支持	描述
check_mode	支持: 完全	可以在 check_mode 中运行并返回更改状态预测，而无需修改目标，如果不支持，则将跳过该操作。
diff_mode	支持: 完全	当处于 diff 模式时，将返回有关已更改（或可能需要在 check_mode 中更改）的详细信息
platform	平台： posix	可以操作的目标操作系统/系列
safe_file_operations	支持: 完全	使用 Ansible 严格的文件操作函数，以确保正确的权限并避免数据损坏
vault	支持：无	可以自动解密 Ansible Vault 加密的文件

备注 

注意

从 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 模块 – 管理文本文件中的行

概要

参数

属性

备注

参见

示例

作者

集合链接

概要 

参数 

属性 

备注 

参见 

示例 