Using Quiescing Scripts with Linux Agents

This article covers the purpose of quiescing scripts and how to configure them for use with local BCDR devices on protected machines using the Datto Linux Agent.

Environment

  • Datto ALTO
  • Datto SIRIS

Description

Quiescing scripts allow processes on a protected Linux system, including databases and other applications, to be paused or modified during a backup to ensure application-consistent snapshots that include pending transactions. Datto provides three default scripts that you can configure to work with MongoDB, MySQL or PostgreSQL. You can also create custom quiescing scripts.

The Datto Linux Agent stores its script files in /etc/datto/dla/pps on the protected server.

Procedure

To activate the quiescing scripts:

  1. Open the GUI for the Datto device.

  2. Click the Protect tab.

  3. Navigate to the agent that you wish to configure.

  4. Click Configure Agent Settings for that agent.

  5. Scroll to the Advanced section to find the Quiescing Scripts option.

  6. Check the boxes next to the scripts you want to activate.

  1. Edit the MongoDB script.

    nano /etc/datto/dla/pps/mongodb.sh

  2. Replace all instances of the name admin with the name of your database.

  3. After updating the file, press Ctrl + O to save the changes.

  4. Press Ctrl + X to exit the editor.

  1. Edit the MySQL script.

    nano /etc/datto/dla/pps/mysql.sh

  2. Enter the username and password of your SQL database in the u= and P= fields.

  3. After updating the file, press Ctrl + O to save the changes.

  4. Press Ctrl + X to exit the editor.

  1. Edit the PostgeSQL script.

    nano /etc/datto/dla/pps/postgres.sh

  2. Add the --dbname=DBNAME modifier to the postgres commands.

  3. To change databases, replace DBNAME with the name of your database.

  4. After updating the file, press Ctrl + O to save the changes.

  5. Press Ctrl + X to exit the editor.

You can use any of these templates to create custom quiescing scripts. Your scripts must be stored in:

/etc/datto/dla/pps/

The script needs to be able to operate on these options:

elif [ $1 = "PRE" ]; then
elif [ $1 = "POST" ]; then

In addition, use chmod to make your script executable:

chmod +x /etc/datto/dla/pps/[example script].sh

Make sure the script has the same permissions as the other scripts in the directory (Access: (0755/-rwxr-xr-x)). In the Datto appliance GUI, navigate to the Quiescing Scripts section of the protected agent's Configure Agent Settings. Click Refresh Scripts, and the new script will show up as an option in the list.

Additional Resources