doc/man-pages/pod/backup_volinfo.pod

   1 =head1 NAME
   2
   3 backup volinfo - Displays a volume's dump history from the Backup Database
   4
   5 =head1 SYNOPSIS
   6
   7 backup volinfo B<-volume> I<volume name>
   8 [B<-localauth>]  [B<-cell> I<cell name>]  [B<-help>]
   9
  10 backup voli B<-v> I<volume name>  [B<-l>]  [B<-c> I<cell name>]  [B<-h>]
  11
  12 =head1 DESCRIPTION
  13
  14 The C<backup volinfo> command displays a dump history of the specified
  15 volume, reporting information such as the date on which the volume was
  16 dumped and the tapes that contain it. Include the C<.backup> extension on
  17 the volume name if the backup version of the volume was dumped.
  18
  19 =head1 OPTIONS
  20
  21 =over 4
  22
  23 =item B<-volume> I<volume name>
  24
  25 Names the volume for which to display the dump history. Include
  26 the C<.backup> or C<.readonly> extension if the backup or read-only
  27 version of the volume was dumped.
  28
  29 =item B<-localauth>
  30
  31 Constructs a server ticket using a key from the local
  32 B</usr/afs/etc/KeyFile> file. The C<backup> command interpreter
  33 presents it to the Backup Server, Volume Server and VL Server
  34 during mutual authentication. Do not combine this flag with the
  35 B<-cell> argument. For more details, see the introductory L<backup(1)>
  36 reference page.
  37
  38 =item B<-cell> I<cell name>
  39
  40 Names the cell in which to run the command. Do not combine this
  41 argument with the B<-localauth> flag. For more details, see the
  42 introductory L<backup(1)> reference page.
  43
  44 =item B<-help>
  45
  46 Prints the online help for this command. All other valid
  47 options are ignored.
  48
  49 =back
  50
  51 =head1 OUTPUT
  52
  53 The output includes a line for each Backup Database dump record that
  54 mentions the specified volume, order from most to least recent. The
  55 output for each record appears in a table with six columns:
  56
  57 =over
  58
  59 =item B<dumpID>
  60
  61 The dump ID of the dump that includes the volume.
  62
  63 =item B<lvl>
  64
  65 The depth in the dump hierarchy of the dump level at which the
  66 volume was dumped. A value of 0 indicates a full dump. A value
  67 of 1 or greater indicates an incremental dump made at the
  68 specified depth in the dump hierarchy.
  69
  70 =item B<parentid>
  71
  72 The dump ID of the dump's parent dump. A value of 0 indicates a
  73 full dump, which has no parent; in this case, the value in the
  74 C<lvl> column is also 0.
  75
  76 =item B<creation date>
  77
  78 The date and time at which the Backup System started the dump
  79 operation that created the dump.
  80
  81 =item B<clone date>
  82
  83 For a backup or read-only volume, the time at which it was
  84 cloned from its read/write source. For a read/write volume, the
  85 same as the value in the creation date field.
  86
  87 =item B<tape name>
  88
  89 The name of the tape containing the dump: either the permanent
  90 tape name, or an AFS tape name in the format
  91 I<volume_set_name>.I<dump_level_name>.I<tape_index> where
  92 I<volume_set_name> is the name of the volume set associated with
  93 the initial dump in the dump set of which this tape is a part;
  94 I<dump_level_name> is the name of the dump level at which the
  95 initial dump was backed up; I<tape_index> is the ordinal of the
  96 tape in the dump set. Either type of name can be followed by a
  97 dump ID in parentheses; if it appears, it is the dump ID of the
  98 initial dump in the dump set to which this appended dump
  99 belongs.
 100
 101 =back
 102
 103 =head1 EXAMPLES
 104
 105 The following example shows part of the dump history of the Backup
 106 volume user.smith.backup:
 107
 108     backup volinfo -volume user.smith.backup
 109    DumpID    lvl parentID  creation date    clone date       tape name
 110    924600000 1   924427600 04/20/1999 05:20 04/20/1999 05:01 user_incr_2 (924514392)
 111    924514392 1   924427600 04/19/1999 05:33 04/19/1999 05:08 user_incr_2
 112    924427600 0           0 04/18/1999 05:26 04/18/1999 04:58 user_full_6
 113        .     .       .         .        .       .        .        .
 114        .     .       .         .        .       .        .        .
 115
 116 =head1 PRIVILEGE REQUIRED
 117
 118 None
 119
 120 =head1 COPYRIGHT
 121
 122 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 123
 124 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
 125 and Elizabeth Cassell <e_a_c@mailsnare.net>, 2004,
 126 Stanford Linear Accelerator Center, a department of Stanford University.
 127
 128 =head1 SEE ALSO
 129
 130 L<backup(1)>,
 131 L<backup_dumpinfo(1)>,
 132 L<backup_volrestore(1)>
 133
 134 =cut