Skip to content

lineinfile

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin
Added in version 0.7.

Synopsis

  • This module ensures a particular line is in a file, or replace an existing line using a back-referenced regular expression.
  • This is primarily useful when you want to change a single line in a file only.
  • See the M(ansible.builtin.replace) module if you want to change multiple, similar lines or check M(ansible.builtin.blockinfile) if you want to insert/update/remove a block of lines in a file. For other cases, see the M(ansible.builtin.copy) or M(ansible.builtin.template) modules.

Parameters

Parameter Defaults / Choices Comments
attributes
str		 The attributes the resulting filesystem object should have.
To get supported flags look at the man page for C(chattr) on the target system.
This string should contain the attributes in the same order as the one displayed by C(lsattr).
The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to be included in the string.
Version Added: 2.3
backrefs
bool		 Used with O(state=present).
If set, O(line) can contain backreferences (both positional and named) that will get populated if the O(regexp) matches.
This parameter changes the operation of the module slightly; O(insertbefore) and O(insertafter) will be ignored, and if the O(regexp) does not match anywhere in the file, the file will be left unchanged.
If the O(regexp) does match, the last matching line will be replaced by the expanded line parameter.
Mutually exclusive with O(search_string).
Version Added: 1.1
backup
bool		 Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
create
bool		 Used with O(state=present).
If specified, the file will be created if it does not already exist.
By default it will fail if the file is missing.
encoding
str		 Default: utf-8
 The character set in which the target file is encoded.
For a list of available built-in encodings, see U(https://docs.python.org/3/library/codecs.html#standard-encodings)
Version Added: 2.20
firstmatch
bool		 Used with O(insertafter) or O(insertbefore).
If set, O(insertafter) and O(insertbefore) will work with the first line that matches the given regular expression.
Version Added: 2.5
group
str		 Name of the group that should own the filesystem object, as would be fed to C(chown).
When left unspecified, it uses the current group of the current user unless you are root, in which case it can preserve the previous ownership.
insertafter
str		 Used with O(state=present).
If specified, the line will be inserted after the last match of specified regular expression.
If the first match is required, use(firstmatch=yes).
A special value is available; V(EOF) for inserting the line at the end of the file.
If specified regular expression has no matches or no value is passed, V(EOF) will be used instead.
If O(insertbefore) is set, default value V(EOF) will be ignored.
If regular expressions are passed to both O(regexp) and O(insertafter), O(insertafter) is only honored if no match for O(regexp) is found.
May not be used with O(backrefs) or O(insertbefore).
insertbefore
str		 Used with O(state=present).
If specified, the line will be inserted before the last match of specified regular expression.
If the first match is required, use O(firstmatch=yes).
A value is available; V(BOF) for inserting the line at the beginning of the file.
If specified regular expression has no matches, the line will be inserted at the end of the file.
If regular expressions are passed to both O(regexp) and O(insertbefore), O(insertbefore) is only honored if no match for O(regexp) is found.
May not be used with O(backrefs) or O(insertafter).
Version Added: 1.1
line
str		 The line to insert/replace into the file.
Required for O(state=present).
If O(backrefs) is set, may contain backreferences that will get expanded with the O(regexp) capture groups if the regexp matches.
mode
raw		 The permissions the resulting filesystem object should have.
For those used to C(/usr/bin/chmod) remember that modes are actually octal numbers. You must give Ansible enough information to parse them correctly. For consistent results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives a string and can do its own conversion from string into number. Adding a leading zero (for example, V(0755)) works sometimes, but can fail in loops and some other circumstances.
Giving Ansible a number without following either of these rules will end up with a decimal number which will have unexpected results.
As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx) or V(u=rw,g=r,o=r)).
If O(mode) is not specified and the destination filesystem object B(does not) exist, the default C(umask) on the system will be used when setting the mode for the newly created filesystem object.
If O(mode) is not specified and the destination filesystem object B(does) exist, the mode of the existing filesystem object will be used.
Specifying O(mode) is the best way to ensure filesystem objects are created with the correct permissions. See CVE-2020-1736 for further details.
owner
str		 Name of the user that should own the filesystem object, as would be fed to C(chown).
When left unspecified, it uses the current user unless you are root, in which case it can preserve the previous ownership.
Specifying a numeric username will be assumed to be a user ID and not a username. Avoid numeric usernames to avoid this confusion.
path
path
required		 The file to modify.
Before Ansible 2.3 this option was only usable as O(dest), O(destfile) and O(name).
regexp
str		 The regular expression to look for in every line of the file.
For O(state=present), the pattern to replace if found. Only the last line found will be replaced.
For O(state=absent), the pattern of the line(s) to remove.
If the regular expression is not matched, the line will be added to the file in keeping with O(insertbefore) or O(insertafter) settings.
When modifying a line the regexp should typically match both the initial state of the line as well as its state after replacement by O(line) to ensure idempotence.
Uses Python regular expressions. See U(https://docs.python.org/3/library/re.html).
Version Added: 1.7
search_string
str		 The literal string to look for in every line of the file. This does not have to match the entire line.
For O(state=present), the line to replace if the string is found in the file. Only the last line found will be replaced.
For O(state=absent), the line(s) to remove if the string is in the line.
If the literal expression is not matched, the line will be added to the file in keeping with O(insertbefore) or O(insertafter) settings.
Mutually exclusive with O(backrefs) and O(regexp).
Version Added: 2.11
selevel
str		 The level part of the SELinux filesystem object context.
This is the MLS/MCS attribute, sometimes known as the C(range).
When set to V(_default), it will use the C(level) portion of the policy if available.
serole
str		 The role part of the SELinux filesystem object context.
When set to V(_default), it will use the C(role) portion of the policy if available.
setype
str		 The type part of the SELinux filesystem object context.
When set to V(_default), it will use the C(type) portion of the policy if available.
seuser
str		 The user part of the SELinux filesystem object context.
By default it uses the V(system) policy, where applicable.
When set to V(_default), it will use the C(user) portion of the policy if available.
state
str		 Default: present
Choices: absent, present		 Whether the line should be there or not.
unsafe_writes
bool		 Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target filesystem object.
By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target filesystem objects, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted filesystem objects, which cannot be updated atomically from inside the container and can only be written in an unsafe manner.
This option allows Ansible to fall back to unsafe methods of updating filesystem objects when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes).
IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
Version Added: 2.2
validate
str		 The validation command to run before copying the updated file into the final destination.
A temporary file path is used to validate, passed in through C(%s) which must be present as in the examples below.
Also, the command is passed securely so shell features such as expansion and pipes will not work.
For an example on how to handle more complex validation than what this option provides, see R(handling complex validation,complex_configuration_validation).

Notes

Note

  • As of Ansible 2.3, the O(dest) option has been changed to O(path) as default, but O(dest) still works as well.

Examples

# 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.python.org/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

Authors

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