doc/xml/AdminReference/sect5/NetInfo.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="NetInfo5">
   3   <refmeta>
   4     <refentrytitle>NetInfo</refentrytitle>
   5     <manvolnum>5</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>NetInfo</refname>
   9     <refpurpose>Defines machine interfaces to register with AFS servers</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Description</title>
  13     <para>There are two <replaceable>NetInfo</replaceable> files, one for an AFS client and one for an AFS
  14     File Server or database server.  The AFS client <replaceable>NetInfo</replaceable> file specifies
  15     the IP addresses that the client should register with the File Servers it
  16     connects to.  The server <replaceable>NetInfo</replaceable> file specifies what interfaces should
  17     be registered with AFS Database Servers or used to talk to other database
  18     servers.</para>
  19
  20     <refsect2>
  21       <title>Client NetInfo</title>
  22       <para>The client <replaceable>NetInfo</replaceable> file lists the IP addresses of one or more of the
  23       local machine's network interfaces. If it exists in the <replaceable>/usr/vice/etc</replaceable>
  24       directory when the Cache Manager initializes, the Cache Manager uses its
  25       contents as the basis for a list of local interfaces. Otherwise, the Cache
  26       Manager uses the list of interfaces configured with the operating
  27       system. It then removes from the list any addresses that appear in the
  28       <replaceable>/usr/vice/etc/NetRestrict</replaceable> file, if it exists. The Cache Manager records
  29       the resulting list in kernel memory. The first time it establishes a
  30       connection to a File Server, it registers the list with the File Server.</para>
  31
  32       <para>The File Server uses the addresses when it initiates a remote procedure
  33       call (RPC) to the Cache Manager (as opposed to responding to an RPC sent
  34       by the Cache Manager). There are two common circumstances in which the
  35       File Server initiates RPCs: when it breaks callbacks and when it pings the
  36       client machine to verify that the Cache Manager is still accessible.</para>
  37
  38       <para>The <replaceable>NetInfo</replaceable> file is in ASCII format. One of the machine's IP addresses
  39       appears on each line, in dotted decimal format. The File Server initially
  40       uses the address that appears first in the list. The order of the
  41       remaining addresses is not significant: if an RPC to the first interface
  42       fails, the File Server simultaneously sends RPCs to all of the other
  43       interfaces in the list.  Whichever interface replies first is the one to
  44       which the File Server then sends pings and RPCs to break callbacks.</para>
  45
  46       <para>To prohibit the Cache Manager absolutely from using one or more addresses,
  47       list them in the <replaceable>NetRestrict</replaceable> file. To display the addresses the Cache
  48       Manager is currently registering with File Servers, use the <emphasis role="bold">fs
  49       getclientaddrs</emphasis> command. To replace the current list of interfaces with a
  50       new one between reboots of the client machine, use the <emphasis role="bold">fs
  51       setclientaddrs</emphasis> command.</para>
  52
  53     </refsect2>
  54     <refsect2>
  55       <title>Server NetInfo</title>
  56       <para>The server <replaceable>NetInfo</replaceable> file, if present in the <replaceable>/usr/afs/local</replaceable> directory,
  57       defines the following:</para>
  58
  59       <itemizedlist>
  60         <listitem>
  61           <para>On a file server machine, the local interfaces that the File Server
  62           (<emphasis role="bold">fileserver</emphasis> process) can register in the Volume Location Database
  63           (VLDB) at initialization time.</para>
  64
  65         </listitem>
  66         <listitem>
  67           <para>On a database server machine, the local interfaces that the Ubik database
  68           synchronization library uses when communicating with the database server
  69           processes running on other database server machines.</para>
  70
  71         </listitem>
  72       </itemizedlist>
  73       <para>If the <replaceable>NetInfo</replaceable> file exists when the File Server initializes, the File
  74       Server uses its contents as the basis for a list of interfaces to register
  75       in the VLDB. Otherwise, it uses the list of network interfaces configured
  76       with the operating system. It then removes from the list any addresses
  77       that appear in the <replaceable>/usr/afs/local/NetRestrict</replaceable> file, if it exists. The
  78       File Server records the resulting list in the <replaceable>/usr/afs/local/sysid</replaceable> file
  79       and registers the interfaces in the VLDB. The database server processes
  80       use a similar procedure when initializing, to determine which interfaces
  81       to use for communication with the peer processes on other database
  82       machines in the cell.</para>
  83
  84       <para>The <replaceable>NetInfo</replaceable> file is in ASCII format. One of the machine's IP addresses
  85       appears on each line, in dotted decimal format. The order of the addresses
  86       is not significant.</para>
  87
  88       <para>To display the File Server interface addresses registered in the VLDB, use
  89       the <emphasis role="bold">vos listaddrs</emphasis> command.</para>
  90
  91     </refsect2>
  92   </refsect1>
  93   <refsect1>
  94     <title>See Also</title>
  95     <para><link linkend="sysid5">sysid(5)</link>,
  96     <link linkend="vldb_DB05">vldb.DB0(5)</link>,
  97     <link linkend="fileserver8">fileserver(8)</link>,
  98     <link linkend="fs_getclientaddrs1">fs_getclientaddrs(1)</link>,
  99     <link linkend="fs_setclientaddrs1">fs_setclientaddrs(1)</link>,
 100     <link linkend="vos_listaddrs1">vos_listaddrs(1)</link></para>
 101
 102   </refsect1>
 103   <refsect1>
 104     <title>Copyright</title>
 105     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 106
 107     <para>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.</para>
 110
 111   </refsect1>
 112 </refentry>