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