ANSIBLE.LINEINFILE(3)           ANSIBLE MODULES          ANSIBLE.LINEINFILE(3)



NAME
       lineinfile - Ensure a particular line is in a file, or replace an
       existing line using a back-referenced regular expression.

DESCRIPTION
       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. For other cases, see the copy or template modules.

OPTIONS
       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)(Added in Ansible version 1.1.)


       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.(required)

       insertafter
              Used with state=present. If specified, the line will be inserted
              after the specified regular expression. A special value is
              available; EOF for inserting the line at the end of the file.
              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 specified regular expression. A value is available;
              BOF for inserting the line at the beginning of the file. May not
              be used with backrefs.  Choices: BOF,*regex*.(Added in Ansible
              version 1.1.)


       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. The backreferences should be double escaped (see
              examples).

       others All arguments accepted by the file module also work here.

       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.

       state  Whether the line should be there or not.  Choices:
              present,absent. (default: present)

       validate
              validation to run before copying into place (default:
              None)(Added in Ansible version 1.4.)

EXAMPLES
       - lineinfile: dest=/etc/selinux/config regexp=^SELINUX= line=SELINUX=disabled

       - lineinfile: dest=/etc/sudoers state=absent regexp="^%wheel"

       - lineinfile: dest=/etc/hosts regexp='^127.0.0.1' line='127.0.0.1 localhost' owner=root group=root mode=0644

       - lineinfile: dest=/etc/httpd/conf/httpd.conf regexp="^Listen " insertafter="^#Listen " line="Listen 8080"

       - lineinfile: dest=/etc/services regexp="^# port for http" insertbefore="^www.*80/tcp" line="# port for http by default"

       # Add a line to a file if it does not exist, without passing regexp
       - lineinfile: dest=/tmp/testfile line="192.168.1.99 foo.lab.net foo"

       # Fully quoted because of the ': ' on the line. See the Gotchas in the YAML docs.
       - lineinfile: "dest=/etc/sudoers state=present regexp='^%wheel' line='%wheel ALL=(ALL) NOPASSWD: ALL'"

       - lineinfile: dest=/opt/jboss-as/bin/standalone.conf regexp='^(.*)Xms(+)m(.*)$' line='1Xms${xms}m3' backrefs=yes

       # Validate a the sudoers file before saving
       - lineinfile: dest=/etc/sudoers state=present regexp='^%ADMIN ALL=' line='%ADMIN ALL=(ALL) NOPASSWD:ALL' validate='visudo -cf %s'



AUTHOR
       Daniel Hokka Zakrisson

SEE ALSO
       ansible(1), http://ansible.github.com/modules.html#lineinfile



1.4.5                             2014-02-12             ANSIBLE.LINEINFILE(3)
