BACKUP_RESTOREDB(8)

📦
version 1.8.16.1 · 10 versions
, in ubuntu stonking

💾 backup_restoredb(8) — the AFS command reference glow-up 💾

okay bestie, so this is the manual page for backup_restoredb from the OpenAFS command reference, and it's literally the "undo my oopsie" button for your Backup Database. let's get into it 🫶

✨ NAME ✨

backup_restoredb — Restores a saved copy of the Backup Database

like… it puts the Backup Database back. from a tape. the whole vibe. 💅

🎀 SYNOPSIS 🎀

backup restoredb [-portoffset <TC port offset>]
    [-localauth] [-cell <cell name>] [-help]

backup res [-p <TC port offset>]
    [-l] [-c <cell name>] [-h]

ngl the short version is giving "i'm in a hurry" energy and honestly? valid. ✨

🌸 DESCRIPTION 🌸

so the backup restoredb command restores to the Backup Server machine's local disk a version of the Backup Database that was previously written to tape by using the backup savedb command. it's giving time travel but make it AFS 🦋

(and like, tiny plot twist: if the "FILE YES" instruction appears in the /var/lib/openafs/backup/CFG_device_name file associated with the specified port offset, then backup restoredb restores data from the backup data file listed for that port offset in the Tape Coordinator's /var/lib/openafs/backup/tapeconfig file, instead of from tape. for the sake of clarity, the text below talks about tapes only, but bestie, the Backup System handles backup data files in much the same way. no cap.)

the most common reason to run this command is to replace a corrupted or otherwise damaged Backup Database — and you should use the backup dbverify command to determine the database's status first, bestie, do not skip that step 😭. the command can also be used to restore records that were removed from the database when the -archive argument was included on a previous backup savedb command.

now the important tea ☕ — this command completely overwrites the existing Backup Database records for volume sets, Tape Coordinators, and the dump hierarchy with the corresponding information from the saved version. iconic, but also, be careful. it does not overwrite existing dump records though — instead it interleaves the records from the copy being restored. and if both the existing database (on the Backup Server machine's disk) and the copy being restored include a record about the same dump, the Backup System retains the one in the existing database. existing database wins, periodt. 👑

the Tape Coordinator's default response to this command is to access the first tape it needs by invoking the "MOUNT" instruction in the local /var/lib/openafs/backup/CFG_device_name file, or by prompting the backup operator to insert the tape if there is no "MOUNT" instruction. however — and this is the part where it gets quirky 🙈 — if the "AUTOQUERY NO" instruction appears in the CFG_device_name file, or if the issuer of the butc command included the -noautoquery flag, the Tape Coordinator instead expects the tape to be in the device already. if it's not, or it's the wrong tape, the Tape Coordinator invokes the "MOUNT" instruction or prompts the operator. it also invokes the "MOUNT" instruction or prompts for any additional tapes needed to complete the restore operation; the backup operator must arrange to provide them. so like, stay by the tape drive, it's giving on-call energy 💀

🚨 CAUTIONS 🚨

if the database is corrupted, do not attempt to restore a saved database on top of it. i'm so serious. instead, use the instructions for repairing a corrupted database in the OpenAFS Administration Guide chapter about performing backup operations. that's the move. 🙏

💅 OPTIONS 💅

  • -portoffset <TC port offset> — Specifies the port offset number of the Tape Coordinator handling the tapes for this operation. like, which TC is running this errand. 🎀
  • -localauth — Constructs a server ticket using a key from the local /etc/openafs/server/KeyFile file. The backup command interpreter presents it to the Backup Server, Volume Server and VL Server during mutual authentication. Do not combine this flag with the -cell argument. For more details, see backup(8). (mutual authentication is giving "we both need to trust each other" and honestly, healthy. 🫶)
  • -cell <cell name> — Names the cell in which to run the command. Do not combine this argument with the -localauth flag. For more details, see backup(8).
  • -help — Prints the online help for this command. All other valid options are ignored. so like, don't bother stacking flags with this one, it's not listening. 💀

🌈 EXAMPLES 🌈

the following example shows the Backup Database being restored from the Tape Coordinator with port offset 0:

% backup restoredb

look at her. no flags. just vibes. she ate and left no crumbs. ✨

👑 PRIVILEGE REQUIRED 👑

the issuer must be listed in the /etc/openafs/server/UserList file on every machine where the Backup Server is running, or must be logged onto a server machine as the local superuser "root" if the -localauth flag is included. so either you're on the list, or you're literally root. those are the options, bestie. 💜

🔥 SEE ALSO 🔥

and the OpenAFS Administration Guide at <http://docs.openafs.org/AdminGuide/> — go read it, iykyk 📚

IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

This documentation is covered by the IBM Public License Version 1.0. It was converted from HTML to POD by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.

okay and that's the whole page, bestie!! 🌟 this was the OpenAFS manual page, dated 2026-07-27, and the whole thing shipped as part of OpenAFS. go forth and restore responsibly, mwah 💖💅✨

📦 where this page comes from