f842843e6487cbf5712f7ec66eb8c09659fba7ae
[openafs.git] / doc / man-pages / pod / 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 backup delhost B<-tapehost> I<tape machine name> [B<-portoffset> I<TC port offset>]
8 [B<-localauth>]  [B<-cell> I<cell name>]  [B<-help>]
9
10 backup delh B<-t> I<tape machine name>  [B<-p> I<TC port offset>]
11 [B<-l>]  [B<-c> I<cell name>]  [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The C<backup delhost> command deletes the indicated Tape Coordinator
16 entry from the Backup Database. It is then impossible to submit backup
17 operations to that Tape Coordinator, even if it is still running. To
18 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 C<backup listhosts> command.
24
25 =head1 OPTIONS
26
27 =over 4
28
29 =item B<-tapehost> I<tape machine name>
30
31 Specifies the hostname of the machine housing the Tape
32 Coordinator to delete.
33
34 =item B<-portoffset> I<TC port offset>
35
36 Specifies the port offset number of the Tape Coordinator to
37 delete. If omitted, it defaults to B<0>. If provided, it is an
38 integer between B<0> (zero) and B<58510>, and must match the port
39 offset number assigned to the same combination of Tape
40 Coordinator and tape device or file in the
41 B</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 B</usr/afs/etc/KeyFile> file. The C<backup> command interpreter
48 presents it to the Backup Server, Volume Server and VL Server
49 during mutual authentication. Do not combine this flag with the
50 B<-cell> argument. For more details, see the introductory L<backup(1)> reference page.
51
52 =item B<-cell> I<cell name>
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 L<backup(1)> reference page.
57
58 =item B<-help>
59
60 Prints the online help for this command. All other valid
61 options 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 B</usr/afs/etc/UserList> file on every
76 machine where the Backup Server is running, or must be logged onto a
77 server machine as the local superuser B<root> if the B<-localauth> flag is
78 included.
79
80 =head1 COPYRIGHT
81
82 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
83
84 Converted from html to pod by Alf Wachsmann <alfw@slac.stanford.edu>, 2003,
85 Stanford Linear Accelerator Center, a department of Stanford University.
86
87 =head1 SEE ALSO
88
89 L<backup(1)>,
90 L<backup_addhost(1)>,
91 L<backup_listhosts(1)>
92
93 =cut