openafs/doc/man-pages/pod8/backup_listhosts.pod
Russ Allbery e3dfba8e6c man-page-conversion-20051208
This is the initial conversion of the AFS Adminstrators Reference into POD
for use as man pages.  The man pages are now generated via pod2man from
regen.sh so that only those working from CVS have to have pod2man
available.  The Makefile only installs.  The pages have also been sorted
out into pod1, pod5, and pod8 directories, making conversion to the right
section of man page easier without maintaining a separate list and allowing
for names to be duplicated between pod5 and pod1 or pod8 (which will likely
be needed in a few cases).

This reconversion is done with a new script based on work by Chas Williams.
In some cases, the output is worse than the previous POD pages, but this is
a more comprehensive conversion.

This is only the first step, and this initial conversion has various
problems.  In addition, the file man pages that didn't have simple names
have not been converted in this pass and will be added later.  Some of the
man pages have syntax problems and all of them have formatting errors.  The
next editing pass, coming shortly, will clean up most of the remaining
mess.
2005-12-08 12:14:33 +00:00

106 lines
2.7 KiB
Plaintext

=head1 NAME
backup listhosts - Lists Tape Coordinator machines registered in the Backup Database
=head1 SYNOPSIS
B<backup listhosts> [B<-localauth>] [B<-cell> <I<cell name>>] [-help]
B<backup listh> [B<-l>] [B<-c> <I<cell name>>] [-h]
=head1 DESCRIPTION
The backup listhosts command displays the Backup Database record
of the port offset numbers defined for Tape Coordinator machines. A
Tape Coordinator must have an entry in the list to be available for backup
operations.
The existence of an entry does not necessarily indicate that the Tape
Coordinator process (B<butc>) is currently running at that port
offset. To check, issue the B<backup status> command.
=head1 OPTIONS
=over 4
=item -localauth
Constructs a server ticket using a key from the local
B</usr/afs/etc/KeyFile> file. The B<backup> command
interpreter presents it to the Backup Server, Volume Server and VL Server
during mutual authentication. Do not combine this flag with the
B<-cell> argument. For more details, see the introductory
B<backup> reference page.
=item -cell
Names the cell in which to run the command. Do not combine this
argument with the B<-localauth> flag. For more details, see the
introductory B<backup> reference page.
=item -help
Prints the online help for this command. All other valid options
are ignored.
=back
=head1 OUTPUT
After a C<Tape> C<hosts:> header, the output reports
two things about each Tape Coordinator currently defined in the Backup
Database:
=over 4
=item *
The hostname of the machine housing the Tape Coordinator. The
format of this name depends on the hostname format used when the B<backup
addhost> command was issued.
=item *
The Tape Coordinator's port offset number.
=back
The Tape Coordinators appear in the order in which they were added to the
Backup Database.
=head1 EXAMPLES
The following example shows the result of the command in the ABC
Corporation cell:
% backup listhosts
Tape hosts:
Host backup1.abc.com, port offset 0
Host backup1.abc.com, port offset 1
Host backup3.abc.com, port offset 4
Host backup2.abc.com, port offset 3
=head1 PRIVILEGE REQUIRED
The issuer must be listed in the /usr/afs/etc/UserList file on
every machine where the Backup Server is running, or must be logged onto a
server machine as the local superuser B<root> if the
B<-localauth> flag is included.
=head1 SEE ALSO
L<backup(1)>,
L<backup_addhost(1)>,
L<backup_delhost(1)>,
L<backup_status(1)>
=head1 COPYRIGHT
IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
This documentation is covered by the IBM Public License Version 1.0. It was
converted from HTML to POD by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.