ubik: Remove unused sampleName
[openafs.git] / doc / man-pages / pod5 / NetInfo.pod
1 =head1 NAME
2
3 NetInfo - Defines machine interfaces to register with AFS servers
4
5 =head1 DESCRIPTION
6
7 There are two F<NetInfo> files, one for an AFS client and one for an AFS
8 File Server or database server.  The AFS client F<NetInfo> file specifies
9 the IP addresses that the client should register with the File Servers it
10 connects to.  The server F<NetInfo> file specifies what interfaces should
11 be registered with AFS Database Servers or used to talk to other database
12 servers.
13
14 =head2 Client NetInfo
15
16 The client F<NetInfo> file lists the IP addresses of one or more of the
17 local machine's network interfaces. If it exists in the F</usr/vice/etc>
18 directory when the Cache Manager initializes, the Cache Manager uses its
19 contents as the basis for a list of local interfaces. Otherwise, the Cache
20 Manager uses the list of interfaces configured with the operating
21 system. It then removes from the list any addresses that appear in the
22 F</usr/vice/etc/NetRestrict> file, if it exists. The Cache Manager records
23 the resulting list in kernel memory. The first time it establishes a
24 connection to a File Server, it registers the list with the File Server.
25
26 The File Server uses the addresses when it initiates a remote procedure
27 call (RPC) to the Cache Manager (as opposed to responding to an RPC sent
28 by the Cache Manager). There are two common circumstances in which the
29 File Server initiates RPCs: when it breaks callbacks and when it pings the
30 client machine to verify that the Cache Manager is still accessible.
31
32 The F<NetInfo> file is in ASCII format. One of the machine's IP addresses
33 appears on each line, in dotted decimal format.  To match a network instead
34 of an individual address, use a slash (C</>) followed a subnet length.  The
35 File Server initially uses the address that matches first in the list. The
36 order of the remaining addresses is not significant: if an RPC to the first
37 interface fails, the File Server simultaneously sends RPCs to all of the other
38 interfaces in the list.  Whichever interface replies first is the one to
39 which the File Server then sends pings and RPCs to break callbacks.
40
41 To prohibit the Cache Manager absolutely from using one or more addresses,
42 list them in the F<NetRestrict> file. To display the addresses the Cache
43 Manager is currently registering with File Servers, use the B<fs
44 getclientaddrs> command. To replace the current list of interfaces with a
45 new one between reboots of the client machine, use the B<fs
46 setclientaddrs> command.
47
48 =head2 Server NetInfo
49
50 The server F<NetInfo> file, if present in the F</usr/afs/local> directory,
51 defines the following:
52
53 =over 4
54
55 =item *
56
57 On a file server machine, the local interfaces that the File Server
58 (B<fileserver> process) can register in the Volume Location Database
59 (VLDB) at initialization time.
60
61 =item *
62
63 On a database server machine, the local interfaces that the Ubik database
64 synchronization library uses when communicating with the database server
65 processes running on other database server machines.
66
67 =back
68
69 If the F<NetInfo> file exists when the File Server initializes, the File
70 Server uses its contents as the basis for a list of interfaces to register
71 in the VLDB. Otherwise, it uses the list of network interfaces configured
72 with the operating system. It then removes from the list any addresses
73 that appear in the F</usr/afs/local/NetRestrict> file, if it exists. The
74 File Server records the resulting list in the F</usr/afs/local/sysid> file
75 and registers the interfaces in the VLDB. The database server processes
76 use a similar procedure when initializing, to determine which interfaces
77 to use for communication with the peer processes on other database
78 machines in the cell.
79
80 The F<NetInfo> file is in ASCII format. One of the machine's IP addresses
81 appears on each line, in dotted decimal format.  To match a network
82 instead of an individual address, use a slash (C</>) followed a subnet
83 length.  The order of the addresses is not significant.
84
85 Optionally, the File Server can be forced to use an IP address that does
86 not belong to one of the server interfaces. To do this, add a line to the
87 F<NetInfo> file with the IP address prefixed with "f" and a space. This is
88 useful when the File Server is on the internal side of a NAT firewall.
89
90 To display the File Server interface addresses registered in the VLDB, use
91 the B<vos listaddrs> command.
92
93 =head1 EXAMPLES
94
95 If the File Server is on the internal side of a NAT firewall, where it
96 serves internal clients using the IP address 192.168.1.123 and external
97 clients using the IP address 10.1.1.321, then the F<NetInfo> file should
98 contain the following:
99
100    192.168.1.123
101    f 10.1.1.321
102
103 =head1 SEE ALSO
104
105 L<NetRestrict(5)>,
106 L<sysid(5)>,
107 L<vldb.DB0(5)>,
108 L<fileserver(8)>,
109 L<fs_getclientaddrs(1)>,
110 L<fs_setclientaddrs(1)>,
111 L<vos_listaddrs(1)>
112
113 =head1 COPYRIGHT
114
115 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
116
117 This documentation is covered by the IBM Public License Version 1.0.  It was
118 converted from HTML to POD by software written by Chas Williams and Russ
119 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.