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