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