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