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