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