doc/man-pages/pod/bos_setcellname.pod

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