openafs/doc/man-pages/pod1/fs_getclientaddrs.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

107 lines
3.5 KiB
Plaintext

=head1 NAME
fs getclientaddrs - Displays the client interfaces to register with the File Server
=head1 SYNOPSIS
B<fs getclientaddrs> [-help]
B<fs gc> [-h]
B<fs getcl >[-h]
=head1 DESCRIPTION
The fs getclientaddrs command displays the IP addresses of the
interfaces that the local Cache Manager registers with a File Server when
first establishing a connection to it.
The File Server uses the addresses when it initiates a remote procedure
call (RPC) to the Cache Manager (as opposed to responding to an RPC sent by
the Cache Manager). There are two common circumstances in which the
File Server initiates RPCs: when it breaks callbacks and when it pings
the client machine to verify that the Cache Manager is still
accessible.
If an RPC to that interface fails, the File Server simultaneously sends
RPCs to all of the other interfaces in the list, to learn which of them are
still available. Whichever interface replies first is the one to which
the File Server then sends pings and RPCs to break callbacks.
The fs setclientaddrs reference page explains how the Cache
Manager constructs the list automatically in kernel memory as it initializes,
and how to use that command to alter the kernel list after
initialization.
=head1 CAVEATS
The File Server uses the list of interfaces displayed by this command only
when selecting an alternative interface after a failed attempt to break a
callback or ping the Cache Manager. When responding to the Cache
Manager's request for file system data, the File Server replies to the
interface which the Cache Manager used when sending the request. If the
File Server's reply to a data request fails, the file server
machine's network routing configuration determines which alternate
network routes to the client machine are available for resending the
reply.
The displayed list applies to all File Servers to which the Cache Manager
connects in the future. It is not practical to register different sets
of addresses with different File Servers, because it requires using the
B<fs setclientaddrs> command to change the list and then rebooting
each relevant File Server immediately.
The displayed list is not necessarily governing the behavior of a given
File Server, if an administrator has issued the B<fs setclientaddrs>
command since the Cache Manager first contacted that File Server. It
determines only which addresses the Cache Manager registers when connecting to
File Servers in the future.
The list of interfaces does not influence the Cache Manager's choice
of interface when establishing a connection to a File Server.
=head1 OPTIONS
=over 4
=item -help
Prints the online help for this command. All other valid options
are ignored.
=back
=head1 OUTPUT
The output displays the IP address of each interface that the Cache Manager
is currently registering with File Server processes that it contacts, with one
address per line. The File Server initially uses the first address for
breaking callbacks and pinging the Cache Manager, but the ordering of the
other interfaces is not meaningful.
=head1 EXAMPLES
The following example displays the two interfaces that the Cache Manager is
registering with File Servers.
% fs getclientaddrs
192.12.105.68
192.12.108.84
=head1 PRIVILEGE REQUIRED
None
=head1 SEE ALSO
L<fileserver(1)>,
L<fs_setclientaddrs(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.