.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "NETINFO 5"
.TH NETINFO 5 "2012-01-23" "OpenAFS" "AFS File Reference"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
NetInfo \- Defines machine interfaces to register with AFS servers
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
There are two \fINetInfo\fR files, one for an \s-1AFS\s0 client and one for an \s-1AFS\s0
File Server or database server.  The \s-1AFS\s0 client \fINetInfo\fR file specifies
the \s-1IP\s0 addresses that the client should register with the File Servers it
connects to.  The server \fINetInfo\fR file specifies what interfaces should
be registered with \s-1AFS\s0 Database Servers or used to talk to other database
servers.
.SS "Client NetInfo"
.IX Subsection "Client NetInfo"
The client \fINetInfo\fR file lists the \s-1IP\s0 addresses of one or more of the
local machine's network interfaces. If it exists in the \fI/usr/vice/etc\fR
directory when the Cache Manager initializes, the Cache Manager uses its
contents as the basis for a list of local interfaces. Otherwise, the Cache
Manager uses the list of interfaces configured with the operating
system. It then removes from the list any addresses that appear in the
\&\fI/usr/vice/etc/NetRestrict\fR file, if it exists. The Cache Manager records
the resulting list in kernel memory. The first time it establishes a
connection to a File Server, it registers the list with the File Server.
.PP
The File Server uses the addresses when it initiates a remote procedure
call (\s-1RPC\s0) to the Cache Manager (as opposed to responding to an \s-1RPC\s0 sent
by the Cache Manager). There are two common circumstances in which the
File Server initiates RPCs: when it breaks callbacks and when it pings the
client machine to verify that the Cache Manager is still accessible.
.PP
The \fINetInfo\fR file is in \s-1ASCII\s0 format. One of the machine's \s-1IP\s0 addresses
appears on each line, in dotted decimal format. The File Server initially
uses the address that appears first in the list. The order of the
remaining addresses is not significant: if an \s-1RPC\s0 to the first interface
fails, the File Server simultaneously sends RPCs to all of the other
interfaces in the list.  Whichever interface replies first is the one to
which the File Server then sends pings and RPCs to break callbacks.
.PP
To prohibit the Cache Manager absolutely from using one or more addresses,
list them in the \fINetRestrict\fR file. To display the addresses the Cache
Manager is currently registering with File Servers, use the \fBfs
getclientaddrs\fR command. To replace the current list of interfaces with a
new one between reboots of the client machine, use the \fBfs
setclientaddrs\fR command.
.SS "Server NetInfo"
.IX Subsection "Server NetInfo"
The server \fINetInfo\fR file, if present in the \fI/usr/afs/local\fR directory,
defines the following:
.IP "\(bu" 4
On a file server machine, the local interfaces that the File Server
(\fBfileserver\fR process) can register in the Volume Location Database
(\s-1VLDB\s0) at initialization time.
.IP "\(bu" 4
On a database server machine, the local interfaces that the Ubik database
synchronization library uses when communicating with the database server
processes running on other database server machines.
.PP
If the \fINetInfo\fR file exists when the File Server initializes, the File
Server uses its contents as the basis for a list of interfaces to register
in the \s-1VLDB\s0. Otherwise, it uses the list of network interfaces configured
with the operating system. It then removes from the list any addresses
that appear in the \fI/usr/afs/local/NetRestrict\fR file, if it exists. The
File Server records the resulting list in the \fI/usr/afs/local/sysid\fR file
and registers the interfaces in the \s-1VLDB\s0. The database server processes
use a similar procedure when initializing, to determine which interfaces
to use for communication with the peer processes on other database
machines in the cell.
.PP
The \fINetInfo\fR file is in \s-1ASCII\s0 format. One of the machine's \s-1IP\s0 addresses
appears on each line, in dotted decimal format. The order of the addresses
is not significant.
.PP
Optionally, the File Server can be forced to use an \s-1IP\s0 address that does
not belong to one of the server interfaces. To do this, add a line to the
\&\fINetInfo\fR file with the \s-1IP\s0 address prefixed with \*(L"f\*(R" and a space. This is
useful when the File Server is on the internal side of a \s-1NAT\s0 firewall.
.PP
To display the File Server interface addresses registered in the \s-1VLDB\s0, use
the \fBvos listaddrs\fR command.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
If the File Server is on the internal side of a \s-1NAT\s0 firewall, where it
serves internal clients using the \s-1IP\s0 address 192.168.1.123 and external
clients using the \s-1IP\s0 address 10.1.1.321, then the \fINetInfo\fR file should
contain the following:
.PP
.Vb 2
\&   192.168.1.123
\&   f 10.1.1.321
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fINetRestrict\fR\|(5),
\&\fIsysid\fR\|(5),
\&\fIvldb.DB0\fR\|(5),
\&\fIfileserver\fR\|(8),
\&\fIfs_getclientaddrs\fR\|(1),
\&\fIfs_setclientaddrs\fR\|(1),
\&\fIvos_listaddrs\fR\|(1)
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
\&\s-1IBM\s0 Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
.PP
This documentation is covered by the \s-1IBM\s0 Public License Version 1.0.  It was
converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ
Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.