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