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