AMANDA-SCRIPTS(7)

💅 AMANDA-SCRIPTS(7) — Miscellanea ✨

🌸 NAME 🌸

amanda-scripts — configuring and using the Script API, bestie. No cap. 💖

---

✨ DESCRIPTION ✨

Okay so the Script API is literally this flexible system for invoking user-supplied scripts at various points in the execution of Amanda. This manual page describes how the API operates and how to configure it. Wanna write Script API scripts? The help is at http://wiki.zmanda.com/index.php/Script_API — go off. 🦋

---

🦋 SCRIPTS 🦋

This section lists the scripts included with Amanda. For instructions on using each one, peep its individual man page. For complete How-To information, consult the Amanda wiki at http://wiki.zmanda.com. 💖

• amzfs-snapshot(8) — create/destroy zfs snapshot. 🧚
• script-email(8) — send email. 💌

Script properties work just like application properties: they are insensitive to case, and - (dash) and _ (underscore) may be used interchangeably. Mix and match, it's fine. ✨

---

💖 SCRIPTS OUTPUT PROPERTY 💖

A pre-dle-amcheck, pre-dle-estimate or pre-dle-backup executed on the client can output property on stdout that are sent to the application. If the output line matches PROPERTY str1 str2, Amanda sets a property called str1 by the value of str2, and that property is sent to the application. It's giving very direct communication. 💬

---

💀 SCRIPTS FAILURE (TO ABORT A BACKUP) 💀

A pre-host-estimate, pre-dle-estimate or pre-dle-backup executed on the client can abort a backup by writing an error message (single line) to STDERR and exit with != 0. So if you want to slam the brakes, that's the move. 🛑

A post-dle-backup executed on the client can make a backup a failure by writing an error message (single line) to STDERR and exit with != 0. Basically: single-line error tea to STDERR plus a non-zero exit = the backup is marked as a failure. 💀

Lowkey important: this is the documented way to make a backup abort or fail, so don't be shy with that STDERR line, bestie.

---

🌈 SEE ALSO 🌈

• amanda(8)
• amanda.conf(5)

The Amanda Wiki: : http://wiki.zmanda.com/

---

👑 AUTHORS 👑

• Jean-Louis Martineau <martineau@zmanda.com> — Zmanda, Inc. (http://www.zmanda.com) 💖
• Dustin J. Mitchell <dustin@zmanda.com> — Zmanda, Inc. (http://www.zmanda.com) 🫶

---

Amanda 3.5.4 · 07/23/2025 — okay bye bestie, go configure your scripts, ily 💋✨