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