man1-editing-pass-20051209
[openafs.git] / doc / man-pages / pod8 / bos_removehost.pod
1 =head1 NAME
2
3 bos removehost - Removes a database server machine from the
4 B</usr/afs/etc/CellServDB> file
5
6 =head1 SYNOPSIS
7
8 B<bos removehost -server> <I<machine name>>  -host <I<host name>>+ 
9 [B<-cell> <I<cell name>>]  [B<-noauth>]  [B<-localauth>]  [B<-help>]
10
11 B<bos removeh -s> <I<machine name>>  B<-ho> <I<host name>>+  [-c <I<cell name>>]  
12 [B<-n>]  [B<-l>]  [B<-he>]
13
14 =head1 DESCRIPTION
15
16 The bos removehost command removes the entry for each database
17 server machine specified with the B<-host> argument from the
18 B</usr/afs/etc/CellServDB> file on the server machine named by the
19 B<-server> argument.
20
21 =head1 CAUTIONS
22
23 After executing this command (and waiting for the Update Server to
24 propagate the changes, if it is used), restart the database server processes
25 on all database server machines to force election of a quorum that includes
26 the new set of machines listed in the B</usr/afs/etc/CellServDB>
27 file. The I<IBM AFS Quick Beginnings> explains in more detail
28 how to add and remove database server machines.
29
30 =head1 OPTIONS
31
32 =over 4
33
34 =item -server
35 >
36
37 Indicates the server machine on which to change the
38 B</usr/afs/etc/CellServDB> file. Identify the machine by IP
39 address or its host name (either fully-qualified or abbreviated
40 unambiguously). For details, see the introductory reference page for
41 the B<bos> command suite. 
42
43 In cells that run the United States edition of AFS and use the Update
44 Server to distribute the contents of the B</usr/afs/etc> directory, it
45 is conventional to specify only the system control machine as a value for the
46 B<-server> argument. In cells that run the international
47 version of AFS, repeat the command for each file server machine. For
48 further discussion, see the introductory reference page for the B<bos>
49 command suite.
50
51 =item -host
52 >
53
54 Specifies the fully-qualified host name (such as
55 B<fs2.abc.com>) of each database server machine to
56 remove from the B<CellServDB> file.
57
58 =item -cell
59 >
60
61 Names the cell in which to run the command. Do not combine this
62 argument with the B<-localauth> flag. For more details, see the
63 introductory B<bos> reference page.
64
65 =item -noauth
66 >
67
68 Assigns the unprivileged identity anonymous to the
69 issuer. Do not combine this flag with the B<-localauth>
70 flag. For more details, see the introductory B<bos> reference
71 page.
72
73 =item -localauth
74 >
75
76 Constructs a server ticket using a key from the local
77 B</usr/afs/etc/KeyFile> file. The B<bos> command
78 interpreter presents the ticket to the BOS Server during mutual
79 authentication. Do not combine this flag with the B<-cell> or
80 B<-noauth> options. For more details, see the introductory
81 B<bos> reference page.
82
83 =item -help
84
85 Prints the online help for this command. All other valid options
86 are ignored.
87
88 =back
89
90 =head1 EXAMPLES
91
92 The following command removes the former database server machine
93 B<db2.abc.com> from the B<CellServDB> file on
94 the system control machine B<fs1.abc.com>.
95
96    % bos removehost -server fs1.abc.com -host db2.abc.com
97
98 =head1 PRIVILEGE REQUIRED
99
100 The issuer must be listed in the /usr/afs/etc/UserList file on
101 the machine named by the B<-server> argument, or must be logged onto a
102 server machine as the local superuser B<root> if the
103 B<-localauth> flag is included.
104
105 =head1 SEE ALSO
106
107 L<KeyFile(1)>,
108 L<UserList(1)>,
109 L<bos(1)>,
110 L<bos_addhost(1)>,
111 L<bos_listhosts(1)>
112
113 I<IBM AFS Quick Beginnings>
114
115 =head1 COPYRIGHT
116
117 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
118
119 This documentation is covered by the IBM Public License Version 1.0.  It was
120 converted from HTML to POD by software written by Chas Williams and Russ
121 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.