Document KeyFileExt(5)
[openafs.git] / doc / man-pages / pod8 / bos_delete.pod
1 =head1 NAME
2
3 bos_delete - Deletes a server process from the BosConfig file
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<bos delete> S<<< B<-server> <I<machine name>> >>>
11     S<<< B<-instance> <I<server process name>>+ >>> S<<< [B<-cell> <I<cell name>>] >>>
12     [B<-noauth>] [B<-localauth>] [B<-help>]
13
14 B<bos d> S<<< B<-s> <I<machine name>> >>> S<<< B<-i> <I<server process name>>+ >>>
15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<bos delete> command removes the F</usr/afs/local/BosConfig> entry
23 for each process indicated by the B<-instance> argument, on the server
24 machine named by the B<-server> argument.
25
26 Before issuing this command, issue the bos stop command to stop the
27 process and set its status flag in the F<BosConfig> file to C<NotRun>. The
28 B<bos delete> command fails with an error message if a process's status
29 flag is C<Run>.
30
31 =head1 OPTIONS
32
33 =over 4
34
35 =item B<-server> <I<machine name>>
36
37 Indicates the server machine on which to delete the server process entry
38 from the F</usr/afs/local/BosConfig> file. Identify the machine
39 by IP address or its host name (either fully-qualified or abbreviated
40 unambiguously). For details, see L<bos(8)>.
41
42 =item B<-instance> <I<server process name>>+
43
44 Names each process to delete. Use the name assigned with the B<-instance>
45 argument to the B<bos create> command; process names appear in the output
46 of the B<bos status> command.
47
48 =item B<-cell> <I<cell name>>
49
50 Names the cell in which to run the command. Do not combine this argument
51 with the B<-localauth> flag. For more details, see L<bos(8)>.
52
53 =item B<-noauth>
54
55 Assigns the unprivileged identity C<anonymous> to the issuer. Do not
56 combine this flag with the B<-localauth> flag. For more details, see
57 L<bos(8)>.
58
59 =item B<-localauth>
60
61 Constructs a server ticket using a key from the local
62 F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt> file.
63 The B<bos> command interpreter presents the
64 ticket to the BOS Server during mutual authentication. Do not combine this
65 flag with the B<-cell> or B<-noauth> options. For more details, see
66 L<bos(8)>.
67
68 =item B<-help>
69
70 Prints the online help for this command. All other valid options are
71 ignored.
72
73 =back
74
75 =head1 EXAMPLES
76
77 The following command removes the B<buserver>, B<kaserver>, B<ptserver>,
78 and B<vlserver> entries from the F<BosConfig> file on C<db3.example.com>, a
79 database server machine being decommissioned.
80
81    % bos delete -server db3.example.com \
82        -instance buserver kaserver ptserver vlserver
83
84 =head1 PRIVILEGE REQUIRED
85
86 The issuer must be listed in the F</usr/afs/etc/UserList> file on the
87 machine named by the B<-server> argument, or must be logged onto a server
88 machine as the local superuser C<root> if the B<-localauth> flag is
89 included.
90
91 The B<bos delete> command cannot be run against servers which are in
92 restricted mode.
93
94 =head1 SEE ALSO
95
96 L<BosConfig(5)>,
97 L<KeyFile(5)>,
98 L<KeyFileExt(5)>,
99 L<UserList(5)>,
100 L<bos(8)>,
101 L<bos_create(8)>,
102 L<bos_status(8)>
103
104 =head1 COPYRIGHT
105
106 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
107
108 This documentation is covered by the IBM Public License Version 1.0.  It was
109 converted from HTML to POD by software written by Chas Williams and Russ
110 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.