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