doc/man-pages/pod8/bos_setcellname.pod

   1 =head1 NAME
   2
   3 bos_setcellname - Sets the cell's name in ThisCell and CellServDB
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<bos setcellname> S<<< B<-server> <I<machine name>> >>> S<<< B<-name> <I<cell name>> >>>
  11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-help>]
  12
  13 B<bos setc> S<<< B<-s> <I<machine name>> >>> S<<< B<-n> <I<cell name>> >>>
  14     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [-h]
  15
  16 =for html
  17 </div>
  18
  19 =head1 DESCRIPTION
  20
  21 The B<bos setcellname> command establishes the cell's name and makes the
  22 server machine named by the B<-server> argument a member of it, by
  23 recording the value of the B<-name> argument in two files which it creates
  24 on the local disk:
  25
  26 =over 4
  27
  28 =item *
  29
  30 F</usr/afs/etc/ThisCell>
  31
  32 =item *
  33
  34 F</usr/afs/etc/CellServDB>. The cell name appears on the first line in the
  35 file, preceded by the required C<< > >> symbol.  The machine name
  36 specified with the B<-server> argument appears on the second line along
  37 with its IP address as obtained from the cell's naming service. The
  38 machine is thus designated as the cell's first database server machine.
  39
  40 =back
  41
  42 =head1 CAUTIONS
  43
  44 Issue this command only when the installing the cell's first AFS server
  45 machine. The I<OpenAFS Quick Start Guide> explains how to copy over the
  46 F<ThisCell> and F<CellServDB> files from this or another appropriate
  47 machine during installation of additional server machines.
  48
  49 Be sure to choose a satisfactory cell name when issuing this command,
  50 because changing a cell's name is very complicated; for one thing, it
  51 requires changing every password in the Authentication Database.  Consult
  52 the I<OpenAFS Administration Guide> for advice on choosing a cell name.
  53
  54 =head1 OPTIONS
  55
  56 =over 4
  57
  58 =item B<-server> <I<machine name>>
  59
  60 Indicates the server machine on which to set the cell name in the
  61 F<ThisCell> and F<CellServDB> file. It is always the first machine
  62 installed in a cell. Identify the machine by IP address or its host name
  63 (either fully-qualified or abbreviated unambiguously).  For details, see
  64 L<bos(8)>.
  65
  66 =item B<-name> <I<cell name>>
  67
  68 Defines the cell name, using standard Internet domain name format (the
  69 actual domain name is usually appropriate). Examples are C<example.com> for
  70 the Example Corporation and C<example.org> for the Example Organization. It must
  71 match the value of the B<-cell> argument, if that is provided.
  72
  73 =item B<-cell> <I<cell name>>
  74
  75 Names the cell in which to run the command. Do not combine this argument
  76 with the B<-localauth> flag. For more details, see L<bos(8)>.
  77
  78 =item B<-noauth>
  79
  80 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
  81 combine this flag with the B<-localauth> flag. For more details, see
  82 L<bos(8)>.
  83
  84 =item B<-localauth>
  85
  86 Constructs a server ticket using a key from the local
  87 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
  88 The B<bos> command interpreter presents the
  89 ticket to the BOS Server during mutual authentication. Do not combine this
  90 flag with the B<-cell> or B<-noauth> options. For more details, see
  91 L<bos(8)>.
  92
  93 =item B<-help>
  94
  95 Prints the online help for this command. All other valid options are
  96 ignored.
  97
  98 =back
  99
 100 =head1 EXAMPLES
 101
 102 The following command defines the cell name C<example.com> in the F<ThisCell>
 103 and F<CellServDB> files on the machine C<fs1.example.com> as it is installed
 104 as the cell's first server machine.
 105
 106    % bos setcellname -server fs1.example.com -name example.com
 107
 108 =head1 PRIVILEGE REQUIRED
 109
 110 Authorization checking is normally turned off during installation, which
 111 is the only recommended time to use this command; in this case no
 112 privilege is required. If authorization checking is turned on, the issuer
 113 must be listed in the F</usr/afs/etc/UserList> file on the machine named
 114 by the B<-server> argument, or must be logged in as the local superuser
 115 C<root> if the B<-localauth> flag is included.
 116
 117 =head1 SEE ALSO
 118
 119 L<CellServDB(5)>,
 120 L<KeyFile(5)>,
 121 L<KeyFileExt(5)>,
 122 L<ThisCell(5)>,
 123 L<UserList(5)>,
 124 L<bos(8)>
 125
 126 The I<OpenAFS Quick Start Guide> at
 127 L<http://docs.openafs.org/QuickStartUnix/>.
 128
 129 The I<OpenAFS Administration Guide> at
 130 L<http://docs.openafs.org/AdminGuide/>.
 131
 132 =head1 COPYRIGHT
 133
 134 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 135
 136 This documentation is covered by the IBM Public License Version 1.0.  It was
 137 converted from HTML to POD by software written by Chas Williams and Russ
 138 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.