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