doc/man-pages/pod8/backup_listhosts.pod

   1 =head1 NAME
   2
   3 backup_listhosts - Lists Tape Coordinators registered in the Backup Database
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<backup listhosts> [B<-localauth>] S<<< [B<-cell> <I<cell name>>] >>> [B<-help>]
  11
  12 B<backup listh> [B<-l>] S<<< [B<-c> <I<cell name>>] >>> [B<-h>]
  13
  14 =for html
  15 </div>
  16
  17 =head1 DESCRIPTION
  18
  19 The B<backup listhosts> command displays the Backup Database record of the
  20 port offset numbers defined for Tape Coordinator machines. A Tape
  21 Coordinator must have an entry in the list to be available for backup
  22 operations.
  23
  24 The existence of an entry does not necessarily indicate that the Tape
  25 Coordinator process (B<butc>) is currently running at that port offset. To
  26 check, issue the B<backup status> command.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-localauth>
  33
  34 Constructs a server ticket using a key from the local
  35 F</usr/afs/etc/KeyFile> file. The B<backup> command interpreter presents
  36 it to the Backup Server, Volume Server and VL Server during mutual
  37 authentication. Do not combine this flag with the B<-cell> argument. For
  38 more details, see L<backup(8)>.
  39
  40 =item B<-cell> <I<cell name>>
  41
  42 Names the cell in which to run the command. Do not combine this argument
  43 with the B<-localauth> flag. For more details, see L<backup(8)>.
  44
  45 =item B<-help>
  46
  47 Prints the online help for this command. All other valid options are
  48 ignored.
  49
  50 =back
  51
  52 =head1 OUTPUT
  53
  54 After a C<Tape hosts:> header, the output reports two things about each
  55 Tape Coordinator currently defined in the Backup Database:
  56
  57 =over 4
  58
  59 =item *
  60
  61 The hostname of the machine housing the Tape Coordinator. The format of
  62 this name depends on the hostname format used when the B<backup addhost>
  63 command was issued.
  64
  65 =item *
  66
  67 The Tape Coordinator's port offset number.
  68
  69 =back
  70
  71 The Tape Coordinators appear in the order in which they were added to the
  72 Backup Database.
  73
  74 =head1 EXAMPLES
  75
  76 The following example shows the result of the command in the ABC
  77 Corporation cell:
  78
  79    % backup listhosts
  80    Tape hosts:
  81        Host backup1.abc.com, port offset 0
  82        Host backup1.abc.com, port offset 1
  83        Host backup3.abc.com, port offset 4
  84        Host backup2.abc.com, port offset 3
  85
  86 =head1 PRIVILEGE REQUIRED
  87
  88 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
  89 machine where the Backup Server is running, or must be logged onto a
  90 server machine as the local superuser C<root> if the B<-localauth> flag is
  91 included.
  92
  93 =head1 SEE ALSO
  94
  95 L<backup(8)>,
  96 L<backup_addhost(8)>,
  97 L<backup_delhost(8)>,
  98 L<backup_status(8)>
  99
 100 =head1 COPYRIGHT
 101
 102 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 103
 104 This documentation is covered by the IBM Public License Version 1.0.  It was
 105 converted from HTML to POD by software written by Chas Williams and Russ
 106 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.