Agent Configuration - Working with Quiescing Scripts

Follow

Scope

This article explains the Quiescing Scripts feature for Linux agents on a Datto appliance.

Overview

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 up the GUI for the Datto device.
  2. Click on the Protect tab.
  3. Find 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, as shown in Figure 1.
  6. Check the boxes next to the scripts you want to activate.

scripts.pngFigure 1: Quiescing scripts pane

 

Configuring MongoDB

To configure MongoDB, nano /etc/datto/dla/pps/mongodb.sh, and replace all instances of the name admin with the name of your database, as shown in Figure 2. When you are done updating the file, save the changes, and exit the editor.

mongodb.pngFigure 2: mongodb.sh

Configuring MySQL

To configure MySQL, nano /etc/datto/dla/pps/mysql.sh, and enter the username and password of your SQL database in the u= and P= fields, as shown in Figure 3.

mysql-usernamePassword.png
Figure 3: mysql.sh

Configuring PostgreSQL

To configure PostgreSQL, no changes need to be made for the default database. You can optionally nano /etc/datto/dla/pps/postgres.sh and add the --dbname=DBNAME modifier to the postgres commands highlighted in Figure 4 to change databases. Replace DBNAME with the name of your database.

postgres.pngFigure 4: postgres.sh

Custom Quiescing Scripts

You can use any of these scripts as a template to write your own quiescing scripts. The scripts must be stored in /etc/datto/dla/pps/, and they must start with the following header: 

## DISPLAYNAME: [yourdisplayName]

Replace [yourdisplayName] with the name you will use to identify the script in the Datto appliance GUI.

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

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

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.


 


Was this article helpful?

0 out of 0 found this helpful

You must sign in before voting on this article.

Want to talk about it? Head on over to our Community Forum!