VOS_EXAMINE(1)

NAME
vos_examine - Shows volume header and VLDB entry information for a volume

SYNOPSIS
vos examine -id <volume name or ID> [-extended]
    [-format] [-cell <cell name>]
    [-noauth] [-localauth] [-verbose]
    [-encrypt] [-noresolve]
    [-config <config directory>]
    [-help]

vos e -i <volume name or ID> [-ex] [-f]
    [-c <cell name>]
    [-noa] [-l] [-v] [-e] [-nor]
    [-co <config directory>]
    [-h]

vos volinfo -id <volume name or ID> [-extended]
    [-format] [-cell <cell name>]
    [-noauth] [-localauth] [-verbose]
    [-encrypt] [-noresolve]
    [-config <config directory>]
    [-help]

vos v -i <volume name or ID> [-ex] [-f]
    [-c <cell name>]
    [-noa] [-l] [-v] [-e] [-nor]
    [-co <config directory>]
    [-h]

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

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

CAUTIONS
Currently, the maximum quota for a volume is 2 terabytes (2^41 bytes). Note that this only affects the volume's quota; a volume may grow much larger if the volume quota is disabled. However, volumes over 2 terabytes in size may be impractical to move, and may have their size incorrectly reported by some tools, such as fs_listquota(1).

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
    Displays statistics about read and write operations on files and directories in the volume.

-format
    Shows information in a format suitable for machine parsing.

-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).

-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 -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.

-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.

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

•   Basic information about the specified volume (displayed on a single line):

    •   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.

        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.

•   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.

•   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. For a read-only volume, this is the last release time.

•   The date and time this copy of this volume was created, in the "Copy" field. This is the time when the volume was created on this server and partition. For read-only volumes, it is not updated by a release (unlike the Creation date). The copy date is not stored in volume dumps.

•   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:

    •   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 the number of reads (fetches) and writes (stores) made on the specified volume.

•   The table labeled "Writes Affecting Authorship" contains information on writes made to files and directories in the specified volume.

If the following message appears instead of the previously listed information, it indicates that 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 the following message appears instead of the previously listed information, it indicates that the File Server is unable to attach the volume, perhaps because it is seriously corrupted. 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.

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

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

•   The base (read/write) volume name. The read-only and backup versions have the same name with a ".readonly" and ".backup" extension, respectively.

•   The volume ID numbers allocated to the versions of the volume that actually exist, in fields labeled "RWrite" for the read/write, "ROnly" for the read-only, "Backup" for the backup, and "RClone" for the ReleaseClone. (If a field does not appear, the corresponding version of the volume does not exist.) The appearance of the "RClone" field normally indicates that a release operation did not complete successfully; the "Old release" and "New release" flags often also appear on one or more of the site definition lines described just following.

•   The number of sites that house a read/write or read-only copy of the volume, following the string "number of sites ->".

•   A line for each site that houses a read/write or read-only copy of the volume, 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 appear with a site definition:

    Not released
        Indicates that the vos release command has not been issued since the vos addsite 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, but that this site did receive the correct new version of the volume.

•   If the VLDB entry is locked, the string "Volume is currently LOCKED", as well as (in OpenAFS 1.5.75 and later) one or more of the following strings:

    Volume is locked for a move operation
        Indicates that the volume was locked due to a vos move or a vos convertROtoRW command.

    Volume is locked for a release operation
        Indicates that the volume was locked due to a vos release command.

    Volume is locked for a backup operation
        Indicates that the volume was locked due to a vos backup command.

    Volume is locked for a delete/misc operation
        Indicates that the volume was locked due to a vos delentry, vos addsite, vos remsite, vos changeloc, vos syncvldb, vos syncserv, vos rename, or vos lock command.

    Volume is locked for a dump/restore operation
        Indicates that the volume was locked due to a vos dump or vos restore command.

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

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

   % vos examine usr
   usr                           536870981 RW   3459 K On-line
        fs2.example.com /vicepb
        RWrite 5360870981   ROnly 536870982   Backup 536870983
        MaxQuota      40000 K
        Creation    Mon Jun 12 15:22:06 1989
        Copy        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.example.com partition /vicepa RO Site
           server fs3.example.com partition /vicepa RO Site
           server fs2.example.com partition /vicepb RW Site
        Volume is currently LOCKED

The following example shows the output for the volume "user.terry" using the -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.example.com /vicepc
       RWrite 354287190 ROnly          0 Backup 354287192
       MaxQuota       5000 K
       Creation    Wed Nov 25 17:38:57 1992
       Copy        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.example.com partition /vicepc RW Site

PRIVILEGE REQUIRED
None

SEE ALSO
backup_diskrestore(8), backup_volrestore(8), bos_getlog(8), bos_salvage(8), salvager(8), vos(1), vos_listvol(1), vos_listvldb(1), vos_release(1), vos_restore(1)

COPYRIGHT
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.