vos: remaddrs sub-command
[openafs.git] / doc / man-pages / pod1 / vos_copy.pod.in
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<-noresolve>]
18    S<<< [B<-config> <I<config directory>>] >>>
19    [B<-help>]
20
21 B<vos cop> S<<< [B<-i>] <I<volume name or ID of source>> >>>
22    S<<< [B<-froms>] <I<machine name for source>> >>>
23    S<<< [B<-fromp>] <I<partition name for source>> >>>
24    S<<< [B<-ton>] <I<volume name for new copy>> >>>
25    S<<< [B<-tos>] <I<machine name for destination>> >>>
26    S<<< [B<-top>] <I<partition name for destination>> >>>
27    [B<-o>] [B<-r>] [B<-li>] S<<< [B<-c> <I<cell name>>] >>>
28    [B<-noa>] [B<-lo>] [B<-v>] [B<-e>] [B<-nor>]
29    S<<< [B<-co> <I<config directory>>] >>>
30    [B<-h>]
31
32 =for html
33 </div>
34
35 =head1 DESCRIPTION
36
37 The B<vos copy> command makes a copy of a volume with a new name.  It is
38 equivalent to B<vos dump> followed by B<vos restore>, but doesn't require
39 the volume be stored locally by the client.
40
41 =head1 CAUTIONS
42
43 =include fragments/volsize-caution.pod
44
45 =head1 OPTIONS
46
47 =over 4
48
49 =item B<-id> <I<volume name or ID>>
50
51 Specifies either the complete name or volume ID number of a read/write
52 volume.
53
54 =item B<-fromserver> <I<machine name for source>>
55
56 Identifies the file server machine where the source volume resides. Provide
57 the machine's IP address or its host name (either fully qualified or using
58 an unambiguous abbreviation). For details, see L<vos(1)>.
59
60 =item B<-frompartition> <I<partition name for source>>
61
62 Names the partition where the source volume resides. Provide the full
63 partition name (for, example, B</vicepa>) or one of the abbreviated forms
64 described in L<vos(1)>.
65
66 =item B<-toname> <I<volume name for new copy>>
67
68 The complete name of the new volume to create.
69
70 =item B<-toserver> <I<machine name for destination>>
71
72 Identifies the file server machine to which to copy the volume.  Provide
73 the machine's IP address or its host name (either fully qualified or using
74 an unambiguous abbreviation). For details, see L<vos(1)>.
75
76 =item B<-topartition> <I<partition name for destination>>
77
78 Names the partition to which to copy the volume. Provide the full partition
79 name (for, example, B</vicepa>) or one of the abbreviated forms described in
80 L<vos(1)>.
81
82 =item B<-offline>
83
84 Leaves the new volume flagged as off-line in the volume database.
85
86 =item B<-readonly>
87
88 Flags the new volume as read-only in the volume database.
89
90 =item B<-live>
91
92 Copies the live volume without cloning.  This is normally not necessary and
93 causes the volume to be kept locked for longer than the normal copy
94 mechanism.
95
96 =include fragments/vos-common.pod
97
98 =back
99
100 =head1 OUTPUT
101
102 This command has no output unless C<-verbose> is specified or there is
103 an error.
104
105 =head1 EXAMPLES
106
107 The following example makes a verbose copy of the C<test> volume named
108 C<test2> in the cell C<localcell>. The volume and copy both reside on
109 C</vicepa> of C<server1>.
110
111    % vos copy test server1  a test2 server1 a -cell localcell -verbose
112    Starting transaction on source volume 536870921 ... done
113    Allocating new volume id for clone of volume 536870921 ... done
114    Allocating new volume id for copy of volume 536870921 ... done
115    Cloning source volume 536870921 ... done
116    Ending the transaction on the source volume 536870921 ... done
117    Starting transaction on the cloned volume 536870926 ... done
118    Setting flags on cloned volume 536870926 ... done
119    Getting status of cloned volume 536870926 ... done
120    Creating the destination volume 536870927 ... done
121    Setting volume flags on destination volume 536870927 ... done
122    Dumping from clone 536870926 on source to volume 536870927 on destination ... done
123    Ending transaction on cloned volume 536870926 ... done
124    Starting transaction on source volume 536870921 ... done
125    Doing the incremental dump from source to destination for volume 536870921 ...  done
126    Setting volume flags on destination volume 536870927 ... done
127    Ending transaction on destination volume 536870927 ... done
128    Ending transaction on source volume 536870921 ... done
129    Starting transaction on the cloned volume 536870926 ... done
130    Deleting the cloned volume 536870926 ... done
131    Ending transaction on cloned volume 536870926 ... done
132    Created the VLDB entry for the volume test2 536870927
133    Volume 536870921 copied from server1 /vicepa to test2 on server1 /vicepa 
134
135 =head1 PRIVILEGE REQUIRED
136
137 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
138 machine specified with the B<-server> argument and on each database server
139 machine. If the B<-localauth> flag is included, the issuer must instead be
140 logged on to a server machine as the local superuser C<root>.
141
142 =head1 SEE ALSO
143
144 L<vos(1)>,
145 L<vos_clone(1)>,
146 L<vos_move(1)>
147
148 =head1 COPYRIGHT
149
150 Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
151
152 This documentation is covered by the BSD License as written in the
153 doc/LICENSE file. This man page was written by Jason Edgecombe for
154 OpenAFS.