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