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