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