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 November 1, 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 h Ar bindip 46.Op Fl p Ar port 47.Sh DESCRIPTION 48The 49.Nm 50utility 51is a daemon which co-operates with 52.Nm 53daemons on other hosts to provide 54a status monitoring service. 55The daemon accepts requests from 56programs running on the local host (typically, 57.Xr rpc.lockd 8 , 58the NFS file locking daemon) to monitor the status of specified 59hosts. 60If a monitored host crashes and restarts, the remote daemon will 61notify the local daemon, which in turn will notify the local program(s) 62which requested the monitoring service. 63Conversely, if this host crashes 64and re-starts, when the 65.Nm 66re-starts, it will notify all of the hosts which were being monitored 67at the time of the crash. 68.Pp 69The following option is available: 70.Bl -tag -width indent 71.It Fl d 72Cause debugging information to be written to syslog, recording 73all RPC transactions to the daemon. 74These messages are logged with level 75LOG_DEBUG and facility LOG_DAEMON. 76Error conditions are logged irrespective 77of this option, using level LOG_ERR. 78.It Fl h Ar bindip 79Specify specific IP addresses to bind to. 80This option may be specified multiple times. 81If no 82.Fl h 83option is specified, 84.Nm 85will bind to 86.Dv INADDR_ANY . 87Note that when specifying IP addresses with 88.Fl h , 89.Nm 90will automatically add 91.Li 127.0.0.1 92and if IPv6 is enabled, 93.Li ::1 94to the list. 95.It Fl p 96The 97.Fl p 98option allow to force the daemon to bind to the specified 99.Ar port , 100for both AF_INET and AF_INET6 address families. 101.El 102.Pp 103The 104.Nm 105utility must NOT be invoked by 106.Xr inetd 8 107because the protocol assumes that the daemon will run from system start time. 108Instead, it should be run from 109.Xr rc 8 110after the network has been started. 111.Sh FILES 112.Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact 113.It Pa /var/db/statd.status 114non-volatile record of currently monitored hosts. 115.It Pa /usr/include/rpcsvc/sm_inter.x 116RPC protocol specification used by local applications to register monitoring requests. 117.El 118.Sh SEE ALSO 119.Xr syslog 3 , 120.Xr rc 8 , 121.Xr rpc.lockd 8 122.Sh STANDARDS 123The implementation is based on the specification in X/Open CAE Specification 124C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9 125.Sh BUGS 126There is no means for the daemon to tell when a monitored host has 127disappeared permanently (e.g.\& catastrophic hardware failure), as opposed 128to transient failure of the host or an intermediate router. 129At present, 130it will re-try notification attempts at frequent intervals for 10 minutes, 131then hourly, and finally gives up after 24 hours. 132.Pp 133The protocol requires that symmetric monitor requests are made to both 134the local and remote daemon in order to establish a monitored relationship. 135This is convenient for the NFS locking protocol, but probably reduces the 136usefulness of the monitoring system for other applications. 137.Pp 138The current implementation uses more than 1Kbyte per monitored host in 139the status file (and also in VM). 140This may be inefficient for NFS servers 141with large numbers of clients. 142