VOS_LISTVOL(1)

📦
version 1.8.16.1 · 10 versions
, in ubuntu stonking

💖 VOS_LISTVOL 💖 — or, as your girlies call it, vos listvol

AFS Command Reference ✨ part of the vos squad, and honestly? she's the one who tells you everything about your volumes' lil heads. 🧠💅

🌸 NAME 🌸

vos_listvol — bestie, she literally just displays information from a volume header. that's her whole job and she does it flawlessly. 👑

✨ SYNOPSIS ✨

okay so there are TWO ways to spell her name and both are valid, no cap:

vos listvol -server <machine name>
    [-partition <partition name>]
    [-fast] [-long] [-quiet]
    [-extended] [-format]
    [-cell <cell name>] [-noauth] [-localauth]
    [-verbose] [-encrypt] [-noresolve]
    [-config <config directory>]
    [-help]

and the short girlie version (same energy, fewer letters):

vos listvo -s <machine name>
    [-p <partition name>]
    [-fa] [-lon] [-q] [-ex] [-fo]
    [-c <cell name>]
    [-noa] [-loc] [-v] [-en] [-nor]
    [-co <config directory>]
    [-h]

🦋 DESCRIPTION 🦋

so like, vos listvol formats and displays the following info from the volume header of every volume you point at: volume name, volume ID, volume type, size, and status at the server. ✨ that's the ✨ lineup ✨.

BUT — and this is the tea ☕ — the actual info you get depends on which combo of arguments you bring to the function. she's adaptable like that, main character energy. 💅 to display volume header info for various numbers of volumes, you combine the arguments like this:

  • 🎀 for every volume on a file server machine: hand her the machine's name with the -server argument.
  • 🎀 for every volume at one particular site: pair the -server argument with the -partition argument. teamwork makes the dream work, fr fr.
💡 pro tip from me to you: to display the Volume Location Database (VLDB) entry for one or more volumes, use the vos listvldb command. and if you want both the VLDB entry and the volume header for a single volume? that's vos examine's moment. different girlies, different jobs. 🫶

💅 OPTIONS 💅

strap in bestie, there are a LOT of them and they're all iconic in their own way:

  • -server <server name> — identifies the file server machine that houses the volumes you want headers for. give her the machine's IP address or its host name (either fully qualified or using an unambiguous abbreviation). for deets, see vos(1). this argument can be combined with the -partition argument, and with the -fast, -long, or -extended flag. she's flexible like that. 😌
  • -partition <partition name> — identifies the partition (on the file server machine that -server named) that houses the volumes you want headers for. give her the partition's complete name with the preceding slash (for example, /vicepa) or use one of the three acceptable abbreviated forms. for deets, see vos(1).
  • -fast — displays only the volume ID numbers of volumes stored at the site specified by the -server argument, and optionally the -partition argument. ⚡
⚠️ do NOT combine this flag with the -extended flag. pick a lane, bestie.
  • -long — displays more detailed info about each volume stored at the site specified by the -server argument, and optionally -partition. the info includes the volume IDs of all three volume types associated with the volume, plus the read/write volume's quota, creation date and update date. the full ✨ lore ✨.
  • -quiet — suppresses the lines that summarize the number of volumes listed and their status. those lines otherwise show up at the beginning and end of the output when the output includes more than one volume. shhh. 🤫
  • -extended — displays extensive statistics about access patterns for each volume stored at the site specified by the -server argument, and optionally -partition. the stats include the number of reads and writes to files in the volume, and how recently files and directories have been updated by their owners or other users. 📊
⚠️ do NOT combine this flag with the -fast flag. i'm serious. 🙈
  • -format — show information in a format suitable for machine parsing. robots deserve gorgeous data too. 🤖💖
  • -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 vos(1). lowkey important!!
  • -noauth — assigns the unprivileged identity "anonymous" to the issuer. do not combine this flag with the -localauth flag. for more details, see vos(1).
  • -localauth — constructs a server ticket using a key from the local /etc/openafs/server/KeyFile file. the vos command interpreter presents it to the Volume Server and Volume Location Server during mutual authentication. do not combine this flag with the -cell argument or the -noauth flag. for more details, see vos(1).
  • -verbose — produces on the standard output stream a detailed trace of the command's execution. if this argument is omitted, only warnings and error messages appear. she goes full detective mode. 🔍
  • -encrypt — encrypts the command so that the operation's results are not transmitted across the network in clear text. 🔐 this option is available in OpenAFS versions 1.4.11 or later and 1.5.60 or later.
  • -noresolve — shows all servers as IP addresses instead of the DNS name. this is very useful when the server address is registered as 127.0.0.1 or when dealing with multi-homed servers. 🌐 this option is available in OpenAFS versions 1.4.8 or later and 1.5.35 or later.
  • -config <configuration directory> — set the location of the configuration directory to be used. this defaults to /etc/openafs, except if -localauth is specified, in which case the default is /etc/openafs/server. this option allows the use of alternative configuration locations for testing purposes. 🧪
  • -help — prints the online help for this command. all other valid options are ignored. she said "i'm helping, nothing else matters." 💁‍♀️

👑 OUTPUT 👑

the output is ordered alphabetically by volume name, and by default it gives you the following info on a single line for each volume:

  • 🎀 Name
  • 🎀 Volume ID number
  • 🎀 Type (the flag is "RW" for read/write, "RO" for read-only, "BK" for backup)
  • 🎀 Size in kilobytes (1024 equals a megabyte)
  • 🎀 Number of files in the volume, if the -extended flag is provided
  • 🎀 Status on the file server machine, which is one of the following:
    • On-line — the volume is completely accessible to Cache Managers. 🟢 living her best life.
    • Off-line — the volume is not accessible to Cache Managers, but does not seem to be corrupted. this status appears while a volume is being dumped, for example. 🟡
    • Off-line**needs salvage** — the volume is not accessible to Cache Managers, because it seems to be corrupted. use the bos salvage or salvager command to repair the corruption. 🚨 call the doctor!!

if the following message appears instead of the info listed above, it means a volume is not accessible to Cache Managers or the vos command interpreter, for example because a clone is being created:

**** Volume <volume_ID> is busy ****

if this message appears instead of the info listed above, it means the File Server is unable to attach the volume, perhaps because it is seriously corrupted: 😭

**** Could not attach volume <volume_ID> ****

the FileLog and VolserLog log files in the /var/log/openafs directory on the file server machine possibly provide additional information; use the bos getlog command to display them. 🔍

the info about individual volumes is bracketed by summary lines. the first line of output specifies the number of volumes in the listing. the last line of output summarizes the number of volumes that are online, offline, and busy. these lines do not appear if the -quiet flag is used. 💅

⚡ if you add -fast ⚡

the output displays only the volume ID number of each volume, arranged in increasing numerical order. 🔢 the final line (the one that summarizes the number of online, offline, and busy volumes) is omitted. bye bestie. 👋

🌈 if you include -long 🌈

the output for each volume includes all the info in the default listing plus the following. each item in this list corresponds to a separate line of output:

  • 🎀 the file server machine and partition that house the volume, as determined by the command interpreter as the command runs, rather than derived from the VLDB or the volume header. (she's live-reporting, not reading off a card. 💅)
  • 🎀 the volume ID numbers associated with the various versions of the volume: read/write ("RWrite"), read-only ("ROnly"), backup ("Backup"), and ReleaseClone ("RClone"). one of them matches the volume ID number that appears on the first line of the volume's output. if the value in the "RWrite", "ROnly", or "Backup" field is 0 (zero), there is no volume of that type. if there is currently no ReleaseClone, the "RClone" field does not appear at all. 🙈
  • 🎀 the maximum space quota allotted to the read/write copy of the volume, expressed in kilobyte blocks in the "MaxQuota" field.
  • 🎀 the date and time the volume was created, in the "Creation" field. if the volume has been restored with the backup diskrestore, backup volrestore, or vos restore command, this is the restore time. ⏰
  • 🎀 the date and time when the contents of the volume last changed, in the "Last Update" field. for read-only and backup volumes, it matches the timestamp in the "Creation" field.
  • 🎀 the number of times the volume has been accessed for a fetch or store operation since the later of the two following times:
    • the time 12:00 a.m. on the day the command is issued
    • the last time the volume changed location

📊 if you include -extended 📊

the output for each volume includes all the info reported with the -long flag, plus two tables of statistics:

  • 🎀 the table labeled "Raw Read/Write Stats" summarizes the number of times the volume has been accessed for reading or writing.
  • 🎀 the table labeled "Writes Affecting Authorship" contains information on writes made to files and directories in the specified volume.

✨ EXAMPLES ✨

okay bestie, storytime 📖 — here's what it actually looks like when you run this thing.

So say we're peeking at the /vicepb partition on the file server machine "fs2.example.com", and we pass no flags at all. Here's the whole vibe:

% vos listvol -server fs2.example.com -partition b
Total number of volumes on server fs2.example.com partition /vicepb : 66
sys                  1969534847 RW       1582 K On-line
sys.backup           1969535105 BK       1582 K On-line
      .                   .     .         .   .    .
      .                   .     .         .   .    .
user.pat             1969534536 RW      17518 K On-line
user.pat.backup      1969534538 BK      17537 K On-line
Total volumes onLine 66 ; Total volumes offLine 0 ;  Total busy 0

(those dotted lines in the middle? that's just the manpage going "and a bunch more, you get it" — no cap, the command prints every single one 💅)

Now watch what happens when you toss -fast into the mix. every volume ID, nothing else, pure efficiency:

% vos listvol -server fs2.example.com -partition b -fast
Total number of volumes on server fs2.example.com partition /vicepb : 66
 1969516782
 1969516784
     .
     .
 1969535796

And finally, the -long glow-up ✨ — here are two volumes from the output that shows up when -long is added:

% vos listvol -server fs2.example.com -partition b -long
Total number of volumes on server fs2.example.com partition /vicepb: 66
      .                   .      .         .   .    .
      .                   .      .         .   .    .
user.pat             1969534536 RW      17518 K On-line
     fs2.example.com /vicepb
     RWrite 1969534536 ROnly 0        Backup 1969534538
     MaxQuota      20000 K
     Creation    Mon Jun 12 09:02:25 1989
     Last Update Thu May 20 17:39:34 1999
     1573 accesses in the past day (i.e., vnode references)
user.pat.backup      1969534538 BK      17537 K On-line
     fs2.example.com /vicepb
     RWrite 1969534536 ROnly 0        Backup 1969534538
     MaxQuota      20000 K
     Creation    Tue Jun 13 04:37:59 1989
     Last Update Wed May 19 06:37:59 1999
     0 accesses in the past day (i.e., vnode references)
       .                   .      .         .   .    .
       .                   .      .         .   .    .
Total volumes onLine 66 ; Total volumes offLine 0 ; Total busy 0

see how much extra lore you get with -long? RWrite, ROnly, Backup, MaxQuota, Creation, Last Update, and the vnode reference access count from the past day — it's giving full dossier 🕵️‍♀️💖

🔐 PRIVILEGE REQUIRED 🔐

None. literally none. you need zero special permissions, it's free, it's open, go off 👑

👀 SEE ALSO 👀

go read these too, bestie, they're the whole friend group:

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 that's the whole page, we made it 🫶 this one came from OpenAFS, dated 2026-07-27, and it's the VOS_LISTVOL(1) page — now go forth and list some volumes, you absolute main character 💅✨🎀

📦 where this page comes from