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