Ansible Lineinfile modules.

Double-click on the image to zoom-out ...Larger.

To return to Home page: Refresh Page or Take ESC Button on Keyboard

what is the use of lineinfile modules with respect to ansible:

The lineinfile module in Ansible is used to ensure a specific line is present or absent in a file. This module is primarily used for editing text files in a declarative way, without needing to manually edit the file. It helps automate configurations by managing lines within a file, which is useful when you need to add, modify, or remove lines from configuration files or scripts.

Key Features of lineinfile:

• Ensure Line Presence: It can ensure a specific line is present in the file.
• Ensure Line Absence: It can also remove a line from a file.
• Line Modification: You can modify existing lines based on a regular expression pattern.
• Atomic Operations: Only the targeted line is modified, ensuring minimal disruption to the rest of the file.

Common Use Cases:

1. Adding a Line to a File: If you want to ensure that a specific line exists (e.g., a configuration setting), you can use lineinfile to add that line if it is missing.

   Example:

   # yaml
   
   - name: Add a line to a file
     ansible.builtin.lineinfile:
       path: /etc/twtech.conf
       line: "enable_feature=true"
   

2. Ensuring Line with a Specific Pattern: If you need to ensure a line is modified to a specific value, you can use regexp to match a line and change it.

   Example:

   # yaml
   
   - name: Ensure a line is modified in a config file
     ansible.builtin.lineinfile:
       path: /etc/twtech.conf
       regexp: '^enable_feature'
       line: "enable_feature=false"
   

3. Removing a Line from a File: If you need to ensure a line is removed (for example, to disable a setting), you can use state: absent.

   Example:

   # yaml
   
   - name: Remove a line from a file
     ansible.builtin.lineinfile:
       path: /etc/twtech.conf
       state: absent
       line: "disable_feature=true"
   

4. Backup the File Before Modifying: You can create a backup of the file before making changes using backup: yes.

   Example:

   # yaml
   
   - name: Add a line with backup
     ansible.builtin.lineinfile:
       path: /etc/twtech.conf
       line: "enable_feature=true"
       backup: yes
   

5. Ensure a Line is Not Duplicated: lineinfile ensures that the line is only added once. If it already exists, it will not be added again, preventing duplicates.

   Example:

   # yaml
   
   - name: Ensure a line is unique
     ansible.builtin.lineinfile:
       path: /etc/twtech.conf
       line: "max_connections=100"
   

Parameters:

• path: Specifies the file to modify.
• line: Defines the exact line to add or modify.
• regexp: Used to match lines using a regular expression for modification.
• state: Specifies whether the line should be present (present) or absent (absent).
• backup: Option to create a backup file before modifying the target file.
• create: Whether to create the file if it does not exist (default: no).

Example Playbook:

# yaml

- name: Manage configuration file
  hosts: all
  tasks:
    - name: Ensure "enable_feature=true" is present in /etc/twtech.conf
      ansible.builtin.lineinfile:
        path: /etc/twtech.conf
        line: "enable_feature=true"
        create: yes

    - name: Update max_connections to 200 in /etc/twtech.conf
      ansible.builtin.lineinfile:
        path: /etc/twtech.conf
        regexp: '^max_connections'
        line: "max_connections=200"

    - name: Remove "disable_feature" line from /etc/twtech.conf
      ansible.builtin.lineinfile:
        path: /etc/twtech.conf
        state: absent
        line: "disable_feature=true"

twtech-Insights:

The lineinfile module is extremely useful when you need to manage individual lines in a file, such as ensuring configuration settings are correct, removing unwanted lines, or updating values in a file. It is especially helpful for managing system configuration files or other text-based files where direct editing is not feasible or would be too error-prone.