Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / vos_changeloc.pod.in
... / ...
CommitLineData
1=head1 NAME
2
3vos_changeloc - Change a volume's entry in the VLDB
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<vos changeloc> S<<< [B<-server>] <I<new server name>> >>>
11 S<<< [B<-partition>] <I<new partition location>> >>>
12 S<<< [B<-id>] <I<volume name or ID>> >>>
13 S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
14 [B<-verbose>] [B<-encrypt>] [B<-noresolve>]
15 S<<< [B<-config> <I<config directory>>] >>>
16 [B<-help>]
17
18B<vos changel> S<<< [B<-s>] <I<new server name>> >>>
19 S<<< [B<-p>] <I<new partition location>> >>>
20 S<<< [B<-i>] <I<volume name or ID>> >>>
21 S<<< [B<-c> <I<cell name>>] >>>
22 [B<-noa>] [B<-l>] [B<-v>] [B<-e>] [B<-nor>]
23 S<<< [B<-co> <I<config directory>>] >>>
24 [B<-h>]
25
26=for html
27</div>
28
29=head1 DESCRIPTION
30
31The B<vos changeloc> command changes the location of a volume in the
32Volume Location Database (VLDB) without needing to contact the original
33file server on which the volume was hosted. This is useful when a file
34server has gone down permanently and the data that was stored on that
35server has been moved to a new file server with a different name and IP
36address (perhaps by mounting the same /vicepX partitions on a different
37host). After moving the data and running B<vos changeloc>, run B<vos
38syncvldb> and then B<vos syncserv> against the new server to ensure full
39synchronization of the VLDB with the file server.
40
41In essence, B<vos changeloc> performs the same operations on the VLDB as
42B<vos move>, but it does NOT move the data from one server's file system
43to another.
44
45=head1 CAUTIONS
46
47Using B<vos changeloc> changes the VLDB without modifying the file server
48data, so it inherently causes the VLDB to be out of sync with the data on
49the servers. It should only be used when recovering from server failure.
50If the servers are on-line, B<vos move> should be used instead. It is
51highly recommended that B<vos syncvldb> and B<vos syncserv> be run after
52using the B<vos changeloc> command to ensure properly synchronization of
53the VLDB with the file servers.
54
55=head1 OPTIONS
56
57B<vos changeloc> takes the following options:
58
59=over 4
60
61=item B<-server> <I<new server name>>
62
63Specifies the new server where the VLDB should believe the volume resides.
64Provide the machine's IP address or its host name (either fully qualified
65or using an unambiguous abbreviation). For details, see L<vos(1)>.
66
67=item B<-partition> <I<partition name>>
68
69Specifies the partition where the VLDB should believe the volume resides.
70Provide the B<-server> argument along with this one. Provide the
71partition's complete name with preceding slash (for example, C</vicepa>)
72or use one of the three acceptable abbreviated forms. For details, see
73L<vos(1)>.
74
75=item B<-id> <I<volume name or ID>>
76
77Specifies the name or volume ID number on which to operate.
78
79=include fragments/vos-common.pod
80
81=back
82
83=head1 OUTPUT
84
85B<vos changeloc> shows a brief message upon completion:
86
87 Changed location to server2 /vicepa for volume user.jdoe
88
89=head1 EXAMPLES
90
91The following command changes the location of the C<user.jdoe> volume to
92be F</vicepa> on the file server machine C<server2> while being verbose:
93
94 % vos changeloc server2 a user.jdoe -verbose
95 done
96 Changed location to server2 /vicepa for volume user.jdoe
97
98The following command changes the location of the C<user.jdoe> volume to
99be F</vicepa> on C<server1> without being verbose:
100
101 % vos changeloc server1 a user.jdoe
102 Changed location to server1 /vicepa for volume user.jdoe
103
104=head1 PRIVILEGE REQUIRED
105
106The issuer must be listed in the F</usr/afs/etc/UserList> file on each
107database server machine. If the B<-localauth> flag is included, the issuer
108must instead be logged on to a server machine as the local superuser
109C<root>.
110
111=head1 SEE ALSO
112
113L<vos(1)>,
114L<vos_move(1)>,
115L<vos_syncserv(1)>,
116L<vos_syncvldb(1)>
117
118=head1 COPYRIGHT
119
120Copyright 2007 Jason Edgecombe <jason@rampaginggeek.com>
121
122This documentation is covered by the BSD License as written in the
123doc/LICENSE file. This man page was written by Jason Edgecombe for
124OpenAFS.