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

   1 .\"     $NetBSD: rpc.statd.8,v 1.5 2002/12/21 12:47:21 wiz 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 September 19, 1995
  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
  46 is a daemon which co-operates with rpc.statd daemons on other hosts to provide
  47 a status monitoring service.  The daemon accepts requests from
  48 programs running on the local host (typically,
  49 .Xr rpc.lockd 8 ,
  50 the NFS file locking daemon) to monitor the status of specified
  51 hosts.  If a monitored host crashes and restarts, the remote daemon will
  52 notify the local daemon, which in turn will notify the local program(s)
  53 which requested the monitoring service.  Conversely, if this host crashes
  54 and restarts, when
  55 .Nm
  56 restarts, it will notify all of the hosts which were being monitored
  57 at the time of the crash.
  58 .Pp
  59 Options and operands available for
  60 .Nm
  61 :
  62 .Bl -tag -width Ds
  63 .It Fl d
  64 The
  65 .Fl d
  66 option causes debugging information to be written to syslog, recording
  67 all RPC transactions to the daemon.  These messages are logged with level
  68 LOG_DEBUG and facility LOG_DAEMON.  Error conditions are logged irrespective
  69 of this option, using level LOG_ERR.
  70 .El
  71 .Pp
  72 The
  73 .Nm
  74 daemon must NOT be invoked by
  75 .Xr inetd 8
  76 because the protocol assumes that the daemon will run from system start time.
  77 Instead, it should be configured in
  78 .Xr rc.conf 5
  79 to run at system startup.
  80 .Sh FILES
  81 .Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact
  82 .It Pa /var/db/statd.status
  83 non-volatile record of currently monitored hosts.
  84 .It Pa /usr/include/rpcsvc/sm_inter.x
  85 RPC protocol specification used by local applications to register monitoring requests.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr syslog 3 ,
  89 .Xr rc.conf 5 ,
  90 .Xr rpc.lockd 8
  91 .Sh STANDARDS
  92 The implementation is based on the specification in X/Open CAE Specification
  93 C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9
  94 .Sh HISTORY
  95 A version of
  96 .Nm
  97 appeared in
  98 .Tn SunOS 4 .
  99 .Sh BUGS
 100 There is no means for the daemon to tell when a monitored host has
 101 disappeared permanently (e.g., catastrophic hardware failure), as opposed
 102 to transient failure of the host or an intermediate router.  At present,
 103 it will retry notification attempts at frequent intervals for 10 minutes,
 104 then hourly, and finally gives up after 24 hours.
 105 .Pp
 106 The protocol requires that symmetric monitor requests are made to both
 107 the local and remote daemon in order to establish a monitored relationship.
 108 This is convenient for the NFS locking protocol, but probably reduces the
 109 usefulness of the monitoring system for other applications.
 110 .Pp
 111 The current implementation uses more than 1Kbyte per monitored host in
 112 the status file (and also in VM).  This may be inefficient for NFS servers
 113 with large numbers of clients.