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