BACKUP_LISTVOLSETS(8)

📦
version 1.8.16.1 · 10 versions
, in ubuntu stonking

✨ NAME ✨

okay bestie, welcome to backup_listvolsets 💖 — it's from the AFS Command Reference (volume 8 of the manual, the admin-y one), and what it does is literally list the volume set entries chillin' in the Backup Database. that's it. that's the whole job. iconic.

🎀 SYNOPSIS 🎀

backup listvolsets [-name <volume set name>] [-localauth]
    [-cell <cell name>] [-help]

backup listv [-n <volume set name>] [-l]
    [-c <cell name>] [-h]

yes she has a short nickname (listv) and yes every flag has a glow-down version. we love a flexible queen. 💅

🌸 DESCRIPTION 🌸

so backup listvolsets pulls up the Backup Database records for one of exactly two things, depending on what you ask her for:

  • all the volume sets plus all their volume entries — this is what you get when you just... don't pass -name at all. be mysterious, get everything. ✨
  • only the volume set you named with -name, and its volume entries riding along with it. 🦋

that's the vibe check. two modes. no cap.

💜 OPTIONS 💜

  • -name <volume set name> — says which volume set you wanna see. skip it and she'll list every single volume set defined in the Backup Database, no filter, all gas no brakes. 🌈
  • -localauth — builds a server ticket using a key from the local /etc/openafs/server/KeyFile file. the backup command interpreter then presents that ticket to the Backup Server, Volume Server and VL Server during mutual authentication. 🫶 DO NOT combine this flag with -cell, fr fr. more deets live in backup(8).
  • -cell <cell name> — names the cell where the command should run. DO NOT combine this with -localauth, bestie, they do not get along. more deets in backup(8).
  • -help — prints the online help for this command. every other valid option? ignored. she said "i'm busy being helpful, everything else can wait." 😭

👑 OUTPUT 👑

each volume set's entry kicks off with a "Volume set" header followed by that volume set's name. and listen — if it's a temporary volume set, its name gets the string " (temporary)" tacked on after it, so you always know who's just passing through. ⭐

then every volume entry shows up on its own separate line, showing off the entry's index number plus the server, partition and volume names it matches.

the output uses the metacharacter notation described over on the backup addvolentry reference page — go peek at that if the wildcards are giving you thoughts. 💭

and here's the pro tip: use that index number to identify volume entries later when you're deleting them with backup delvolentry. save the receipt, babe. 🧾

🔥 EXAMPLES 🔥

this one shows the volume entries inside the three volume sets currently defined in the Backup Database:

% backup listvolsets
Volume set user:
    Entry   1: server .*, partition .*, volumes: user.*\.backup
Volume set sun
    Entry   1: server .*, partition .*, volumes: sun4x_55\..*
    Entry   2: server .*, partition .*, volumes: sun4x_56\..*
Volume set rs
    Entry   1: server .*, partition .*, volumes: rs_aix42\..*

look at her go. three sets, four entries, zero notes, periodt. 💖

🌟 PRIVILEGE REQUIRED 🌟

whoever's running this needs to be listed in the /etc/openafs/server/UserList file on every machine where the Backup Server is running — every single one, don't skip. 🚨

OR, alternative route: be logged onto a server machine as the local superuser "root" and include the -localauth flag. that combo gets you in the door. 🔑

lowkey important: those are the rules, there's no third secret entrance. 🙈

🦋 SEE ALSO 🦋

go read the whole friend group, they all make more sense together. 💫

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.

and that's the whole thing bestie — courtesy of OpenAFS, dated 2026-07-27, living at BACKUP_LISTVOLSETS(8). go forth and list those volume sets, you absolute main character. 🎀✨💖

📦 where this page comes from