man8-editing-pass-20051213
[openafs.git] / doc / man-pages / pod8 / backup_addhost.pod
1 =head1 NAME
2
3 backup addhost - Adds a Tape Coordinator entry to the Backup Database
4
5 =head1 SYNOPSIS
6
7 B<backup addhost> B<-tapehost> <I<tape machine name>>
8     [B<-portoffset> <I<TC port offset>>]
9     [B<-localauth>] [B<-cell> <I<cell name>>] [B<-help>]
10
11 B<backup addh> 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 addhost> command creates a Tape Coordinator entry in the
17 Backup Database. The entry records
18
19 =over 4
20
21 =item *
22
23 The host name of the Tape Coordinator machine where the Tape Coordinator
24 (B<butc>) process runs, as specified with the B<-tapehost> argument.
25
26 =item *
27
28 The Tape Coordinator's port offset number, as specified with the
29 B<-portoffset> argument. An entry for the port offset must also appear in
30 the F</usr/afs/backup/tapeconfig> file on the Tape Coordinator machine,
31 where it is mapped to a UNIX device name (for a tape device) or pathname
32 (for a backup data file).
33
34 =back
35
36 Each Tape Coordinator must have its own port offset number, and the
37 command fails if a Backup Database entry already exists for the requested
38 port offset number. To display existing Tape Coordinator entries, use the
39 B<backup listhosts> command.
40
41 =head1 OPTIONS
42
43 =over 4
44
45 =item B<-tapehost> <I<tape machine name>>
46
47 Specifies the fully-qualified hostname of the machine for which to create
48 a Tape Coordinator entry in the Backup Database. The machine must have an
49 entry in either the cell's naming service (such as the Domain Name
50 Service) or the host file (F</etc/hosts> or equivalent) on the machine
51 where the command is issued.
52
53 =item B<-portoffset> <I<TC port offset>>
54
55 Specifies the Tape Coordinator's port offset number. Provide an integer
56 from the range C<0> through C<58510>, or omit this argument to use the
57 default value of C<0> (zero). The value must match the port offset number
58 recorded for the same combination of Tape Coordinator and tape device or
59 file in the F</usr/afs/backup/tapeconfig> file on the Tape Coordinator
60 machine named by the B<-tapehost> argument.
61
62 =item B<-localauth>
63
64 Constructs a server ticket using a key from the local
65 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
66 it to the Backup Server, Volume Server and VL Server during mutual
67 authentication. Do not combine this flag with the B<-cell> argument. For
68 more details, see L<backup(8)>.
69
70 =item B<-cell> <I<cell name>>
71
72 Names the cell in which to run the command. Do not combine this argument
73 with the B<-localauth> flag. For more details, see L<backup(8)>.
74
75 =item B<-help>
76
77 Prints the online help for this command. All other valid options are
78 ignored.
79
80 =back
81
82 =head1 EXAMPLES
83
84 The following command creates an entry in the Backup Database that assigns
85 port offset number 4 to a Tape Coordinator running on the machine
86 C<backup1.abc.com>:
87
88    % backup addhost -tapehost backup1.abc.com -portoffset 4
89
90 The following command creates a Backup Database entry that assigns port
91 offset number 0 to a Tape Coordinator on the machine C<backup3.abc.com>:
92
93    % backup addhost backup3.abc.com
94
95 =head1 PRIVILEGE REQUIRED
96
97 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
98 machine where the Backup Server is running, or must be logged onto a
99 server machine as the local superuser C<root> if the B<-localauth> flag is
100 included.
101
102 =head1 SEE ALSO
103
104 L<backup(8)>,
105 L<backup_delhost(8)>,
106 L<backup_listhosts(8)>
107
108 =head1 COPYRIGHT
109
110 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
111
112 This documentation is covered by the IBM Public License Version 1.0.  It was
113 converted from HTML to POD by software written by Chas Williams and Russ
114 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.