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