Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / fs_getclientaddrs.pod
CommitLineData
805e021f
CE
1=head1 NAME
2
3fs_getclientaddrs - Displays the client interfaces to register
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<fs getclientaddrs> [B<-help>]
11
12B<fs gc> [B<-h>]
13
14B<fs getcl> [B<-h>]
15
16=for html
17</div>
18
19=head1 DESCRIPTION
20
21The B<fs getclientaddrs> command displays the IP addresses of the
22interfaces that the local Cache Manager registers with a File Server when
23first establishing a connection to it.
24
25The File Server uses the addresses when it initiates a remote procedure
26call (RPC) to the Cache Manager (as opposed to responding to an RPC sent
27by the Cache Manager). There are two common circumstances in which the
28File Server initiates RPCs: when it breaks callbacks and when it pings the
29client machine to verify that the Cache Manager is still accessible.
30
31If an RPC to that interface fails, the File Server simultaneously sends
32RPCs to all of the other interfaces in the list, to learn which of them
33are still available. Whichever interface replies first is the one to which
34the File Server then sends pings and RPCs to break callbacks.
35
36L<fs_setclientaddrs(1)> explains how the Cache Manager constructs the list
37automatically in kernel memory as it initializes, and how to use that
38command to alter the kernel list after initialization.
39
40=head1 CAUTIONS
41
42The File Server uses the list of interfaces displayed by this command only
43when selecting an alternative interface after a failed attempt to break a
44callback or ping the Cache Manager. When responding to the Cache Manager's
45request for file system data, the File Server replies to the interface
46which the Cache Manager used when sending the request. If the File
47Server's reply to a data request fails, the file server machine's network
48routing configuration determines which alternate network routes to the
49client machine are available for resending the reply.
50
51The displayed list applies to all File Servers to which the Cache Manager
52connects in the future. It is not practical to register different sets of
53addresses with different File Servers, because it requires using the B<fs
54setclientaddrs> command to change the list and then rebooting each
55relevant File Server immediately.
56
57The displayed list is not necessarily governing the behavior of a given
58File Server, if an administrator has issued the B<fs setclientaddrs>
59command since the Cache Manager first contacted that File Server. It
60determines only which addresses the Cache Manager registers when
61connecting to File Servers in the future.
62
63The list of interfaces does not influence the Cache Manager's choice of
64interface when establishing a connection to a File Server.
65
66=head1 OPTIONS
67
68=over 4
69
70=item B<-help>
71
72Prints the online help for this command. All other valid options are
73ignored.
74
75=back
76
77=head1 OUTPUT
78
79The output displays the IP address of each interface that the Cache
80Manager is currently registering with File Server processes that it
81contacts, with one address per line. The File Server initially uses the
82first address for breaking callbacks and pinging the Cache Manager, but
83the ordering of the other interfaces is not meaningful.
84
85=head1 EXAMPLES
86
87The following example displays the two interfaces that the Cache Manager
88is registering with File Servers.
89
90 % fs getclientaddrs
91 192.12.105.68
92 192.12.108.84
93
94=head1 PRIVILEGE REQUIRED
95
96None
97
98=head1 SEE ALSO
99
100L<fileserver(8)>,
101L<fs_setclientaddrs(1)>
102
103=head1 COPYRIGHT
104
105IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
106
107This documentation is covered by the IBM Public License Version 1.0. It was
108converted from HTML to POD by software written by Chas Williams and Russ
109Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.