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