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