42086da2fe26bc1768bc16bc846dd3ee1939bd13
[openafs.git] / doc / man-pages / pod5 / NetRestrict.pod
1 =head1 NAME
2
3 NetRestrict - Defines interfaces not to register with AFS servers
4
5 =head1 DESCRIPTION
6
7 There are two F<NetRestrict> files, one for an AFS client and one for an
8 AFS File Server or database server.  The AFS client F<NetRestrict> file
9 specifies the IP addresses that the client should not register with the
10 File Servers it connects to.  The server F<NetRestrict> file specifies
11 what interfaces should not be registered with AFS Database Servers or used
12 to talk to other database servers.
13
14 =head2 Client NetRestrict
15
16 The F<NetRestrict> file, if present in a client machine's F</usr/vice/etc>
17 directory, defines the IP addresses of the interfaces that the local Cache
18 Manager does not register with a File Server when first establishing a
19 connection to it. For an explanation of how the File Server uses the
20 registered interfaces, see L<NetInfo(5)>.
21
22 As it initializes, the Cache Manager constructs a list of interfaces to
23 register, from the F</usr/vice/etc/NetInfo> file if it exists, or from the
24 list of interfaces configured with the operating system otherwise.  The
25 Cache Manager then removes from the list any addresses that appear in the
26 F<NetRestrict> file, if it exists. The Cache Manager records the resulting
27 list in kernel memory.
28
29 The F<NetRestrict> file is in ASCII format. One IP address appears on each
30 line, in dotted decimal format. The order of the addresses is not
31 significant.
32
33 To display the addresses the Cache Manager is currently registering with
34 File Servers, use the B<fs getclientaddrs> command.
35
36 =head2 Server NetRestrict
37
38 The F<NetRestrict> file, if present in the F</usr/afs/local> directory,
39 defines the following:
40
41 =over 4
42
43 =item *
44
45 On a file server machine, the local interfaces that the File Server
46 (B<fileserver> process) does not register in the Volume Location Database
47 (VLDB) at initialization time.
48
49 =item *
50
51 On a database server machine, the local interfaces that the Ubik
52 synchronization library does not use when communicating with the database
53 server processes running on other database server machines.
54
55 =back
56
57 As it initializes, the File Server constructs a list of interfaces to
58 register, from the F</usr/afs/local/NetInfo> file if it exists, or from
59 the list of interfaces configured with the operating system otherwise. The
60 File Server then removes from the list any addresses that appear in the
61 F<NetRestrict> file, if it exists. The File Server records the resulting
62 list in the F</usr/afs/local/sysid> file and registers the interfaces in
63 the VLDB. The database server processes use a similar procedure when
64 initializing, to determine which interfaces to use for communication with
65 the peer processes on other database machines in the cell.
66
67 The F<NetRestrict> file is in ASCII format. One IP address appears on each
68 line, in dotted decimal format. The order of the addresses is not
69 significant. 
70
71 To display the File Server interface addresses registered in the VLDB, use
72 the B<vos listaddrs> command.
73
74 =head1 SEE ALSO
75
76 L<NetInfo(5)>,
77 L<sysid(5)>,
78 L<vldb.DB0(5)>,
79 L<fileserver(8)>,
80 L<fs_getclientaddrs(1)>
81 L<vos_listaddrs(1)>
82
83 =head1 COPYRIGHT
84
85 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
86
87 This documentation is covered by the IBM Public License Version 1.0.  It was
88 converted from HTML to POD by software written by Chas Williams and Russ
89 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.