.. _ug_variables_files_blockinfile:

blockinfile
^^^^^^^^^^^

.. contents::
   :local:

Create or configure blocks in files.

Parameters
""""""""""
+---------------------+-----------------------+-----------------------------+
| Parameter           | Type                  | Comments                    |
+=====================+=======================+=============================+
| path                | string ``required``   | Path to file.               |
+---------------------+-----------------------+-----------------------------+
| blocks              | list ``required``     | List of dictionaries        |
|                     |                       | (see files-blockinfile.yml) |
+--+------------------+-----------------------+-----------------------------+
|  | marker           | string ``required``   | Label of the marker.        |
|  +------------------+-----------------------+-----------------------------+
|  | block            | string ``required``   | Text between markers.       |
|  +------------------+-----------------------+-----------------------------+
|  | ...              | ...                   | <TBD>                       |
+--+------------------+-----------------------+-----------------------------+
| owner               | string                | Owner of the file.          |
+---------------------+-----------------------+-----------------------------+
| group               | string                | Group of the file.          |
+---------------------+-----------------------+-----------------------------+
| mode                | string                | Mode of the file.           |
+---------------------+-----------------------+-----------------------------+
| create              | boolean               | Create if does not exist.   |
+---------------------+-----------------------+-----------------------------+
| validate            | string                | Command to validate file.   |
+---------------------+-----------------------+-----------------------------+
| handlers            | list                  | List of handlers.           |
+---------------------+-----------------------+-----------------------------+

Example
"""""""

Create the description of the file (2) and declare the list of the blocks (10)

[`contrib/lighttpd_nagios/conf-light/files.d/lighttpd-modulesconf.yml <https://github.com/vbotka/ansible-config-light/blob/master/contrib/lighttpd_nagios/conf-light/files.d/lighttpd-modulesconf.yml>`_]

.. literalinclude:: ../../contrib/lighttpd_nagios/conf-light/files.d/lighttpd-modulesconf.yml
    :language: yaml
    :linenos:
    :emphasize-lines: 2,10

Create the list of the blocks ``cl_lighttpd_modulesconf_blocks`` (89)

[`contrib/lighttpd_nagios/cl-lighttpd.yml <https://github.com/vbotka/ansible-config-light/blob/master/contrib/lighttpd_nagios/cl-lighttpd.yml>`_]

.. literalinclude:: ../../contrib/lighttpd_nagios/cl-lighttpd.yml
    :language: yaml
    :linenos:
    :lines: 84-97
    :lineno-start: 84
    :emphasize-lines: 1,6

Then, the command ::

  shell> ansible-playbook config-light.yml -t cl_files_blockinfile

creates this block in ``modules.conf`` ::

  ##

  # BEGIN ANSIBLE MANAGED BLOCK server.modules
  server.modules = (
    "mod_access",
    "mod_alias",
    "mod_auth",
    "mod_setenv",
  )
  # END ANSIBLE MANAGED BLOCK server.modules

  ##

.. seealso::

   * See :ref:`as_files-blockinfile.yml` annotated source code