bc127ca922939a94509d2c937df4538339ec38a7
[openafs.git] / doc / man-pages / pod1 / fs_setclientaddrs.pod
1 =head1 NAME
2
3 fs setclientaddrs - Sets the client interfaces to register with the File Server
4
5 =head1 SYNOPSIS
6
7 B<fs setclientaddrs> [B<-address> <I<client network interfaces>>+] [B<-help>]
8
9 B<fs setcl> [B<-a> <I<client network interfaces>>+] [B<-h>]
10
11 B<fs sc> [B<-a> <I<client network interfaces>>+] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The B<fs setclientaddrs> command defines 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 The list of interfaces specified with this command replaces the list that
26 the Cache Manager constructs and records in kernel memory as it
27 initializes. At that time, if the file F</usr/vice/etc/NetInfo> exists on
28 the client machine's local disk, the Cache Manager uses its contents as
29 the basis for the list of interfaces addresses. If the file does not
30 exist, the Cache Manager instead uses the network interfaces configured
31 with the operating system. It then removes from the list any address
32 included in the local F</usr/vice/etc/NetRestrict> file. It records the
33 final list in kernel memory. (An administrator must create the F<NetInfo>
34 and F<NetRestrict> files; there are no default versions of them.)
35
36 If an RPC to that interface fails, the File Server simultaneously sends
37 RPCs to all of the other interfaces in the list, to learn which of them
38 are still available. Whichever interface replies first is the one to which
39 the File Server then sends pings and RPCs to break callbacks.
40
41 To list the interfaces that the Cache Manager is currently registering
42 with File Servers, use the B<fs getclientaddrs> command.
43
44 =head1 CAUTIONS
45
46 The list specified with this command persists in kernel memory only until
47 the client machine reboots. To preserve it across reboots, either list the
48 interfaces in the local F</usr/vice/etc/NetInfo> file, or place the
49 appropriate B<fs setclientaddrs> command in the machine's AFS
50 initialization script.
51
52 Changes made with this command do not propagate automatically to File
53 Servers to which the Cache Manager has already established a
54 connection. To force such File Servers to use the revised list, either
55 reboot each file server machine, or change the F<NetInfo> file and reboot
56 the client machine.
57
58 The fs command interpreter verifies that each of the addresses specified
59 as a value for the B<-address> argument is actually configured with the
60 operating system on the client machine. If it is not, the command fails
61 with an error message that marks the address as a C<Nonexistent
62 interface>.
63
64 =head1 OPTIONS
65
66 =over 4
67
68 =item B<-address> <I<client network interfaces>>+
69
70 Specifies each IP address to place in the list of interfaces, in dotted
71 decimal format. Hostnames are not acceptable. Separate each address with
72 one or more spaces.
73
74 =item B<-help>
75
76 Prints the online help for this command. All other valid options are
77 ignored.
78
79 =back
80
81 =head1 OUTPUT
82
83 The message
84
85    Adding <interface>
86
87 confirms that each new interface was added to the Cache Manager's
88 list. The address appears in hexadecimal format to match the notation used
89 in the File Server log, F</usr/afs/logs/FileLog>.
90
91 =head1 EXAMPLES
92
93 The following example sets the two interfaces that the Cache Manager
94 registers with File Servers.
95
96    % fs setclientaddrs 191.255.105.68 191.255.108.84
97    Adding 0xbfff6944
98    Adding 0xbfff6c54
99
100 =head1 PRIVILEGE REQUIRED
101
102 The issuer must be logged in as the local superuser root.
103
104 =head1 SEE ALSO
105
106 L<NetInfo(5)>,
107 L<NetRestrict(5)>,
108 L<fileserver(8)>,
109 L<fs_getclientaddrs(1)>
110
111 =head1 COPYRIGHT
112
113 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
114
115 This documentation is covered by the IBM Public License Version 1.0.  It was
116 converted from HTML to POD by software written by Chas Williams and Russ
117 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.