xref: /freebsd/usr.sbin/rpc.statd/rpc.statd.8 (revision 282a3889ebf826db9839be296ff1dd903f6d6d6e)
1.\" -*- nroff -*-
2.\"
3.\" Copyright (c) 1995 A.R.Gordon, andrew.gordon@net-tel.co.uk
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\" $FreeBSD$
35.\"
36.Dd April 3, 2007
37.Dt RPC.STATD 8
38.Os
39.Sh NAME
40.Nm rpc.statd
41.Nd host status monitoring daemon
42.Sh SYNOPSIS
43.Nm
44.Op Fl d
45.Op Fl p Ar port
46.Sh DESCRIPTION
47The
48.Nm
49utility
50is a daemon which co-operates with
51.Nm
52daemons on other hosts to provide
53a status monitoring service.
54The daemon accepts requests from
55programs running on the local host (typically,
56.Xr rpc.lockd 8 ,
57the NFS file locking daemon) to monitor the status of specified
58hosts.
59If a monitored host crashes and restarts, the remote daemon will
60notify the local daemon, which in turn will notify the local program(s)
61which requested the monitoring service.
62Conversely, if this host crashes
63and re-starts, when the
64.Nm
65re-starts, it will notify all of the hosts which were being monitored
66at the time of the crash.
67.Pp
68The following option is available:
69.Bl -tag -width indent
70.It Fl d
71Cause debugging information to be written to syslog, recording
72all RPC transactions to the daemon.
73These messages are logged with level
74LOG_DEBUG and facility LOG_DAEMON.
75Error conditions are logged irrespective
76of this option, using level LOG_ERR.
77.It Fl p
78The
79.Fl p
80option allow to force the daemon to bind to the specified
81.Ar port ,
82for both AF_INET and AF_INET6 address families.
83.El
84.Pp
85The
86.Nm
87utility must NOT be invoked by
88.Xr inetd 8
89because the protocol assumes that the daemon will run from system start time.
90Instead, it should be run from
91.Xr rc 8
92after the network has been started.
93.Sh FILES
94.Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact
95.It Pa /var/db/statd.status
96non-volatile record of currently monitored hosts.
97.It Pa /usr/include/rpcsvc/sm_inter.x
98RPC protocol specification used by local applications to register monitoring requests.
99.El
100.Sh SEE ALSO
101.Xr syslog 3 ,
102.Xr rc 8 ,
103.Xr rpc.lockd 8
104.Sh STANDARDS
105The implementation is based on the specification in X/Open CAE Specification
106C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9
107.Sh BUGS
108There is no means for the daemon to tell when a monitored host has
109disappeared permanently (e.g.\& catastrophic hardware failure), as opposed
110to transient failure of the host or an intermediate router.
111At present,
112it will re-try notification attempts at frequent intervals for 10 minutes,
113then hourly, and finally gives up after 24 hours.
114.Pp
115The protocol requires that symmetric monitor requests are made to both
116the local and remote daemon in order to establish a monitored relationship.
117This is convenient for the NFS locking protocol, but probably reduces the
118usefulness of the monitoring system for other applications.
119.Pp
120The current implementation uses more than 1Kbyte per monitored host in
121the status file (and also in VM).
122This may be inefficient for NFS servers
123with large numbers of clients.
124