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