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