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