man-page-fs-updates-20070817
[openafs.git] / doc / man-pages / pod8 / backup_delhost.pod
1 =head1 NAME
2
3 backup delhost - Deletes a Tape Coordinator entry from the Backup Database
4
5 =head1 SYNOPSIS
6
7 =for html
8 <div class="synopsis">
9
10 B<backup delhost> S<<< B<-tapehost> <I<tape machine name>> >>>
11     S<<< [B<-portoffset> <I<TC port offset>>] >>> [B<-localauth>]
12     S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
13
14 B<backup delh> S<<< B<-t> <I<tape machine name>> >>> S<<< [B<-p> <I<TC port offset>>] >>>
15     [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
16
17 =for html
18 </div>
19
20 =head1 DESCRIPTION
21
22 The B<backup delhost> command deletes the indicated Tape Coordinator entry
23 from the Backup Database. It is then impossible to submit backup
24 operations to that Tape Coordinator, even if it is still running. To keep
25 configuration information consistent, also remove the corresponding entry
26 from the F</usr/afs/backup/tapeconfig> file on the Tape Coordinator
27 machine.
28
29 To list the Tape Coordinator machines and port offsets defined in the
30 Backup Database, issue the B<backup listhosts> command.
31
32 =head1 OPTIONS
33
34 =over 4
35
36 =item B<-tapehost> <I<tape machine name>>
37
38 Specifies the hostname of the machine housing the Tape Coordinator to
39 delete.
40
41 =item B<-portoffset> <I<TC port offset>>
42
43 Specifies the port offset number of the Tape Coordinator to delete.  If
44 omitted, it defaults to C<0>. If provided, it is an integer between C<0>
45 (zero) and C<58510>, and must match the port offset number assigned to the
46 same combination of Tape Coordinator and tape device or file in the
47 F</usr/afs/backup/tapeconfig> file on the Tape Coordinator machine
48 indicated by the B<-tapehost> argument.
49
50 =item B<-localauth>
51
52 Constructs a server ticket using a key from the local
53 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
54 it to the Backup Server, Volume Server and VL Server during mutual
55 authentication. Do not combine this flag with the B<-cell> argument. For
56 more details, see L<backup(8)>.
57
58 =item B<-cell> <I<cell name>>
59
60 Names the cell in which to run the command. Do not combine this argument
61 with the B<-localauth> flag. For more details, see L<backup(8)>.
62
63 =item B<-help>
64
65 Prints the online help for this command. All other valid options are
66 ignored.
67
68 =back
69
70 =head1 EXAMPLES
71
72 The following command deletes the Backup Database entry for the Tape
73 Coordinator with port offset 2 on the Tape Coordinator machine
74 C<backup3.abc.com>:
75
76    % backup delhost -tapehost backup3.abc.com -portoffset 2
77
78 =head1 PRIVILEGE REQUIRED
79
80 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
81 machine where the Backup Server is running, or must be logged onto a
82 server machine as the local superuser C<root> if the B<-localauth> flag is
83 included.
84
85 =head1 SEE ALSO
86
87 L<backup(8)>,
88 L<backup_addhost(8)>,
89 L<backup_listhosts(8)>
90
91 =head1 COPYRIGHT
92
93 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
94
95 This documentation is covered by the IBM Public License Version 1.0.  It was
96 converted from HTML to POD by software written by Chas Williams and Russ
97 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.