NAME

vos_listvol - Displays information from a volume header

SYNOPSIS

vos listvol -server <file server> [-partition <partition name>] [-fast] [-long] [-quiet] [-extended] [-format] [-cell <cell name>] [-noauth] [-auth] [-localauth] [-encrypt [<yes|no>]] [-verbose] [-noresolve] [-config <configuration file>] [-help]

DESCRIPTION

The vos listvol command formats and displays state information for volumes housed on the File Server and partition specified by the -server and -partition arguments.

Combine the command's arguments as indicated:

To display the volume location information for one or more volumes, use the vos listloc command.

To display both the volume location and state information for a single volume, use the vos examine command.

OPTIONS

-server <server name>

Identifies the file server machine that houses volumes for which to display the volume state information. Provide a fully qualified host name, an IP address or UUID as reported by vos listfs.

This argument can be combined with the -partition argument, as well as the -fast, -long, or -extended flag.

-partition <partition name>

Identifies the partition (on the File Server specified by the -server argument) that houses volumes for which state information will be displayed. Provide the partition's complete name with preceding slash (for example, /vicepa) or use one of the three acceptable abbreviated forms. For details, see vos.

-fast

Displays only the volume ID numbers of volumes stored at the site specified by the -server, and optionally -partition, argument. Do not combine this flag with the -extended flag.

-long

Displays more detailed information about each volume stored at the site specified by the -server, and optionally -partition, argument. The information includes the volume IDs of all three volume types associated with the volume, and the read/write volume's quota, the space used, the file count, creation date, copy date, backup date, last access date, and last update date.

-quiet

Suppresses the header and footer that summarize the number of volumes listed and their status, which otherwise appear at the beginning and end of the output when the output includes more than one volume.

-extended

Displays extensive statistics about access patterns for each volume stored at the site specified by the -server, and optionally -partition, argument. The statistics 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.

-format

Displays information in a format suitable for machine parsing. Each field is separated by a single tab character.

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

-noauth

Assigns the unprivileged identity anonymous to the issuer. Do not combine this flag with the -localauth flag. For more details, see vos.

-localauth

Obtains an authentication token using the server encryption key with the highest key version number in the local /etc/yfs/server/KeyFileExt file. The resulting token never expires and has Super User privileges. Do not combine this flag with the -cell argument or -noauth flag. For more details, see vos.

-auth

Use the calling user's tokens from the kernel or as obtained using the active Kerberos ticket granting ticket to communicate with the Volume Server and Location Service. This is the default if neither -localauth nor -noauth is given.

Since this option is the default, it is usually not useful for running single command line operations. However, it can be useful when running commands via vos interactive or vos source, since otherwise it would be impossible to switch from, for example, -localauth back to using regular tokens during a bulk operation.

-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 [<yes|no>]

Enables or disables encrytion for the command so that the operation's results are not transmitted across the network in clear text.

-noresolve

Shows all servers as IP addresses instead of the reverse DNS lookup hostname. -noresolve useful when troubleshooting no such volume and volume moved errors.

-config <configuration file>

Set the location of the configuration file to be used. The default file is /etc/yfs/yfs-client.conf.

-help

Prints the online help for this command. All other valid options are ignored.

OUTPUT

The output is ordered alphabetically by volume name and by default provides the following information on a single line for each 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/yfs directory on the File Server can provide additional information; use the bos getlog command to display their contents.

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

The information 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 the -fast flag is added, the output displays only the volume ID number of each volume, arranged in increasing numerical order. The final line (which summarizes the number of online, offline, and busy volumes) is omitted.

If the -long flag is included, the output for each volume includes all of the information in the default listing plus the following. Each item in this list corresponds to a separate line of output:

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

EXAMPLES

The following example shows the output for the /vicepb partition on the File Server fs2.your-cell-name.com when no flags are provided:

   % vos listvol -server fs2.your-cell-name.com -partition b
   Total number of volumes on server fs2.your-cell-name.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

The following example shows the output when the -fast flag is added:

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

The following example shows two volumes from the output that appears when the -long flag is added:

   % vos listvol -server fs2.your-cell-name.com -partition b -long
   Total number of volumes on server fs2.your-cell-name.com partition /vicepb: 66
         .                   .      .         .   .    .
         .                   .      .         .   .    .
   user.pat             1969534536 RW      17518 K On-line
        fs2.your-cell-name.com /vicepb
        RWrite 1969534536 ROnly 0        Backup 1969534538
        MaxQuota      20000 K
        Used           1382 K
        FileCount        23
        Creation    Mon Jun 12 09:02:25 1989
        Copy        Mon Jun 12 09:02:25 1989
        Backup      Thu May 20 09:02:25 1999
        Last Access Thu May 20 17:39:34 1999
        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.your-cell-name.com /vicepb
        RWrite 1969534536 ROnly 0        Backup 1969534538
        MaxQuota      20000 K
        Used          18929 K
        FileCount       328
        Creation    Tue Jun 13 04:37:59 1989
        Copy        Tue Jun 13 04:37:59 1989
        Backup      Tue Jun 13 04:37:59 1989
        Last Access Wed May 19 06:37:59 1999
        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

PRIVILEGE REQUIRED

The issuer must be listed in the /etc/yfs/server/UserListExt file on the File Server specified by the -server argument and on each Location Server. If the -localauth flag is included, the issuer must instead be logged on to a server with an account capable of reading the /etc/yfs/server/KeyFileExt file.

SEE ALSO

backup_diskrestore(8), backup_volrestore(8), bos_getlog(8), bos_salvage(8), salvager(8), vos(1), vos_examine(1), vos_listloc(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.

ACKNOWLEDGEMENTS

"AFS" is a registered mark of International Business Machines Corporation, used under license. (USPTO Registration 1598389)

"OpenAFS" is a registered mark of International Business Machines Corporation. (USPTO Registration 4577045)

The "AuriStor" name, log 'S' brand mark, and icon are registered marks of AuriStor, Inc. (USPTO Registrations 4849419, 4849421, and 4928460) (EUIPO Registration 015539653).

"Your File System" is a registered mark of AuriStor, Inc. (USPTO Registrations 4801402 and 4849418).

"YFS" and "AuriStor File System" are trademarks of AuriStor, Inc.