ipa-backup(1)

💾 ipa-backup — the glow-up for your IPA master

okay bestie, welcome to ipa-backup(1) from the IPA Manual Pages — yes, that IPA, the identity one, not the beer 🍺 (tho honestly both deserve a backup). This lil tool backs up an IPA master so you don't have a main-character meltdown later. Let's get into it 💅

---

✨ SYNOPSIS ✨

ipa-backup [OPTION]...

that's it. that's the whole vibe. options only, no positional args, we're not doing all that 🎀

---

🦋 DESCRIPTION 🦋

so there are two kinds of backups: full and data-only. pick your fighter.

the backup is optionally encrypted using either the default root GPG key or a named key. and listen — no passphrase is supported. none. zero. not a thing. don't @ me 🙈

backups get stored in a subdirectory inside /var/lib/ipa/backup. cute, organized, we love a system.

the naming convention for full backups is:

ipa-full-YEAR-MM-DD-HH-MM-SS

and it's in the GMT time zone. iconic consistency ✨

the naming convention for data backups is:

ipa-data-YEAR-MM-DD-HH-MM-SS

also in the GMT time zone. no cap.

inside that subdirectory there's a file, header, that describes the backup — it tells you the type, the system, the date of backup, the version of IPA, the version of the backup, and the services on the master. it's basically the backup's little ID card 🪪💖

⚠️ okay important, bestie: a backup can not be restored on another host. and a backup can not be restored in a different version of IPA.

those two are hard nos. periodt. 💀

---

🌸 OPTIONS 🌸

• --data — back up data only. the default is to back up all IPA files plus data, so this is you choosing the lighter path 🍓
• --gpg — encrypt the backup file. set the GNUPGHOME environment variable if you wanna use a custom keyring and gpg2 configuration 🔐
• --logs — include the IPA service log files in the backup. receipts, preserved 📜
• --online — perform the backup on-line. requires the --data option (they're a package deal, iykyk) 🌐
• --disable-role-check — perform the backup even if this host does not have all the roles in use in the cluster. this is not recommended 🙈 proceed with caution, babe
• -v, --verbose — print debugging information. loud and proud 🗣️
• -d, --debug — alias for --verbose. same energy, different letter ✨
• -q, --quiet — output only errors. silent but deadly accurate 🤫
• --log-file=FILE — log to the given file. write it down, keep the receipts 📝

---

💀 EXIT STATUS 💀

• 0 — if the command was successful 🎉 slay
• 1 — if an error occurred 😭
• 2 — if IPA is not configured 🫠

---

🧚 ENVIRONMENT VARIABLES 🧚

• GNUPGHOME — use custom GnuPG keyring and settings (default: ~/.gnupg). it's giving "home but make it keys" 🏠🔑

---

🎀 FILES 🎀

• /var/lib/ipa/backup
  • the default directory for storing backup files 💾
• /var/log/ipabackup.log
  • the log file for backups 📋

---

🌈 SEE ALSO 🌈

• ipa-restore(1) — the part where you actually get it back, bestie 🔄
• gpg2(1) — the encryption bestie 💖

---

and that's the whole page, babe — go forth and back up responsibly ✨ this lil manual is brought to you by IPA and dated Mar 22 2013, so it's lowkey vintage but highkey still valid. take care of your master, drink water, and always keep a header file around 🫶💜