How do I use quiescing scripts with Linux agents on a Datto appliance?
- Datto ALTO
- Datto SIRIS
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.
To activate the quiescing scripts:
- Open up the GUI for the Datto device.
- Click the Protect tab.
- Find the agent that you wish to configure.
- Click Configure Agent Settings for that agent.
- Scroll to the Advanced section to find the Quiescing Scripts option, as shown in Figure 1.
- Check the boxes next to the scripts you want to activate.
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. After updating the file, save the changes, and exit the editor.
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.
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.
Custom Quiescing Scripts
You can use any of these scripts as a template to write your own quiescing scripts. You must store scripts in /etc/datto/dla/pps/, and they must start with the following header:
## DISPLAYNAME: [yourdisplayName]
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.
Pause or resume a database mirroring session (external link)