openafs/doc/man-pages/pod8/backup_addhost.pod
Ken Dreyer 1cc8feb6fc doc: replace hostnames with IETF example hostnames
There were several different real and made-up hostnames and company names used
throughout our documentation examples.

The IETF has reserved "example.com" and other "example" TLDs for use in
examples (RFC 2606). Replace almost all references to ABC Corporation, DEF
Corporation, and State University, as well as "abc.com", "bigcell.com",
"def.com", "def.gov", "ghi.com", "ghi.gov", "jkl.com", "mit.edu",
"stanford.edu", "state.edu", "stateu.edu", "uncc.edu", and "xyz.com".
Standardize on "Example Corporation", "Example Network", "Example
Organization" (example.com, example.net, and example.org).

The Scout documentation in the Admin Guide contains PNG images that contain
the old cell names, so I left those references until the images can be
replaced.

Change-Id: I4e44815b2d2ffe204810b7fd850842248f67c367
Reviewed-on: http://gerrit.openafs.org/6697
Reviewed-by: Jeffrey Altman <jaltman@secure-endpoints.com>
Tested-by: Jeffrey Altman <jaltman@secure-endpoints.com>
2012-02-17 20:51:58 -08:00

122 lines
3.7 KiB
Plaintext

=head1 NAME
backup_addhost - Adds a Tape Coordinator entry to the Backup Database
=head1 SYNOPSIS
=for html
<div class="synopsis">
B<backup addhost> S<<< B<-tapehost> <I<tape machine name>> >>>
S<<< [B<-portoffset> <I<TC port offset>>] >>>
[B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
B<backup addh> S<<< B<-t> <I<tape machine name>> >>>
S<<< [B<-p> <I<TC port offset>>] >>>
[B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
=for html
</div>
=head1 DESCRIPTION
The B<backup addhost> command creates a Tape Coordinator entry in the
Backup Database. The entry records
=over 4
=item *
The host name of the Tape Coordinator machine where the Tape Coordinator
(B<butc>) process runs, as specified with the B<-tapehost> argument.
=item *
The Tape Coordinator's port offset number, as specified with the
B<-portoffset> argument. An entry for the port offset must also appear in
the F</usr/afs/backup/tapeconfig> file on the Tape Coordinator machine,
where it is mapped to a UNIX device name (for a tape device) or pathname
(for a backup data file).
=back
Each Tape Coordinator must have its own port offset number, and the
command fails if a Backup Database entry already exists for the requested
port offset number. To display existing Tape Coordinator entries, use the
B<backup listhosts> command.
=head1 OPTIONS
=over 4
=item B<-tapehost> <I<tape machine name>>
Specifies the fully-qualified hostname of the machine for which to create
a Tape Coordinator entry in the Backup Database. The machine must have an
entry in either the cell's naming service (such as the Domain Name
Service) or the host file (F</etc/hosts> or equivalent) on the machine
where the command is issued.
=item B<-portoffset> <I<TC port offset>>
Specifies the Tape Coordinator's port offset number. Provide an integer
from the range C<0> through C<58510>, or omit this argument to use the
default value of C<0> (zero). The value must match the port offset number
recorded for the same combination of Tape Coordinator and tape device or
file in the F</usr/afs/backup/tapeconfig> file on the Tape Coordinator
machine named by the B<-tapehost> argument.
=item B<-localauth>
Constructs a server ticket using a key from the local
F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
it to the Backup Server, Volume Server and VL Server during mutual
authentication. Do not combine this flag with the B<-cell> argument. For
more details, see L<backup(8)>.
=item B<-cell> <I<cell name>>
Names the cell in which to run the command. Do not combine this argument
with the B<-localauth> flag. For more details, see L<backup(8)>.
=item B<-help>
Prints the online help for this command. All other valid options are
ignored.
=back
=head1 EXAMPLES
The following command creates an entry in the Backup Database that assigns
port offset number 4 to a Tape Coordinator running on the machine
C<backup1.example.com>:
% backup addhost -tapehost backup1.example.com -portoffset 4
The following command creates a Backup Database entry that assigns port
offset number 0 to a Tape Coordinator on the machine C<backup3.example.com>:
% backup addhost backup3.example.com
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the F</usr/afs/etc/UserList> file on every
machine where the Backup Server is running, or must be logged onto a
server machine as the local superuser C<root> if the B<-localauth> flag is
included.
=head1 SEE ALSO
L<backup(8)>,
L<backup_delhost(8)>,
L<backup_listhosts(8)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.