utils/statd/statd.man

   1 .\"
   2 .\" statd(8)
   3 .\"
   4 .\" Copyright (C) 1999 Olaf Kirch <okir@monad.swb.de>
   5 .\" Modified by Jeffrey A. Uphoff, 1999, 2002, 2005.
   6 .\" Modified by Lon Hohberger, 2000.
   7 .\" Modified by Paul Clements, 2004.
   8 .TH rpc.statd 8 "31 Aug 2004"
   9 .SH NAME
  10 rpc.statd \- NSM status monitor
  11 .SH SYNOPSIS
  12 .B "/sbin/rpc.statd [-F] [-d] [-?] [-n " name "] [-o " port "] [-p " port "] [-H " prog "] [-V]"
  13 .SH DESCRIPTION
  14 The
  15 .B rpc.statd
  16 server implements the NSM (Network Status Monitor) RPC protocol.
  17 This service is somewhat misnamed, since it doesn't actually provide
  18 active monitoring as one might suspect; instead, NSM implements a
  19 reboot notification service. It is used by the NFS file locking service,
  20 .BR rpc.lockd ,
  21 to implement lock recovery when the NFS server machine crashes and
  22 reboots.
  23 .SS Operation
  24 For each NFS client or server machine to be monitored,
  25 .B rpc.statd
  26 creates a file in
  27 .BR /var/lib/nfs/sm .
  28 When starting, it iterates through these files and notifies the
  29 peer
  30 .B rpc.statd
  31 on those machines.
  32 .SH OPTIONS
  33 .TP
  34 .B -F
  35 By default,
  36 .B rpc.statd
  37 forks and puts itself in the background when started. The
  38 .B -F
  39 argument tells it to remain in the foreground. This option is
  40 mainly for debugging purposes.
  41 .TP
  42 .B -d
  43 By default,
  44 .B rpc.statd
  45 sends logging messages via
  46 .BR syslog (3)
  47 to system log.  The
  48 .B -d
  49 argument forces it to log verbose output to
  50 .B stderr
  51 instead. This option is mainly for debugging purposes, and may only
  52 be used in conjunction with the
  53 .B -F
  54 parameter.
  55 .TP
  56 .BI "\-n," "" " \-\-name " name
  57 specify a name for
  58 .B rpc.statd
  59 to use as the local hostname. By default,
  60 .BR rpc.statd
  61 will call
  62 .BR gethostname (2)
  63 to get the local hostname. Specifying
  64 a local hostname may be useful for machines with more than one
  65 interfaces.
  66 .TP
  67 .BI "\-o," "" " \-\-outgoing\-port "  port
  68 specify a port for
  69 .B rpc.statd
  70 to send outgoing status requests from.  By default,
  71 .BR rpc.statd
  72 will ask
  73 .BR portmap (8)
  74 to assign it a port number.  As of this writing, there is not
  75 a standard port number that
  76 .BR portmap
  77 always or usually assigns.  Specifying
  78 a port may be useful when implementing a firewall.
  79 .TP
  80 .BI "\-p," "" " \-\-port " port
  81 specify a port for
  82 .B rpc.statd
  83 to listen on.  By default,
  84 .BR rpc.statd
  85 will ask
  86 .BR portmap (8)
  87 to assign it a port number.  As of this writing, there is not
  88 a standard port number that
  89 .BR portmap
  90 always or usually assigns.  Specifying
  91 a port may be useful when implementing a firewall.
  92 .TP
  93 .BI "\-P," "" " \-\-state\-directory\-path "  directory
  94 specify a directory in which to place statd state information.
  95 If this option is not specified the default of
  96 .BR /var/lib/nfs
  97 is used.
  98 .TP
  99 .B -N
 100 Causes statd to run in the notify-only mode. When started in this mode, the
 101 statd program will check its state directory, send notifications to any
 102 monitored nodes, and exit once the notifications have been sent. This mode is
 103 used to enable Highly Available NFS implementations (i.e. HA-NFS).
 104 .TP
 105 .BI "\-H, " "" " \-\-ha-callout " prog
 106 Specify a high availability callout program, which will receive callouts
 107 for all client monitor and unmonitor requests. This allows
 108 .B rpc.statd
 109 to be used in a High Availability NFS (HA-NFS) environment. The
 110 program will be run with 3 arguments:  The first is either
 111 .B add-client
 112 or
 113 .B del-client
 114 depending on the reason for the callout.
 115 The second will be the name of the client.
 116 The third will be the name of the server as known to the client.
 117 .TP
 118 .B -?
 119 Causes
 120 .B rpc.statd
 121 to print out command-line help and exit.
 122 .TP
 123 .B -V
 124 Causes
 125 .B rpc.statd
 126 to print out version information and exit.
 127
 128
 129
 130 .SH TCP_WRAPPERS SUPPORT
 131 This
 132 .B rpc.statd
 133 version is protected by the
 134 .B tcp_wrapper
 135 library. You have to give the clients access to
 136 .B rpc.statd
 137 if they should be allowed to use it. To allow connects from clients of
 138 the .bar.com domain you could use the following line in /etc/hosts.allow:
 139
 140 statd: .bar.com
 141
 142 You have to use the daemon name
 143 .B statd
 144 for the daemon name (even if the binary has a different name).
 145
 146 For further information please have a look at the
 147 .BR tcpd (8)
 148 and
 149 .BR hosts_access (5)
 150 manual pages.
 151
 152 .SH SIGNALS
 153 .BR SIGUSR1
 154 causes
 155 .B rpc.statd
 156 to re-read the notify list from disk
 157 and send notifications to clients. This can be used in High Availability NFS
 158 (HA-NFS) environments to notify clients to reacquire file locks upon takeover
 159 of an NFS export from another server.
 160
 161 .SH FILES
 162 .BR /var/lib/nfs/state
 163 .br
 164 .BR /var/lib/nfs/sm/*
 165 .br
 166 .BR /var/lib/nfs/sm.bak/*
 167 .SH SEE ALSO
 168 .BR rpc.nfsd(8),
 169 .BR portmap(8)
 170 .SH AUTHORS
 171 .br
 172 Jeff Uphoff <juphoff@users.sourceforge.net>
 173 .br
 174 Olaf Kirch <okir@monad.swb.de>
 175 .br
 176 H.J. Lu <hjl@gnu.org>
 177 .br
 178 Lon Hohberger <hohberger@missioncriticallinux.com>
 179 .br
 180 Paul Clements <paul.clements@steeleye.com>