xml-docbook-documentation-first-pass-20060915
[openafs.git] / doc / xml / AdminReference / sect1 / vos_move.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="vos_move1">
3   <refmeta>
4     <refentrytitle>vos move</refentrytitle>
5     <manvolnum>1</manvolnum>
6   </refmeta>
7   <refnamediv>
8     <refname>vos move</refname>
9     <refpurpose>Moves a read/write volume to another site</refpurpose>
10   </refnamediv>
11   <refsect1>
12     <title>Synopsis</title>
13     <para><emphasis role="bold">vos move</emphasis> <emphasis role="bold">-id</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;
14         <emphasis role="bold">-fromserver</emphasis> &lt;<emphasis>machine name on source</emphasis>&gt;
15         <emphasis role="bold">-frompartition</emphasis> &lt;<emphasis>partition name on source</emphasis>&gt;
16         <emphasis role="bold">-toserver</emphasis> &lt;<emphasis>machine name on destination</emphasis>&gt;
17         <emphasis role="bold">-topartition</emphasis> &lt;<emphasis>partition name on destination</emphasis>&gt;
18         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>]
19         [<emphasis role="bold">-help</emphasis>]</para>
20
21     <para><emphasis role="bold">vos m -i</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;
22         <emphasis role="bold">-froms</emphasis> &lt;<emphasis>machine name on source</emphasis>&gt;
23         <emphasis role="bold">-fromp</emphasis> &lt;<emphasis>partition name on source</emphasis>&gt;
24         <emphasis role="bold">-tos</emphasis> &lt;<emphasis>machine name on destination</emphasis>&gt;
25         <emphasis role="bold">-top</emphasis> &lt;<emphasis>partition name on destination</emphasis>&gt;
26         [-c &lt;<emphasis>cell name</emphasis>&gt;] [<emphasis role="bold">-n</emphasis>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
27
28   </refsect1>
29   <refsect1>
30     <title>Description</title>
31     <para>The <emphasis role="bold">vos move</emphasis> command moves the indicated read/write volume from its
32     current site (specified with the <emphasis role="bold">-fromserver</emphasis> and <emphasis role="bold">-frompartition</emphasis>
33     arguments) to the destination site (specified with the <emphasis role="bold">-toserver</emphasis> and
34     <emphasis role="bold">-topartition</emphasis> 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 <emphasis role="bold">vos backup</emphasis> command.</para>
37
38     <para>This command works on read/write volumes only. To move a read-only volume,
39     use the <emphasis role="bold">vos addsite</emphasis> and <emphasis role="bold">vos release</emphasis> commands to define a new
40     read-only site and release the volume contents to it, and then use the
41     <emphasis role="bold">vos remove</emphasis> 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 <emphasis role="bold">vos backup</emphasis> command.</para>
45
46     <para>Before executing this command, the <emphasis role="bold">vos</emphasis> 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:</para>
50
51 <programlisting>
52    vos: no space on target partition &amp;lt;dest_part&amp;gt; to move volume &amp;lt;volume&amp;gt;
53
54 </programlisting>
55     </refsect1>
56     <refsect1>
57       <title>Cautions</title>
58       <para>Unless there is a compelling reason, do not interrupt a <emphasis role="bold">vos move</emphasis>
59       command in progress. Interrupting a move can result in one or more of the
60       following inconsistent states:</para>
61
62       <itemizedlist>
63         <listitem>
64           <para>There are two versions of the volume, one at the source site and one at
65           the destination site. (If this happens, retain the version identified by
66           the VLDB and use the <emphasis role="bold">vos zap</emphasis> command to remove the other version.)</para>
67
68         </listitem>
69         <listitem>
70           <para>The backup version of the volume is stranded at the old site. (If this
71           happens, use the <emphasis role="bold">vos zap</emphasis> command to remove it.)</para>
72
73         </listitem>
74         <listitem>
75           <para>The volume is off-line. (If this happens, run the <emphasis role="bold">bos salvage</emphasis> command
76           to bring it back on line.)</para>
77
78         </listitem>
79       </itemizedlist>
80       <para>If the Ctrl-C interrupt signal is pressed while a vos move operation is
81       executing, the following message warns of the consequences and requests
82       confirmation of the kill signal:</para>
83
84 <programlisting>
85    SIGINT handler: vos move operation in progress
86    WARNING: may leave AFS storage and metadata in indeterminate state
87    enter second control-c to exit
88
89 </programlisting>
90         <para>To confirm termination of the operation, press Ctrl-C a second time; press
91         any other key to continue the operation.</para>
92
93       </refsect1>
94       <refsect1>
95         <title>Options</title>
96         <variablelist>
97           <varlistentry>
98             <term><emphasis role="bold">-id</emphasis> &lt;<emphasis>volume name or ID</emphasis>&gt;</term>
99             <listitem>
100               <para>Specifies either the complete name or volume ID number of a read/write
101               volume.</para>
102
103             </listitem>
104           </varlistentry>
105           <varlistentry>
106             <term><emphasis role="bold">-fromserver</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
107             <listitem>
108               <para>Identifies the file server machine where the volume currently
109               resides. Provide the machine's IP address or its host name (either fully
110               qualified or using an unambiguous abbreviation). For details, see
111               <link linkend="vos1">vos(1)</link>.</para>
112
113             </listitem>
114           </varlistentry>
115           <varlistentry>
116             <term><emphasis role="bold">-frompartition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;</term>
117             <listitem>
118               <para>Names the partition where the volume currently resides. Provide the full
119               partition name (for, example, <emphasis role="bold">/vicepa</emphasis>) or one of the abbreviated forms
120               described in <link linkend="vos1">vos(1)</link>.</para>
121
122             </listitem>
123           </varlistentry>
124           <varlistentry>
125             <term><emphasis role="bold">-toserver</emphasis> &lt;<emphasis>server name</emphasis>&gt;</term>
126             <listitem>
127               <para>Identifies the file server machine to which to move the volume.  Provide
128               the machine's IP address or its host name (either fully qualified or using
129               an unambiguous abbreviation). For details, see <link linkend="vos1">vos(1)</link>.</para>
130
131             </listitem>
132           </varlistentry>
133           <varlistentry>
134             <term><emphasis role="bold">-topartition</emphasis> &lt;<emphasis>partition name</emphasis>&gt;</term>
135             <listitem>
136               <para>Names the partition to which to move the volume. Provide the full
137               partition name (for, example, <emphasis role="bold">/vicepa</emphasis>) or one of the abbreviated forms
138               described in <link linkend="vos1">vos(1)</link>.</para>
139
140             </listitem>
141           </varlistentry>
142           <varlistentry>
143             <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
144             <listitem>
145               <para>Names the cell in which to run the command. Do not combine this argument
146               with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
147
148             </listitem>
149           </varlistentry>
150           <varlistentry>
151             <term><emphasis role="bold">-noauth</emphasis></term>
152             <listitem>
153               <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
154               combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
155               <link linkend="vos1">vos(1)</link>.</para>
156
157             </listitem>
158           </varlistentry>
159           <varlistentry>
160             <term><emphasis role="bold">-localauth</emphasis></term>
161             <listitem>
162               <para>Constructs a server ticket using a key from the local
163               <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
164               to the Volume Server and Volume Location Server during mutual
165               authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
166               <emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
167
168             </listitem>
169           </varlistentry>
170           <varlistentry>
171             <term><emphasis role="bold">-verbose</emphasis></term>
172             <listitem>
173               <para>Produces on the standard output stream a detailed trace of the command's
174               execution. If this argument is omitted, only warnings and error messages
175               appear.</para>
176
177             </listitem>
178           </varlistentry>
179           <varlistentry>
180             <term><emphasis role="bold">-help</emphasis></term>
181             <listitem>
182               <para>Prints the online help for this command. All other valid options are
183               ignored.</para>
184
185             </listitem>
186           </varlistentry>
187         </variablelist>
188       </refsect1>
189       <refsect1>
190         <title>Examples</title>
191         <para>The following example moves the volume <computeroutput>user.smith</computeroutput> from the <replaceable>/vicepb</replaceable>
192         partition on the file server machine <computeroutput>fs3.abc.com</computeroutput> to the <replaceable>/vicepg</replaceable>
193         partition on the file server machine <computeroutput>fs7.abc.com</computeroutput>.</para>
194
195 <programlisting>
196    % vos move -id user.smith -fromserver fs3.abc.com -frompartition b \
197        -toserver fs7.abc.com -topartition g
198
199 </programlisting>
200         </refsect1>
201         <refsect1>
202           <title>Privilege Required</title>
203           <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
204           machines specified with the <emphasis role="bold">-toserver</emphasis> and <emphasis role="bold">-fromserver</emphasis> arguments and
205           on each database server machine.  If the <emphasis role="bold">-localauth</emphasis> flag is included,
206           the issuer must instead be logged on to a server machine as the local
207           superuser <computeroutput>root</computeroutput>.</para>
208
209         </refsect1>
210         <refsect1>
211           <title>See Also</title>
212           <para><link linkend="vos1">vos(1)</link>,
213           <link linkend="vos_addsite1">vos_addsite(1)</link>,
214           <link linkend="vos_backup1">vos_backup(1)</link>,
215           <link linkend="vos_release1">vos_release(1)</link>,
216           <link linkend="vos_listvol1">vos_listvol(1)</link>,
217           <link linkend="vos_remove1">vos_remove(1)</link></para>
218
219         </refsect1>
220         <refsect1>
221           <title>Copyright</title>
222           <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
223
224           <para>This documentation is covered by the IBM Public License Version 1.0.  It was
225           converted from HTML to POD by software written by Chas Williams and Russ
226           Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
227
228         </refsect1>
229       </refentry>