> LINEINFILE
This module will search a file for a line, and ensure that it is present or absent. This is primarily useful when you want to change a single line in a file only. See the [replace] module if you want to change multiple, similar lines or chec [blockinfile] if you want to insert/update/remove a block of lines in a file. For other cases, see the [copy] or [template] modules.
Options (= is mandatory):
- backrefs
Used with `state=present'. If set, line can contain backreferences (both positional and named) that will get populated
if the `regexp' matches. This flag changes the operation of the module slightly; `insertbefore' and `insertafter' will be ignored, and if the `regexp' doesn't match anywhere in the file, the file will be left unchanged. If the `regexp' does match, the last matching line will be replaced by the expanded line parameter.
(Choices: yes, no)[Default: no]
- backup
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly.
(Choices: yes, no)[Default: no]
- create
Used with `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.
(Choices: yes, no)[Default: no]
= dest
The file to modify.
- group
name of the group that should own the file/directory, as would be fed to `chown'
[Default: None]
- insertafter
Used with `state=present'. If specified, the line will be inserted after the last match of specified regular expression. A special value is available; `EOF' for inserting the line at the end of the file. If specified regular expression has no matches, EOF will be used instead. May not be used with `backrefs'.
(Choices: EOF, *regex*)[Default: EOF]
- insertbefore
Used with `state=present'. If specified, the line will be inserted before the last match of specified regular expression. A value is available; `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. May not be used with `backrefs'.
(Choices: BOF, *regex*)[Default: (null)]
- line
Required for `state=present'. The line to insert/replace into the file. If `backrefs' is set, may contain backreferences that will get expanded with the `regexp' capture groups if the regexp matches.
[Default: (null)]
- mode
mode the file or directory should be. For those used to `/usr/bin/chmod' remember that modes are actually octal numbers (like 0644). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may
be specified as a symbolic mode (for example, `u+rwx' or `u=rw,g=r,o=r').
[Default: None]
- others
All arguments accepted by the [file] module also work here.
[Default: (null)]
- owner
name of the user that should own the file/directory, as would be fed to `chown'
[Default: None]
- regexp
The regular expression to look for in every line of the file. For `state=present', the pattern to replace if found;
only the last line found will be replaced. For `state=absent', the pattern of the line to remove. Uses Python regular expressions; see http://docs.python.org/2/library/re.html.
[Default: (null)]
- selevel
level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the `range'. `_default'
feature works as for `seuser'.
[Default: s0]
- serole
role part of SELinux file context, `_default' feature works as for `seuser'.
[Default: None]
- setype
type part of SELinux file context, `_default' feature works as for `seuser'.
[Default: None]
- seuser
user part of SELinux file context. Will default to system policy, if applicable. If set to `_default', it will use the `user' portion of the policy if available
[Default: None]
- state
Whether the line should be there or not.
(Choices: present, absent)[Default: present]
- unsafe_writes
Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.
This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.
[Default: False]
- validate
The validation command to run before copying into place. The path to the file to validate is passed in via '%s' which must be present as in the example below. The command is passed securely so shell features like expansion and pipes won't work. |