xref: /freebsd/usr.sbin/rpcbind/rpcbind.8 (revision 031beb4e239bfce798af17f5fe8dba8bcaf13d99)
1.\" @(#)rpcbind.1m 1.19 92/09/14 SMI; from SVr4
2.\" Copyright 1989 AT&T
3.\" Copyright 1991 Sun Microsystems, Inc.
4.\" $FreeBSD$
5.Dd April 19, 2017
6.Dt RPCBIND 8
7.Os
8.Sh NAME
9.Nm rpcbind
10.Nd universal addresses to RPC program number mapper
11.Sh SYNOPSIS
12.Nm
13.Op Fl 6adiLlswW
14.Op Fl h Ar bindip
15.Sh DESCRIPTION
16The
17.Nm
18utility is a server that converts
19.Tn RPC
20program numbers into
21universal addresses.
22It must be running on the host to be able to make
23.Tn RPC
24calls
25on a server on that machine.
26.Pp
27When an
28.Tn RPC
29service is started,
30it tells
31.Nm
32the address at which it is listening,
33and the
34.Tn RPC
35program numbers it is prepared to serve.
36When a client wishes to make an
37.Tn RPC
38call to a given program number,
39it first contacts
40.Nm
41on the server machine to determine
42the address where
43.Tn RPC
44requests should be sent.
45.Pp
46The
47.Nm
48utility should be started before any other RPC service.
49Normally, standard
50.Tn RPC
51servers are started by port monitors, so
52.Nm
53must be started before port monitors are invoked.
54.Pp
55When
56.Nm
57is started, it checks that certain name-to-address
58translation-calls function correctly.
59If they fail, the network configuration databases may be corrupt.
60Since
61.Tn RPC
62services cannot function correctly in this situation,
63.Nm
64reports the condition and terminates.
65.Pp
66The
67.Nm
68utility can only be started by the super-user.
69.Sh OPTIONS
70.Bl -tag -width indent
71.It Fl 6
72Bind to AF_INET6 (IPv6) addresses only.
73.It Fl a
74When debugging
75.Pq Fl d ,
76do an abort on errors.
77.It Fl d
78Run in debug mode.
79In this mode,
80.Nm
81will not fork when it starts, will print additional information
82during operation, and will abort on certain errors if
83.Fl a
84is also specified.
85With this option, the name-to-address translation consistency
86checks are shown in detail.
87.It Fl h Ar bindip
88IP addresses to bind to when servicing TCP and UDP requests.
89This option
90may be specified multiple times and is typically necessary when running
91on a multi-homed host.
92If no
93.Fl h
94option is specified,
95.Nm
96will bind to
97.Dv INADDR_ANY ,
98which could lead to problems on a multi-homed host due to
99.Nm
100returning a UDP packet from a different IP address than it was
101sent to.
102Note that when specifying IP addresses with
103.Fl h ,
104.Nm
105will automatically add
106.Li 127.0.0.1
107and if IPv6 is enabled,
108.Li ::1
109to the list.
110.It Fl i
111.Dq Insecure
112mode.
113Allow calls to SET and UNSET from any host.
114Normally
115.Nm
116accepts these requests only from the loopback interface for security reasons.
117This change is necessary for programs that were compiled with earlier
118versions of the rpc library and do not make those requests using the
119loopback interface.
120.It Fl L
121Allow old-style local connections over the loopback interface.
122Without this flag, local connections are only allowed over a local socket,
123.Pa /var/run/rpcbind.sock .
124.It Fl l
125Turn on libwrap connection logging.
126.It Fl s
127Cause
128.Nm
129to change to the user daemon as soon as possible.
130This causes
131.Nm
132to use non-privileged ports for outgoing connections, preventing non-privileged
133clients from using
134.Nm
135to connect to services from a privileged port.
136.It Fl W
137Enable libwrap (TCP wrappers) support.
138.It Fl w
139Enable the warmstart feature.
140.Pp
141The warmstart feature saves RPC registrations on termination.
142Any saved RPC registrations are restored on restart if
143.Fl w
144is specified.
145This feature helps avoid RPC service interruption when restarting
146.Nm .
147warmstart support must be compiled in to
148.Nm .
149Portmap registrations are stored in
150.Pa /tmp/portmap.file .
151.Nm
152registrations are stored in
153.Pa /tmp/rpcbind.file .
154.El
155.Sh NOTES
156All RPC servers must be restarted if
157.Nm
158is restarted.
159.Sh FILES
160.Bl -tag -width /var/run/rpcbind.sock -compact
161.It Pa /tmp/portmap.file
162saved portmap registrations file.
163.It Pa /tmp/rpcbind.file
164saved
165.Nm
166registrations file.
167.It Pa /var/run/rpcbind.sock
168socket used for local connections.
169.El
170.Sh SEE ALSO
171.Xr rpcbind 3 ,
172.Xr netconfig 5 ,
173.Xr rpcinfo 8
174