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