xref: /openbsd/usr.sbin/rpc.statd/rpc.statd.8 (revision 73471bf0)
1.\"	$OpenBSD: rpc.statd.8,v 1.3 2017/10/17 22:47:58 schwarze Exp $
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.\"
35.Dd $Mdocdate: October 17 2017 $
36.Dt RPC.STATD 8
37.Os
38.Sh NAME
39.Nm rpc.statd
40.Nd host status monitoring daemon
41.Sh SYNOPSIS
42.Nm
43.Op Fl d
44.Sh DESCRIPTION
45.Nm
46is a daemon which co-operates with rpc.statd daemons on other hosts to provide
47a status monitoring service.
48The daemon accepts requests from
49programs running on the local host (typically,
50.Xr rpc.lockd 8 ,
51the NFS file locking daemon) to monitor the status of specified hosts.
52If a monitored host crashes and restarts, the remote daemon will
53notify the local daemon, which in turn will notify the local program(s)
54which requested the monitoring service.
55Conversely if this host crashes and restarts when
56.Nm
57restarts, it will notify all of the hosts which were being monitored
58at the time of the crash.
59.Pp
60The options available are:
61.Bl -tag -width Ds
62.It Fl d
63Causes debugging information to be written to
64.Xr syslog 3 ,
65recording all RPC transactions to the daemon.
66These messages are logged with level
67.Dv LOG_DEBUG
68and facility
69.Dv LOG_DAEMON .
70Error conditions are logged irrespective of this option, using level
71.Dv LOG_ERR .
72.El
73.Pp
74The
75.Nm
76daemon must NOT be invoked by
77.Xr inetd 8
78because the protocol assumes that the daemon will run from system start time.
79Instead, it should be configured in
80.Xr rc.conf 8
81to run at system startup.
82.Sh FILES
83.Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact
84.It Pa /usr/include/rpcsvc/sm_inter.x
85RPC protocol specification used by local applications
86to register monitoring requests.
87.It Pa /var/db/statd.status
88Non-volatile record of currently monitored hosts.
89.El
90.Sh SEE ALSO
91.Xr syslog 3 ,
92.Xr rc.conf 8 ,
93.Xr rpc.lockd 8
94.Sh STANDARDS
95This implementation is based on the specification in
96the X/Open CAE Specification C218,
97"Protocols for X/Open PC Interworking: XNFS, Issue 4",
98ISBN 1 872630 66 9.
99.Sh HISTORY
100A version of
101.Nm
102appeared in SunOS 4.
103The current implementation was ported from
104.Nx
105to
106.Ox 4.4 .
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 retry 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