Ansible Module lineinfile: Difference between revisions

From NovaOrdis Knowledge Base
Jump to navigation Jump to search
Line 13: Line 13:
==<span id='line'></span><tt>line</tt> (<tt>value</tt>)==
==<span id='line'></span><tt>line</tt> (<tt>value</tt>)==
The line to be inserted.
The line to be inserted.
==create==
Used with <code>[[#state|state]]=present</code>. If "yes" os specified, the file will be created if it does not already exist. By default, the value is "no", so the module  will fail if the file is missing.
==<tt>insertafter</tt>==
==<tt>insertafter</tt>==
Used with <code>[[#state|state]]=present</code>. The specified line will be inserted after the last match of the regular expression presented as value of <tt>insertafter</tt>, or, if the regular expression is not provided, after EOF.
Used with <code>[[#state|state]]=present</code>. The specified line will be inserted after the last match of the regular expression presented as value of <tt>insertafter</tt>, or, if the regular expression is not provided, after EOF.

Revision as of 04:35, 5 July 2021

External

Internal

Overview

The module is mainly used to look for or change a single line in a text file. A typical use case is to ensure that a particular line is in a file, based on a regular expression. Another case is to replace an existing line using a back-referenced regular expression.

Module Parameters

state

line (value)

The line to be inserted.

create

Used with state=present. If "yes" os specified, the file will be created if it does not already exist. By default, the value is "no", so the module will fail if the file is missing.

insertafter

Used with state=present. The specified line will be inserted after the last match of the regular expression presented as value of insertafter, or, if the regular expression is not provided, after EOF.

TODO.

Example

- name: "Adjust Java version to {{ jdk.version }}"
  lineinfile:
    path: "{{ settings_path }}/settings.conf"
    regexp: '^JAVA_VERSION='
    line: "JAVA_VERSION={{ jdk.version }}"

Use Cases

Append a Line to a Text File

Append Lines to a Text File in a Loop