afsmonitor-document-stat-entries-correctly-20040729
[openafs.git] / doc / html / AdminReference / auarf160.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf159.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf161.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
17 <P>
18 <H2><A NAME="HDRFS_SETCLIENTADDRS" HREF="auarf002.htm#ToC_174">fs setclientaddrs</A></H2>
19 <A NAME="IDX4961"></A>
20 <A NAME="IDX4962"></A>
21 <A NAME="IDX4963"></A>
22 <A NAME="IDX4964"></A>
23 <A NAME="IDX4965"></A>
24 <P><STRONG>Purpose</STRONG>
25 <P>Sets the client interfaces to register with the File Server
26 <P><STRONG>Synopsis</STRONG>
27 <PRE><B>fs setclientaddrs</B> [<B>-address</B> &lt;<VAR>client&nbsp;network&nbsp;interfaces</VAR>><SUP>+</SUP>]  [<B>-help</B>]
28    
29 <B>fs setcl</B> [<B>-a</B> &lt;<VAR>client&nbsp;network&nbsp;interfaces</VAR>><SUP>+</SUP>]  [<B>-h</B>]
30    
31 <B>fs sc</B> [<B>-a</B> &lt;<VAR>client&nbsp;network&nbsp;interfaces</VAR>><SUP>+</SUP>]  [<B>-h</B>]
32 </PRE>
33 <P><STRONG>Description</STRONG>
34 <P>The <B>fs setclientaddrs</B> command defines the IP addresses of the
35 interfaces that the local Cache Manager registers with a File Server when
36 first establishing a connection to it.
37 <P>The File Server uses the addresses when it initiates a remote procedure
38 call (RPC) to the Cache Manager (as opposed to responding to an RPC sent by
39 the Cache Manager). There are two common circumstances in which the
40 File Server initiates RPCs: when it breaks callbacks and when it pings
41 the client machine to verify that the Cache Manager is still
42 accessible.
43 <P>The list of interfaces specified with this command replaces the list that
44 the Cache Manager constructs and records in kernel memory as it
45 initializes. At that time, if the file <B>/usr/vice/etc/NetInfo</B>
46 exists on the client machine's local disk, the Cache Manager uses its
47 contents as the basis for the list of interfaces addresses. If the file
48 does not exist, the Cache Manager instead uses the network interfaces
49 configured with the operating system. It then removes from the list any
50 address included in the local <B>/usr/vice/etc/NetRestrict</B>
51 file. It records the final list in kernel memory. (An
52 administrator must create the <B>NetInfo</B> and <B>NetRestrict</B>
53 files; there are no default versions of them.)
54 <P>If an RPC to that interface fails, the File Server simultaneously sends
55 RPCs to all of the other interfaces in the list, to learn which of them are
56 still available. Whichever interface replies first is the one to which
57 the File Server then sends pings and RPCs to break callbacks.
58 <P>To list the interfaces that the Cache Manager is currently registering with
59 File Servers, use the <B>fs getclientaddrs</B> command.
60 <P><STRONG>Cautions</STRONG>
61 <P>The list specified with this command persists in kernel memory only until
62 the client machine reboots. To preserve it across reboots, either list
63 the interfaces in the local <B>/usr/vice/etc/NetInfo</B> file, or place
64 the appropriate <B>fs setclientaddrs</B> command in the machine's AFS
65 initialization script.
66 <P>Changes made with this command do not propagate automatically to File
67 Servers to which the Cache Manager has already established a
68 connection. To force such File Servers to use the revised list, either
69 reboot each file server machine, or change the <B>NetInfo</B> file and
70 reboot the client machine.
71 <P>The <B>fs</B> command interpreter verifies that each of the addresses
72 specified as a value for the <B>-address</B> argument is actually
73 configured with the operating system on the client machine. If it is
74 not, the command fails with an error message that marks the address as a
75 <TT>Nonexistent</TT> <TT>interface</TT>.
76 <P><STRONG>Options</STRONG>
77 <DL>
78 <P><DT><B>-address
79 </B><DD>Specifies each IP address to place in the list of interfaces, in dotted
80 decimal format. Hostnames are not acceptable. Separate each
81 address with one or more spaces.
82 <P><DT><B>-help
83 </B><DD>Prints the online help for this command. All other valid options
84 are ignored.
85 </DL>
86 <P><STRONG>Output</STRONG>
87 <P>The message
88 <PRE>   Adding <VAR>interface</VAR>
89    
90 </PRE>
91 <P>confirms that each new interface was added to the Cache Manager's
92 list. The address appears in hexadecimal format to match the notation
93 used in the File Server log, <B>/usr/afs/logs/FileLog</B>.
94 <P><STRONG>Examples</STRONG>
95 <P>The following example sets the two interfaces that the Cache Manager
96 registers with File Servers.
97 <PRE>   % <B>fs setclientaddrs 191.255.105.68 191.255.108.84</B>
98    Adding 0xbfff6944
99    Adding 0xbfff6c54
100    
101 </PRE>
102 <P><STRONG>Privilege Required</STRONG>
103 <P>The issuer must be logged in as the local superuser <B>root</B>.
104 <P><STRONG>Related Information</STRONG>
105 <P><A HREF="auarf024.htm#HDRCLI_NETINFO">NetInfo (client version)</A>
106 <P><A HREF="auarf026.htm#HDRCLI_NETRESTRICT">NetRestrict (client version)</A>
107 <P><A HREF="auarf129.htm#HDRFILESERVER">fileserver</A>
108 <P><A HREF="auarf145.htm#HDRFS_GETCLIENTADDRS">fs getclientaddrs</A>
109 <P>
110 <HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf159.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf161.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
111 <!-- Begin Footer Records  ========================================== -->
112 <P><HR><B> 
113 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
114 </B> 
115 <!-- End Footer Records  ============================================ -->
116 <A NAME="Bot_Of_Page"></A>
117 </BODY></HTML>