doc/man-pages/pod1/vos_listvol.pod

   1 =head1 NAME
   2
   3 vos_listvol - Displays information from a volume header
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<vos listvol> S<<< B<-server> <I<machine name>> >>>
  11     S<<< [B<-partition> <I<partition name>>] >>>
  12     [B<-fast>] [B<-long>] [B<-quiet>]
  13     [B<-extended>] [B<-format>]
  14     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
  15     [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
  16     S<<< [B<-config> <I<config directory>>] >>>
  17     [B<-help>]
  18
  19 B<vos listvo> S<<< B<-s> <I<machine name>> >>>
  20     S<<< [B<-p> <I<partition name>>] >>>
  21     [B<-fa>] [-lon] [B<-q>] [B<-ex>] [B<-fo>]
  22     S<<< [B<-c> <I<cell name>>] >>>
  23     [B<-noa>] [B<-loc>] [B<-v>] [B<-en>] [B<-nor>]
  24     S<<< [B<-co> <I<config directory>>] >>>
  25     [B<-h>]
  26
  27 =for html
  28 </div>
  29
  30 =head1 DESCRIPTION
  31
  32 The B<vos listvol> command formats and displays the following information
  33 from the volume header of each specified volume: volume name, volume ID,
  34 volume type, size, and status at the server. The actual information
  35 displayed depends on the combination of arguments supplied when the
  36 command is issued. To display volume header information for various
  37 numbers of volumes, combine the command's arguments as indicated:
  38
  39 =over 4
  40
  41 =item *
  42
  43 For every volume on a file server machine, specify the machine's name with
  44 the B<-server> argument.
  45
  46 =item *
  47
  48 For every volume at a particular site, combine the B<-server> argument
  49 with the B<-partition> argument.
  50
  51 =back
  52
  53 To display the Volume Location Database (VLDB) entry for one or more
  54 volumes, use the B<vos listvldb> command. To display both the VLDB entry
  55 and the volume header for a single volume, use the B<vos examine> command.
  56
  57 =head1 OPTIONS
  58
  59 =over 4
  60
  61 =item B<-server> <I<server name>>
  62
  63 Identifies the file server machine that houses volumes for which to
  64 display the header. Provide the machine's IP address or its host name
  65 (either fully qualified or using an unambiguous abbreviation). For
  66 details, see L<vos(1)>.
  67
  68 This argument can be combined with the B<-partition> argument, as well as
  69 the B<-fast>, B<-long>, or B<-extended> flag.
  70
  71 =item B<-partition> <I<partition name>>
  72
  73 Identifies the partition (on the file server machine specified by the
  74 B<-server> argument) that houses volumes for which to display the
  75 header. Provide the partition's complete name with preceding slash (for
  76 example, F</vicepa>) or use one of the three acceptable abbreviated
  77 forms. For details, see L<vos(1)>.
  78
  79 =item B<-fast>
  80
  81 Displays only the volume ID numbers of volumes stored at the site
  82 specified by the B<-server>, and optionally B<-partition>, argument. Do
  83 not combine this flag with the B<-extended> flag.
  84
  85 =item B<-long>
  86
  87 Displays more detailed information about each volume stored at the site
  88 specified by the B<-server>, and optionally B<-partition>, argument. The
  89 information includes the volume IDs of all three volume types associated
  90 with the volume, and the read/write volume's quota, creation date and
  91 update date.
  92
  93 =item B<-quiet>
  94
  95 Suppresses the lines that summarize the number of volumes listed and their
  96 status, which otherwise appear at the beginning and end of the output when
  97 the output includes more than one volume.
  98
  99 =item B<-extended>
 100
 101 Displays extensive statistics about access patterns for each volume stored
 102 at the site specified by the B<-server>, and optionally B<-partition>,
 103 argument. The statistics include the number of reads and writes to files
 104 in the volume, and how recently files and directories have been updated by
 105 their owners or other users. Do not combine this flag with the B<-fast>
 106 flag.
 107
 108 =item B<-format>
 109
 110 Show information in a format suitable for machine parsing.
 111
 112 =item B<-cell> <I<cell name>>
 113
 114 Names the cell in which to run the command. Do not combine this argument
 115 with the B<-localauth> flag. For more details, see L<vos(1)>.
 116
 117 =item B<-noauth>
 118
 119 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
 120 combine this flag with the B<-localauth> flag. For more details, see
 121 L<vos(1)>.
 122
 123 =item B<-localauth>
 124
 125 Constructs a server ticket using a key from the local
 126 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
 127 to the Volume Server and Volume Location Server during mutual
 128 authentication. Do not combine this flag with the B<-cell> argument or
 129 B<-noauth> flag. For more details, see L<vos(1)>.
 130
 131 =item B<-verbose>
 132
 133 Produces on the standard output stream a detailed trace of the command's
 134 execution. If this argument is omitted, only warnings and error messages
 135 appear.
 136
 137 =item B<-encrypt>
 138
 139 Encrypts the command so that the operation's results are not transmitted
 140 across the network in clear text. This option is available in OpenAFS
 141 versions 1.4.11 or later and 1.5.60 or later.
 142
 143 =item B<-noresolve>
 144
 145 Shows all servers as IP addresses instead of the DNS name. This is very
 146 useful when the server address is registered as 127.0.0.1 or when dealing
 147 with multi-homed servers. This option is available in OpenAFS
 148 versions 1.4.8 or later and 1.5.35 or later.
 149
 150 =item B<-help>
 151
 152 Prints the online help for this command. All other valid options are
 153 ignored.
 154
 155 =back
 156
 157 =head1 OUTPUT
 158
 159 The output is ordered alphabetically by volume name and by default
 160 provides the following information on a single line for each volume:
 161
 162 =over 4
 163
 164 =item *
 165
 166 Name
 167
 168 =item *
 169
 170 Volume ID number
 171
 172 =item *
 173
 174 Type (the flag is C<RW> for read/write, C<RO> for read-only, C<BK> for
 175 backup)
 176
 177 =item *
 178
 179 Size in kilobytes (C<1024> equals a megabyte)
 180
 181 =item *
 182
 183 Number of files in the volume, if the B<-extended> flag is provided
 184
 185 =item *
 186
 187 Status on the file server machine, which is one of the following:
 188
 189 =over 4
 190
 191 =item On-line
 192
 193 The volume is completely accessible to Cache Managers.
 194
 195 =item Off-line
 196
 197 The volume is not accessible to Cache Managers, but does not seem to be
 198 corrupted. This status appears while a volume is being dumped, for
 199 example.
 200
 201 =item Off-line**needs salvage**
 202
 203 The volume is not accessible to Cache Managers, because it seems to be
 204 corrupted. Use the B<bos salvage> or B<salvager> command to repair the
 205 corruption.
 206
 207 =back
 208
 209 =back
 210
 211 If the following message appears instead of the previously listed
 212 information, it indicates that a volume is not accessible to Cache
 213 Managers or the B<vos> command interpreter, for example because a clone is
 214 being created.
 215
 216    **** Volume <volume_ID> is busy ****
 217
 218 If the following message appears instead of the previously listed
 219 information, it indicates that the File Server is unable to attach the
 220 volume, perhaps because it is seriously corrupted. The F<FileLog> and
 221 F<VolserLog> log files in the F</usr/afs/logs> directory on the file
 222 server machine possibly provide additional information; use the B<bos
 223 getlog> command to display them.
 224
 225    **** Could not attach volume <volume_ID> ****
 226
 227 The information about individual volumes is bracketed by summary
 228 lines. The first line of output specifies the number of volumes in the
 229 listing. The last line of output summarizes the number of volumes that are
 230 online, offline, and busy. These lines do not appear if the B<-quiet> flag
 231 is used.
 232
 233 If the B<-fast> flag is added, the output displays only the volume ID
 234 number of each volume, arranged in increasing numerical order. The final
 235 line (which summarizes the number of online, offline, and busy volumes) is
 236 omitted.
 237
 238 If the B<-long> flag is included, the output for each volume includes all
 239 of the information in the default listing plus the following. Each item in
 240 this list corresponds to a separate line of output:
 241
 242 =over 4
 243
 244 =item *
 245
 246 The file server machine and partition that house the volume, as determined
 247 by the command interpreter as the command runs, rather than derived from the
 248 VLDB or the volume header.
 249
 250 =item *
 251
 252 The volume ID numbers associated with the various versions of the volume:
 253 read/write (C<RWrite>), read-only (C<ROnly>), backup (C<Backup>), and
 254 ReleaseClone (C<RClone>). One of them matches the volume ID number that
 255 appears on the first line of the volume's output. If the value in the
 256 C<RWrite>, C<ROnly>, or C<Backup> field is C<0> (zero), there is no volume
 257 of that type. If there is currently no ReleaseClone, the C<RClone> field
 258 does not appear at all.
 259
 260 =item *
 261
 262 The maximum space quota allotted to the read/write copy of the volume,
 263 expressed in kilobyte blocks in the C<MaxQuota> field.
 264
 265 =item *
 266
 267 The date and time the volume was created, in the C<Creation> field. If the
 268 volume has been restored with the B<backup diskrestore>, B<backup
 269 volrestore>, or B<vos restore> command, this is the restore time.
 270
 271 =item *
 272
 273 The date and time when the contents of the volume last changed, in the
 274 C<Last Update> field. For read-only and backup volumes, it matches the
 275 timestamp in the C<Creation> field.
 276
 277 =item *
 278
 279 The number of times the volume has been accessed for a fetch or store
 280 operation since the later of the two following times:
 281
 282 =over 4
 283
 284 =item *
 285
 286 12:00 a.m. on the day the command is issued
 287
 288 =item *
 289
 290 The last time the volume changed location
 291
 292 =back
 293
 294 =back
 295
 296 If the B<-extended> flag is included, the output for each volume includes
 297 all of the information reported with the B<-long> flag, plus two tables of
 298 statistics:
 299
 300 =over 4
 301
 302 =item *
 303
 304 The table labeled C<Raw Read/Write Stats> table summarizes the number of
 305 times the volume has been accessed for reading or writing.
 306
 307 =item *
 308
 309 The table labeled C<Writes Affecting Authorship> table contains
 310 information on writes made to files and directories in the specified
 311 volume.
 312
 313 =back
 314
 315 =head1 EXAMPLES
 316
 317 The following example shows the output for the F</vicepb> partition on the
 318 file server machine C<fs2.example.com> when no flags are provided:
 319
 320    % vos listvol -server fs2.example.com -partition b
 321    Total number of volumes on server fs2.example.com partition /vicepb : 66
 322    sys                  1969534847 RW       1582 K On-line
 323    sys.backup           1969535105 BK       1582 K On-line
 324          .                   .     .         .   .    .
 325          .                   .     .         .   .    .
 326    user.pat             1969534536 RW      17518 K On-line
 327    user.pat.backup      1969534538 BK      17537 K On-line
 328    Total volumes onLine 66 ; Total volumes offLine 0 ;  Total busy 0
 329
 330 The following example shows the output when the B<-fast> flag is added:
 331
 332    % vos listvol -server fs2.example.com -partition b -fast
 333    Total number of volumes on server fs2.example.com partition /vicepb : 66
 334     1969516782
 335     1969516784
 336         .
 337         .
 338     1969535796
 339
 340 The following example shows two volumes from the output that appears when
 341 the B<-long> flag is added:
 342
 343    % vos listvol -server fs2.example.com -partition b -long
 344    Total number of volumes on server fs2.example.com partition /vicepb: 66
 345          .                   .      .         .   .    .
 346          .                   .      .         .   .    .
 347    user.pat             1969534536 RW      17518 K On-line
 348         fs2.example.com /vicepb
 349         RWrite 1969534536 ROnly 0        Backup 1969534538
 350         MaxQuota      20000 K
 351         Creation    Mon Jun 12 09:02:25 1989
 352         Last Update Thu May 20 17:39:34 1999
 353         1573 accesses in the past day (i.e., vnode references)
 354    user.pat.backup      1969534538 BK      17537 K On-line
 355         fs2.example.com /vicepb
 356         RWrite 1969534536 ROnly 0        Backup 1969534538
 357         MaxQuota      20000 K
 358         Creation    Tue Jun 13 04:37:59 1989
 359         Last Update Wed May 19 06:37:59 1999
 360         0 accesses in the past day (i.e., vnode references)
 361           .                   .      .         .   .    .
 362           .                   .      .         .   .    .
 363    Total volumes onLine 66 ; Total volumes offLine 0 ; Total busy 0
 364
 365 =head1 PRIVILEGE REQUIRED
 366
 367 None
 368
 369 =head1 SEE ALSO
 370
 371 L<backup_diskrestore(8)>,
 372 L<backup_volrestore(8)>,
 373 L<bos_getlog(8)>,
 374 L<bos_salvage(8)>,
 375 L<salvager(8)>,
 376 L<vos(1)>,
 377 L<vos_examine(1)>,
 378 L<vos_listvldb(1)>,
 379 L<vos_restore(1)>
 380
 381 =head1 COPYRIGHT
 382
 383 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 384
 385 This documentation is covered by the IBM Public License Version 1.0.  It was
 386 converted from HTML to POD by software written by Chas Williams and Russ
 387 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.