man-page-license-change-20071225
[openafs.git] / doc / man-pages / pod1 / vos_copy.pod
1 =head1 NAME
2
3 vos_copy - Make a copy of a volume
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos copy> S<<< [B<-id>] <I<volume name or ID of source>> >>>
11    S<<< [B<-fromserver>] <I<machine name for source>> >>>
12    S<<< [B<-frompartition>] <I<partition name for source>> >>>
13    S<<< [B<-toname>] <I<volume name for new copy>> >>>
14    S<<< [B<-toserver>] <I<machine name for destination>> >>>
15    S<<< [B<-topartition>] <I<partition name for destination>> >>>
16    [B<-offline>] [B<-readonly>] [B<-live>] S<<< [B<-cell> <I<cell name>>] >>>
17    [B<-noauth>] [B<-localauth>] [B<-verbose>] [B<-encrypt>] [B<-help>]
18
19 =for html
20 </div>
21
22 =head1 DESCRIPTION
23
24 The B<vos copy> command makes a copy of a volume with a new name.  It is
25 equivalent to B<vos dump> followed by B<vos restore>, but doesn't require
26 the volume be stored locally by the client.
27
28 =head1 OPTIONS
29
30 =over 4
31
32 =item [B<-id>] <I<volume name or ID>>
33
34 Specifies either the complete name or volume ID number of a read/write
35 volume.
36
37 =item [B<-fromserver>] <I<machine name for source>>
38
39 Identifies the file server machine where the source volume resides. Provide
40 the machine's IP address or its host name (either fully qualified or using
41 an unambiguous abbreviation). For details, see L<vos(1)>.
42
43 =item [B<-frompartition>] <I<partition name for source>>
44
45 Names the partition where the source volume resides. Provide the full
46 partition name (for, example, B</vicepa>) or one of the abbreviated forms
47 described in L<vos(1)>.
48
49 =item [B<-toname>] <I<volume name for new copy>>
50
51 The complete name of the new volume to create.
52
53 =item [B<-toserver>] <I<machine name for destination>>
54
55 Identifies the file server machine to which to copy the volume.  Provide
56 the machine's IP address or its host name (either fully qualified or using
57 an unambiguous abbreviation). For details, see L<vos(1)>.
58
59 =item [B<-topartition>] <I<partition name for destination>>
60
61 Names the partition to which to copy the volume. Provide the full partition
62 name (for, example, B</vicepa>) or one of the abbreviated forms described in
63 L<vos(1)>.
64
65 =item B<-offline>
66
67 Leaves the new volume flagged as off-line in the volume database.
68
69 =item B<-readonly>
70
71 Flags the new volume as read-only in the volume database.
72
73 =item B<-live>
74
75 Copies the live volume without cloning.  This is normally not necessary and
76 causes the volume to be kept locked for longer than the normal copy
77 mechanism.
78
79 =item B<-localauth>
80
81 Constructs a server ticket using a key from the local
82 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it to
83 the Volume Server and Volume Location Server during mutual
84 authentication. Do not combine this flag with the B<-cell> argument or
85 B<-noauth> flag. For more details, see L<vos(1)>.
86
87 =item B<-verbose>
88
89 Produces on the standard output stream a detailed trace of the command's
90 execution. If this argument is omitted, only warnings and error messages
91 appear.
92
93 =item B<-encrypt>
94
95 Encrypts the command so that the operation's results are not transmitted
96 across the network in clear text.
97
98 =item B<-help>
99
100 Prints the online help for this command. All other valid options are
101 ignored.
102
103 =back
104
105 =head1 OUTPUT
106
107 This command has no output unless C<-verbose> is specified or there is
108 an error.
109
110 =head1 EXAMPLES
111
112 The following example makes a verbose copy of the C<test> volume named
113 C<test2> in the cell C<localcell>. The volume and copy both reside on
114 C</vicepa> of C<server1>.
115
116    % vos copy test server1  a test2 server1 a -cell localcell -verbose
117    Starting transaction on source volume 536870921 ... done
118    Allocating new volume id for clone of volume 536870921 ... done
119    Allocating new volume id for copy of volume 536870921 ... done
120    Cloning source volume 536870921 ... done
121    Ending the transaction on the source volume 536870921 ... done
122    Starting transaction on the cloned volume 536870926 ... done
123    Setting flags on cloned volume 536870926 ... done
124    Getting status of cloned volume 536870926 ... done
125    Creating the destination volume 536870927 ... done
126    Setting volume flags on destination volume 536870927 ... done
127    Dumping from clone 536870926 on source to volume 536870927 on destination ... done
128    Ending transaction on cloned volume 536870926 ... done
129    Starting transaction on source volume 536870921 ... done
130    Doing the incremental dump from source to destination for volume 536870921 ...  done
131    Setting volume flags on destination volume 536870927 ... done
132    Ending transaction on destination volume 536870927 ... done
133    Ending transaction on source volume 536870921 ... done
134    Starting transaction on the cloned volume 536870926 ... done
135    Deleting the cloned volume 536870926 ... done
136    Ending transaction on cloned volume 536870926 ... done
137    Created the VLDB entry for the volume test2 536870927
138    Volume 536870921 copied from server1 /vicepa to test2 on server1 /vicepa 
139
140 =head1 PRIVILEGE REQUIRED
141
142 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
143 machine specified with the B<-server> argument and on each database server
144 machine. If the B<-localauth> flag is included, the issuer must instead be
145 logged on to a server machine as the local superuser C<root>.
146
147 =head1 SEE ALSO
148
149 L<vos(1)>,
150 L<vos_clone(1)>,
151 L<vos_move(1)>
152
153 =head1 COPYRIGHT
154
155 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
156
157 This documentation is covered by the BSD License as written in the
158 doc/LICENSE file. This man page was written by Jason Edgecombe for
159 OpenAFS.