doc: bos != vos
[openafs.git] / doc / man-pages / pod1 / vos_move.pod
1 =head1 NAME
2
3 vos_move - Moves a read/write volume to another site
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos move> S<<< B<-id> <I<volume name or ID>> >>>
11     S<<< B<-fromserver> <I<machine name on source>> >>>
12     S<<< B<-frompartition> <I<partition name on source>> >>>
13     S<<< B<-toserver> <I<machine name on destination>> >>>
14     S<<< B<-topartition> <I<partition name on destination>> >>>
15     [B<-live>] S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
16     [B<-verbose>] [B<-encrypt>] [B<-noresolve>] [B<-help>]
17
18 B<vos m> S<<< B<-i> <I<volume name or ID>> >>>
19     S<<< B<-froms> <I<machine name on source>> >>>
20     S<<< B<-fromp> <I<partition name on source>> >>>
21     S<<< B<-tos> <I<machine name on destination>> >>>
22     S<<< B<-top> <I<partition name on destination>> >>>
23     [B<-li>] S<<< [B<-c> <I<cell name>>] >>> [B<-noa>]
24     [B<-lo>] [B<-v>] [B<-e>] [B<-nor>] [B<-h>]
25
26 =for html
27 </div>
28
29 =head1 DESCRIPTION
30
31 The B<vos move> command moves the indicated read/write volume from its
32 current site (specified with the B<-fromserver> and B<-frompartition>
33 arguments) to the destination site (specified with the B<-toserver> and
34 B<-topartition> arguments). This command automatically removes the backup
35 copy from the current site, if it exists. To create a new backup volume at
36 the destination site, use the B<vos backup> command.
37
38 This command works on read/write volumes only. To move a read-only volume,
39 use the B<vos addsite> and B<vos release> commands to define a new
40 read-only site and release the volume contents to it, and then use the
41 B<vos remove> command to remove the previous read-only volume's definition
42 from the Volume Location Database (VLDB) and data from the partition. To
43 move a backup volume, use this command to move its read/write source and
44 then issue the B<vos backup> command.
45
46 Before executing this command, the B<vos> command interpreter initiates a
47 check that the destination partition contains enough space to house the
48 volume being moved. If there is not enough space, the move operation is
49 not attempted and the following message appears:
50
51    vos: no space on target partition <dest_part> to move volume <volume>
52
53 =head1 CAUTIONS
54
55 Unless there is a compelling reason, do not interrupt a B<vos move>
56 command in progress. Interrupting a move can result in one or more of the
57 following inconsistent states:
58
59 =over 4
60
61 =item *
62
63 There are two versions of the volume, one at the source site and one at
64 the destination site. (If this happens, retain the version identified by
65 the VLDB and use the B<vos zap> command to remove the other version.)
66
67 =item *
68
69 The backup version of the volume is stranded at the old site. (If this
70 happens, use the B<vos zap> command to remove it.)
71
72 =item *
73
74 The volume is off-line. (If this happens, run the B<bos salvage> command
75 to bring it back on line.)
76
77 =back
78
79 If the Ctrl-C interrupt signal is pressed while a vos move operation is
80 executing, the following message warns of the consequences and requests
81 confirmation of the kill signal:
82
83    SIGINT handler: vos move operation in progress
84    WARNING: may leave AFS storage and metadata in indeterminate state
85    enter second control-c to exit
86
87 To confirm termination of the operation, press Ctrl-C a second time; press
88 any other key to continue the operation.
89
90 Currently, the maximum size of a volume is 2 terabytes (2^31 bytes).
91
92 =head1 OPTIONS
93
94 =over 4
95
96 =item B<-id> <I<volume name or ID>>
97
98 Specifies either the complete name or volume ID number of a read/write
99 volume.
100
101 =item B<-fromserver> <I<server name>>
102
103 Identifies the file server machine where the volume currently
104 resides. Provide the machine's IP address or its host name (either fully
105 qualified or using an unambiguous abbreviation). For details, see
106 L<vos(1)>.
107
108 =item B<-frompartition> <I<partition name>>
109
110 Names the partition where the volume currently resides. Provide the full
111 partition name (for, example, B</vicepa>) or one of the abbreviated forms
112 described in L<vos(1)>.
113
114 =item B<-toserver> <I<server name>>
115
116 Identifies the file server machine to which to move the volume.  Provide
117 the machine's IP address or its host name (either fully qualified or using
118 an unambiguous abbreviation). For details, see L<vos(1)>.
119
120 =item B<-topartition> <I<partition name>>
121
122 Names the partition to which to move the volume. Provide the full
123 partition name (for, example, B</vicepa>) or one of the abbreviated forms
124 described in L<vos(1)>.
125
126 =item B<-live>
127
128 Avoids making a temporary copy of the volume during the move. This is
129 useful if the partition is full, but the administrator needs to move
130 volumes to a another partition or server to free up disk space. The
131 caveat is that the volume is locked during the entire operation
132 instead of the short time that is needed to make the temporary clone.
133
134 =item B<-cell> <I<cell name>>
135
136 Names the cell in which to run the command. Do not combine this argument
137 with the B<-localauth> flag. For more details, see L<vos(1)>.
138
139 =item B<-noauth>
140
141 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
142 combine this flag with the B<-localauth> flag. For more details, see
143 L<vos(1)>.
144
145 =item B<-localauth>
146
147 Constructs a server ticket using a key from the local
148 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
149 to the Volume Server and Volume Location Server during mutual
150 authentication. Do not combine this flag with the B<-cell> argument or
151 B<-noauth> flag. For more details, see L<vos(1)>.
152
153 =item B<-verbose>
154
155 Produces on the standard output stream a detailed trace of the command's
156 execution. If this argument is omitted, only warnings and error messages
157 appear.
158
159 =item B<-encrypt>
160
161 Encrypts the command so that the operation's results are not transmitted
162 across the network in clear text. This option is available in OpenAFS
163 versions 1.4.11 or later and 1.5.60 or later.
164
165 =item B<-noresolve>
166
167 Shows all servers as IP addresses instead of the DNS name. This is very
168 useful when the server address is registered as 127.0.0.1 or when dealing
169 with multi-homed servers. This option is available in OpenAFS
170 versions 1.4.8 or later and 1.5.35 or later.
171
172 =item B<-help>
173
174 Prints the online help for this command. All other valid options are
175 ignored.
176
177 =back
178
179 =head1 EXAMPLES
180
181 The following example moves the volume C<user.smith> from the F</vicepb>
182 partition on the file server machine C<fs3.abc.com> to the F</vicepg>
183 partition on the file server machine C<fs7.abc.com>.
184
185    % vos move -id user.smith -fromserver fs3.abc.com -frompartition b \
186        -toserver fs7.abc.com -topartition g
187
188 =head1 PRIVILEGE REQUIRED
189
190 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
191 machines specified with the B<-toserver> and B<-fromserver> arguments and
192 on each database server machine.  If the B<-localauth> flag is included,
193 the issuer must instead be logged on to a server machine as the local
194 superuser C<root>.
195
196 =head1 SEE ALSO
197
198 L<vos(1)>,
199 L<vos_addsite(1)>,
200 L<vos_backup(1)>,
201 L<vos_copy(1)>,
202 L<vos_release(1)>,
203 L<vos_listvol(1)>,
204 L<vos_remove(1)>
205
206 =head1 COPYRIGHT
207
208 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
209
210 This documentation is covered by the IBM Public License Version 1.0.  It was
211 converted from HTML to POD by software written by Chas Williams and Russ
212 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.