man-page-license-change-20071225
[openafs.git] / doc / man-pages / pod1 / vos_changeaddr.pod
1 =head1 NAME
2
3 vos_changeaddr - Changes or removes a file server machine's entry in the VLDB
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<vos changeaddr> S<<< B<-oldaddr> <I<original IP address>> >>>
11     S<<< [B<-newaddr> <I<new IP address>>] >>> [B<-remove>]
12     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>]
13     [B<-verbose>] [B<-help>]
14
15 B<vos ch> S<<< B<-o> <I<original IP address>> >>> S<<< [B<-ne> <I<new IP address>>] >>>
16     [B<-r>] S<<< [B<-c> <I<cell name>>] >>> [B<-no>] [B<-l>] [B<-v>] [B<-h>]
17
18 =for html
19 </div>
20
21 =head1 DESCRIPTION
22
23 The B<vos changeaddr> command removes a server entry from the Volume
24 Location Database (VLDB) when the B<-remove> flag is combined with the
25 B<-oldaddr> argument. There must be no VLDB entries that list the machine
26 as a site for any version of a volume (if necessary, use the B<vos move>
27 or B<vos remove> command to more or remove volumes). It is appropriate to
28 remove a VLDB server entry when removing the corresponding file server
29 machine from service; this is the only recommended use of the command.
30
31 To display all VLDB server entries, use the B<vos listaddrs> command.
32
33 =head1 CAUTIONS
34
35 Combining the command's B<-oldaddr> and B<-newaddr> arguments is no longer
36 the appropriate way to change the IP address registered for a file server
37 machine. Furthermore, if a machine is multihomed and its server entry
38 includes several addresses, then the address specified with the
39 B<-newaddr> argument replaces all of the addresses currently listed in the
40 server entry that includes the address specified by the B<-oldaddr>
41 argument. This effectively makes the machine single-homed with respect to
42 AFS operations, which is probably not the desired result.
43
44 The recommended method for changing the IP addresses in a server entry is
45 instead to restart the C<fs> process group (which includes the File
46 Server) after using the utilities provided by the operating system to
47 reconfigure the machine's network interfaces. For a description of how the
48 File Server constructs and registers a list of its network interfaces in
49 the VLDB, see L<sysid(5)>.
50
51 If, counter to recommended usage, the command is used to change the IP
52 address in a server entry, it does not also change the names of machine
53 entries in the Protection Database. Operations fail when they refer to a
54 protection group that has an obsolete IP address in it. Use the B<pts
55 rename> command to change the names of machine entries that correspond to
56 the addresses changed with this command. Changing the address of a
57 database server machine also requires updating the client and server
58 versions of the F<CellServDB> file on every machine.
59
60 =head1 OPTIONS
61
62 =over 4
63
64 =item B<-oldaddr> <I<original IP address>>
65
66 Specifies the IP address currently registered for the file server machine
67 in the VLDB server entry. If there are multiple addresses registered for a
68 multihomed machine, use any of them to identify the server entry.
69
70 =item B<-newaddr> <I<new IP address>>
71
72 Specifies the new IP address that replaces all currently registered
73 addresses.
74
75 =item B<-remove>
76
77 Removes from the VLDB the server entry that includes the address specified
78 by the B<-oldaddr> argument.
79
80 =item B<-cell> <I<cell name>>
81
82 Names the cell in which to run the command. Do not combine this argument
83 with the B<-localauth> flag. For more details, see L<vos(1)>.
84
85 =item B<-noauth>
86
87 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
88 combine this flag with the B<-localauth> flag. For more details, see
89 L<vos(1)>.
90
91 =item B<-localauth>
92
93 Constructs a server ticket using a key from the local
94 F</usr/afs/etc/KeyFile> file. The B<vos> command interpreter presents it
95 to the Volume Server and Volume Location Server during mutual
96 authentication. Do not combine this flag with the B<-cell> argument or
97 B<-noauth> flag. For more details, see L<vos(1)>.
98
99 =item B<-verbose>
100
101 Produces on the standard output stream a detailed trace of the command's
102 execution. If this argument is omitted, only warnings and error messages
103 appear.
104
105 =item B<-help>
106
107 Prints the online help for this command. All other valid options are
108 ignored.
109
110 =back
111
112 =head1 EXAMPLES
113
114 The following command removes the VLDB server entry that includes the IP
115 address C<192.12.107.214>.
116
117    % vos changeaddr -oldaddr 192.12.107.214 -remove
118
119 =head1 PRIVILEGE REQUIRED
120
121 Issuer must be listed in the F</usr/afs/etc/UserList> file on the machine
122 specified with the B<-oldaddr> argument and on each database server
123 machine.
124
125 =head1 SEE ALSO
126
127 L<CellServDB(5)>,
128 L<UserList(5)>,
129 L<sysid(5)>,
130 L<fileserver(8)>,
131 L<pts_rename(1)>,
132 L<vos(1)>,
133 L<vos_listaddrs(1)>
134
135 =head1 COPYRIGHT
136
137 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
138
139 This documentation is covered by the IBM Public License Version 1.0.  It was
140 converted from HTML to POD by software written by Chas Williams and Russ
141 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.