VOS_EXAMINE

Section: AFS Command Reference (1)
Updated: OpenAFS
Index

NAME

vos examine - Shows volume header and VLDB entry information for a volume

SYNOPSIS

vos examine << -id <volume name or ID >>> [-extended]
<< [-cell <cell name] >>> [-noauth] [-localauth] [-verbose]
[-help]

vos e << -i <volume name or ID >>> [-e] << [-c <cell name] >>>
[-n] [-l] [-v] [-h]

vos volinfo << -i <volume name or ID >>> [-e] [-c <cell name>]
[-n] [-l] [-v] [-h]

vos v << -i <volume name or ID >>> [-e] << [-c <cell name] >>>
[-n] [-l] [-v] [-h]

DESCRIPTION

The vos examine command formats and displays information from theVolume Location Database (VLDB) entry and the volume header of the volumespecified by the -id argument.

To display the volume header only, use the vos listvol command. Todisplay information from the VLDB only, use the vos listvldb command.

OPTIONS

-id <volume name or ID>: Specifies either the complete name or volume ID number of the volume,which can be read/write, read-only, or backup.
-extended: Display statistics about read and write operations on files anddirectories in the volume.
-cell <cell name>: Names the cell in which to run the command. Do not combine this argumentwith the -localauth flag. For more details, see the vos(1) manpage.
-noauth: Assigns the unprivileged identity anonymous to the issuer. Do notcombine this flag with the -localauth flag. For more details, seethe vos(1) manpage.
-localauth: Constructs a server ticket using a key from the local/usr/afs/etc/KeyFile file. The vos command interpreter presents itto the Volume Server and Volume Location Server during mutualauthentication. Do not combine this flag with the -cell argument or-noauth flag. For more details, see the vos(1) manpage.
-verbose: Produces on the standard output stream a detailed trace of the command'sexecution. If this argument is omitted, only warnings and error messagesappear.
-help: Prints the online help for this command. All other valid options areignored.

OUTPUT

The first seven lines of the output show information from the volumeheader and the remaining lines come from the VLDB. Each item in thefollowing list corresponds to a line of output derived from the volumeheader.

*: Basic information about the specified volume (displayed on a singleline):
*: Name
*: Volume ID number
*: Type (the flag is RW for read/write, RO for read-only, BK forbackup)
*: 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.
Off-line: The volume is not accessible to Cache Managers, but does not seem to becorrupted. This status appears while a volume is being dumped, forexample.
Off-line**needs salvage**: The volume is not accessible to Cache Managers, because it seems to becorrupted. Use the bos salvage or salvager command to repair thecorruption.
*: The file server machine and partition that house the volume, as determinedby the command interpreter as the command runs, rather than derived fromthe VLDB or the volume header.
*: The volume ID numbers associated with the various versions of the volume:read/write (RWrite), read-only (ROnly), backup (Backup), andReleaseClone (RClone). One of them matches the volume ID number thatappears on the first line of the volume's output. If the value in theRWrite, ROnly, or Backup field is 0 (zero), there is no volumeof that type. If there is currently no ReleaseClone, the RClone fielddoes 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 thevolume has been restored with the backup diskrestore, backupvolrestore, or vos restore command, this is the restore time.
*: The date and time when the contents of the volume last changed, in theLast Update field. For read-only and backup volumes, it matches thetimestamp in the Creation field.
*: The number of times the volume has been accessed for a fetch or storeoperation since the later of the two following times:
*: 12:00 a.m. on the day the command is issued
*: The last time the volume changed location

When the -extended flag is included, two tables appear next:

*: The table labeled Raw Read/Write Stats contains information on thenumber of reads (fetches) and writes (stores) made on the specifiedvolume.
*: The table labeled Writes Affecting Authorship contains information onwrites made to files and directories in the specified volume.

If the following message appears instead of the previously listedinformation, it indicates that a volume is not accessible to CacheManagers or the vos command interpreter, for example because a clone isbeing created.

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

If the following message appears instead of the previously listedinformation, it indicates that the File Server is unable to attach thevolume, perhaps because it is seriously corrupted. The FileLog andVolserLog log files in the /usr/afs/logs directory on the fileserver machine possibly provide additional information; use the bosgetlog command to display them.

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

Following a blank line, information from the VLDB entry appears. Eachitem in this list corresponds to a separate line in the output:

*: The base (read/write) volume name. The read-only and backup versions havethe same name with a .readonly and .backup extension, respectively.
*: The volume ID numbers allocated to the versions of the volume thatactually exist, in fields labeled RWrite for the read/write, ROnlyfor the read-only, Backup for the backup, and RClone for theReleaseClone. (If a field does not appear, the corresponding version ofthe volume does not exist.) The appearance of the RClone field normallyindicates that a release operation did not complete successfully; theOld release and New release flags often also appear on one or moreof the site definition lines described just following.
*: The number of sites that house a read/write or read-only copy of thevolume, following the string < number of sites - >>.
*: A line for each site that houses a read/write or read-only copy of thevolume, specifying the file server machine, partition, and type of volume(RW for read/write or RO for read-only). If a backup version exists,it is understood to share the read/write site. Several flags can appearwith a site definition:
Not released: Indicates that the vos release command has not been issued since the vosaddsite command was used to define the read-only site.
Old release: Indicates that a vos release command did not complete successfully,leaving the previous, obsolete version of the volume at this site.
New release: Indicates that a vos release command did not complete successfully, butthat this site did receive the correct new version of the volume.
*: If the VLDB entry is locked, the string Volume is currently LOCKED.

For further discussion of the New release and Old release flags, seethe vos_release(1) manpage.

EXAMPLES

The following example shows output for the ABC Corporation volume calledusr with two read-only replication sites (this volume is mounted at the/afs/abc.com/usr directory). For the sake of illustration, the outputshows the volume as locked.

   % vos examine usr   usr                           536870981 RW   3459 K On-line        fs2.abc.com /vicepb        RWrite 5360870981   ROnly 536870982   Backup 536870983        MaxQuota      40000 K        Creation    Mon Jun 12 15:22:06 1989        Last Update Fri Jun 16 09:34:35 1989        5719 accesses in the past day (i.e., vnode references)        RWrite: 5360870981   ROnly: 536870982   Backup: 536870983        number of sites -> 3           server fs1.abc.com partition /vicepa RO Site           server fs3.abc.com partition /vicepa RO Site           server fs2.abc.com partition /vicepb RW Site        Volume is currently LOCKED

The following example shows the output for the volume user.terry usingthe -extended flag. The volume has no read-only replication sites.

   % vos examine -id user.terry -extended   user.terry         354287190 RW    2302 K used 119 files On-line       fs4.abc.com /vicepc       RWrite 354287190 ROnly          0 Backup 354287192       MaxQuota       5000 K       Creation    Wed Nov 25 17:38:57 1992       Last Update Tue Dec 15 10:46:20 1992       598 accesses in the past day (i.e., vnode references)                         Raw Read/Write Stats             |-------------------------------------------|             |    Same Network     |    Diff Network     |             |----------|----------|----------|----------|             |  Total   |   Auth   |   Total  |   Auth   |             |----------|----------|----------|----------|   Reads     |       55 |       55 |       38 |       38 |   Writes    |       95 |       95 |        0 |        0 |             |-------------------------------------------|                      Writes Affecting Authorship             |-------------------------------------------|             |   File Authorship   | Directory Authorship|             |----------|----------|----------|----------|             |   Same   |   Diff   |    Same  |   Diff   |             |----------|----------|----------|----------|   0-60 sec  |       38 |        0 |       21 |        1 |   1-10 min  |        2 |        0 |        7 |        0 |   10min-1hr |        0 |        0 |        1 |        0 |   1hr-1day  |        1 |        0 |        5 |        1 |   1day-1wk  |        0 |        0 |        0 |        0 |   > 1wk     |        0 |        0 |        0 |        0 |             |-------------------------------------------|       RWrite: 354287190    Backup: 354287192       number of sites -> 1          server fs4.abc.com partition /vicepc RW Site

PRIVILEGE REQUIRED

None

COPYRIGHT

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

This document was created byman2html,using the manual pages.