usr.sbin/rpc.statd/rpc.statd.8

   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: src/usr.sbin/rpc.statd/rpc.statd.8,v 1.7.2.4 2003/03/11 22:31:32 trhodes Exp $
  31 .\" $DragonFly: src/usr.sbin/rpc.statd/rpc.statd.8,v 1.3 2006/02/17 19:40:24 swildner Exp $
  32 .\"
  33 .Dd September 19, 1995
  34 .Dt RPC.STATD 8
  35 .Os
  36 .Sh NAME
  37 .Nm rpc.statd
  38 .Nd host status monitoring daemon
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Op Fl d
  42 .Sh DESCRIPTION
  43 The
  44 .Nm
  45 utility
  46 is a daemon which co-operates with
  47 .Nm
  48 daemons on other hosts to provide
  49 a status monitoring service.  The daemon accepts requests from
  50 programs running on the local host (typically,
  51 .Xr rpc.lockd 8 ,
  52 the NFS file locking daemon) to monitor the status of specified
  53 hosts.  If a monitored host crashes and restarts, the remote daemon will
  54 notify the local daemon, which in turn will notify the local program(s)
  55 which requested the monitoring service.  Conversely, if this host crashes
  56 and re-starts, when the
  57 .Nm
  58 re-starts, it will notify all of the hosts which were being monitored
  59 at the time of the crash.
  60 .Pp
  61 The following option is available:
  62 .Bl -tag -width indent
  63 .It Fl d
  64 Cause debugging information to be written to syslog, recording
  65 all RPC transactions to the daemon.  These messages are logged with level
  66 LOG_DEBUG and facility LOG_DAEMON.  Error conditions are logged irrespective
  67 of this option, using level LOG_ERR.
  68 .El
  69 .Pp
  70 The
  71 .Nm
  72 utility must NOT be invoked by
  73 .Xr inetd 8
  74 because the protocol assumes that the daemon will run from system start time.
  75 Instead, it should be run from
  76 .Xr rc 8
  77 after the network has been started.
  78 .Sh FILES
  79 .Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact
  80 .It Pa /var/db/statd.status
  81 non-volatile record of currently monitored hosts.
  82 .It Pa /usr/include/rpcsvc/sm_inter.x
  83 RPC protocol specification used by local applications to register monitoring requests.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr syslog 3 ,
  87 .Xr rc 8 ,
  88 .Xr rpc.lockd 8
  89 .Sh STANDARDS
  90 The implementation is based on the specification in X/Open CAE Specification
  91 C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9
  92 .Sh BUGS
  93 There is no means for the daemon to tell when a monitored host has
  94 disappeared permanently (eg. catastrophic hardware failure), as opposed
  95 to transient failure of the host or an intermediate router.  At present,
  96 it will re-try notification attempts at frequent intervals for 10 minutes,
  97 then hourly, and finally gives up after 24 hours.
  98 .Pp
  99 The protocol requires that symmetric monitor requests are made to both
 100 the local and remote daemon in order to establish a monitored relationship.
 101 This is convenient for the NFS locking protocol, but probably reduces the
 102 usefulness of the monitoring system for other applications.
 103 .Pp
 104 The current implementation uses more than 1Kbyte per monitored host in
 105 the status file (and also in VM).  This may be inefficient for NFS servers
 106 with large numbers of clients.