doc/man-pages/pod8/bos_addhost.pod

   1 =head1 NAME
   2
   3 bos_addhost - Adds a database server machine to the CellServDB file
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<bos addhost> S<<< B<-server> <I<machine name>> >>> S<<< B<-host> <I<host name>>+ >>>
  11     S<<< [B<-cell> <I<cell name>>] >>> [B<-clone>] [B<-noauth>] [B<-localauth>] [B<-help>]
  12
  13 B<bos addh> S<<< B<-s> <I<machine name>> >>> S<<< B<-ho> <I<host name>>+ >>>
  14     S<<< [B<-ce> <I<cell name>>] >>> [B<-cl>] [B<-n>] [B<-l>] [B<-he>]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<bos addhost> command adds an entry for each database server machine
  22 specified with the B<-host> argument to the F</usr/afs/etc/CellServDB>
  23 file on the machine named by the B<-server> argument.
  24
  25 =head1 CAUTIONS
  26
  27 After executing this command (and waiting for the Update Server to
  28 propagate the changes, if it is used), restart the database server
  29 processes on all database server machines to force election of a quorum
  30 that includes the new set of machines listed in the
  31 F</usr/afs/etc/CellServDB> file. The I<OpenAFS Quick Start Guide> explains
  32 in more detail how to add and remove database server machines.
  33
  34 It is best to maintain a one-to-one mapping between hostnames and IP
  35 addresses on a multihomed database server machine (this is actually the
  36 conventional configuration for any AFS machine). The BOS Server uses the
  37 gethostbyname() routine to obtain the IP address associated with the
  38 hostname specified by the B<-host> argument. If there is more than one
  39 address, the BOS Server records in the F<CellServDB> entry the one that
  40 appears first in the list of addresses returned by the routine. The
  41 routine possibly returns addresses in a different order on different
  42 machines, which can create inconsistency.
  43
  44 =head1 OPTIONS
  45
  46 =over 4
  47
  48 =item B<-server> <I<machine name>>
  49
  50 Identifies the server machine on which to change the
  51 F</usr/afs/etc/CellServDB> file. Identify the machine by IP address or its
  52 host name (either fully-qualified or abbreviated unambiguously). For
  53 details, see L<bos(8)>.
  54
  55 In cells that use the Update Server to distribute the contents of the
  56 F</usr/afs/etc> directory, it is conventional to specify only the system
  57 control machine as a value for the B<-server> argument. Otherwise, repeat
  58 the command for each file server machine. For further discussion, see
  59 L<bos(8)>.
  60
  61 =item B<-host> <I<host name>>+
  62
  63 Specifies the fully-qualified host name (such as C<db1.example.com>) of each
  64 database server machine to register in the F<CellServDB> file.
  65
  66 =item B<-cell> <I<cell name>>
  67
  68 Names the cell in which to run the command. Do not combine this
  69 argument with the B<-localauth> flag. For more details, see L<bos(8)>.
  70
  71 =item B<-clone>
  72
  73 Register the host given by B<-host> as a non-voting clone site, which
  74 prevents the host from becoming a sync-site. This is an advanced feature
  75 and should be used with caution.
  76
  77 =item B<-noauth>
  78
  79 Assigns the unprivileged identity C<anonymous> to the issuer. Do not combine
  80 this flag with the B<-localauth> flag. For more details, see L<bos(8)>.
  81
  82 =item B<-localauth>
  83
  84 Constructs a server ticket using a key from the local
  85 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
  86 The B<bos> command interpreter presents the
  87 ticket to the BOS Server during mutual authentication. Do not combine this
  88 flag with the B<-cell> or B<-noauth> options. For more details, see
  89 L<bos(8)>.
  90
  91 =item B<-help>
  92
  93 Prints the online help for this command. All other valid options are
  94 ignored.
  95
  96 =back
  97
  98 =head1 EXAMPLES
  99
 100 The following command adds the database server machines C<db2.example.com> and
 101 C<db3.example.com> to the F</usr/afs/etc/CellServDB> file on the machine
 102 C<fs1.example.com> (the system control machine).
 103
 104    % bos addhost -server fs1.example.com -host db2.example.com db3.example.com
 105
 106 =head1 PRIVILEGE REQUIRED
 107
 108 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
 109 machine named by the B<-server> argument, or must be logged onto a server
 110 machine as the local superuser C<root> if the B<-localauth> flag is
 111 included.
 112
 113 =head1 SEE ALSO
 114
 115 L<CellServDB(5)>,
 116 L<KeyFile(5)>,
 117 L<KeyFileExt(5)>,
 118 L<UserList(5)>,
 119 L<bos(8)>,
 120 L<bos_listhosts(8)>,
 121 L<bos_removehost(8)>
 122
 123 The I<OpenAFS Quick Start Guide> at
 124 L<http://docs.openafs.org/QuickStartUnix/>.
 125
 126 =head1 COPYRIGHT
 127
 128 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 129
 130 This documentation is covered by the IBM Public License Version 1.0.  It was
 131 converted from HTML to POD by software written by Chas Williams and Russ
 132 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.