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