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 "rpc.statd [-FNL] [-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 normally runs
  29 .B sm-notify
  30 to iterate through these files and notify the
  31 peer
  32 .B rpc.statd
  33 on those machines.
  34 .SH OPTIONS
  35 .TP
  36 .B -F
  37 By default,
  38 .B rpc.statd
  39 forks and puts itself in the background when started. The
  40 .B -F
  41 argument tells it to remain in the foreground. This option is
  42 mainly for debugging purposes.
  43 .TP
  44 .B -d
  45 By default,
  46 .B rpc.statd
  47 sends logging messages via
  48 .BR syslog (3)
  49 to system log.  The
  50 .B -d
  51 argument forces it to log verbose output to
  52 .B stderr
  53 instead. This option is mainly for debugging purposes, and may only
  54 be used in conjunction with the
  55 .B -F
  56 parameter.
  57 .TP
  58 .BI "\-n," "" " \-\-name " name
  59 specify a name for
  60 .B rpc.statd
  61 to use as the local hostname. By default,
  62 .BR rpc.statd
  63 will call
  64 .BR gethostname (2)
  65 to get the local hostname. Specifying
  66 a local hostname may be useful for machines with more than one
  67 interfaces.
  68 .TP
  69 .BI "\-o," "" " \-\-outgoing\-port "  port
  70 specify a port for
  71 .B rpc.statd
  72 to send outgoing status requests from.  By default,
  73 .BR rpc.statd
  74 will ask
  75 .BR portmap (8)
  76 to assign it a port number.  As of this writing, there is not
  77 a standard port number that
  78 .BR portmap
  79 always or usually assigns.  Specifying
  80 a port may be useful when implementing a firewall.
  81 .TP
  82 .BI "\-p," "" " \-\-port " port
  83 specify a port for
  84 .B rpc.statd
  85 to listen on.  By default,
  86 .BR rpc.statd
  87 will ask
  88 .BR portmap (8)
  89 to assign it a port number.  As of this writing, there is not
  90 a standard port number that
  91 .BR portmap
  92 always or usually assigns.  Specifying
  93 a port may be useful when implementing a firewall.
  94 .TP
  95 .BI "\-P," "" " \-\-state\-directory\-path "  directory
  96 specify a directory in which to place statd state information.
  97 If this option is not specified the default of
  98 .BR /var/lib/nfs
  99 is used.
 100 .TP
 101 .B -N
 102 Causes statd to run in the notify-only mode. When started in this mode, the
 103 statd program will check its state directory, send notifications to any
 104 monitored nodes, and exit once the notifications have been sent. This mode is
 105 used to enable Highly Available NFS implementations (i.e. HA-NFS).
 106 This mode is deprecated \-
 107 .B sm-notify
 108 should be used directly instead.
 109 .TP
 110 .BR -L , " --no-notify
 111 Inhibits the running of
 112 .BR sm-notify .
 113 If
 114 .B sm-notify
 115 is run by some other script at boot time, there is no need for
 116 .B statd
 117 to start sm-notify itself.  This can be appropriate if starting of
 118 statd needs to be delayed until it is actually need.  In such cases
 119 .B sm-notify
 120 should still be run at boot time.
 121 .TP
 122 .BI "\-H, " "" " \-\-ha-callout " prog
 123 Specify a high availability callout program, which will receive callouts
 124 for all client monitor and unmonitor requests. This allows
 125 .B rpc.statd
 126 to be used in a High Availability NFS (HA-NFS) environment. The
 127 program will be run with 3 arguments:  The first is either
 128 .B add-client
 129 or
 130 .B del-client
 131 depending on the reason for the callout.
 132 The second will be the name of the client.
 133 The third will be the name of the server as known to the client.
 134 .TP
 135 .B -?
 136 Causes
 137 .B rpc.statd
 138 to print out command-line help and exit.
 139 .TP
 140 .B -V
 141 Causes
 142 .B rpc.statd
 143 to print out version information and exit.
 144
 145
 146
 147 .SH TCP_WRAPPERS SUPPORT
 148 This
 149 .B rpc.statd
 150 version is protected by the
 151 .B tcp_wrapper
 152 library. You have to give the clients access to
 153 .B rpc.statd
 154 if they should be allowed to use it. To allow connects from clients of
 155 the .bar.com domain you could use the following line in /etc/hosts.allow:
 156
 157 statd: .bar.com
 158
 159 You have to use the daemon name
 160 .B statd
 161 for the daemon name (even if the binary has a different name).
 162
 163 For further information please have a look at the
 164 .BR tcpd (8)
 165 and
 166 .BR hosts_access (5)
 167 manual pages.
 168
 169 .SH SIGNALS
 170 .BR SIGUSR1
 171 causes
 172 .B rpc.statd
 173 to re-read the notify list from disk
 174 and send notifications to clients. This can be used in High Availability NFS
 175 (HA-NFS) environments to notify clients to reacquire file locks upon takeover
 176 of an NFS export from another server.
 177
 178 .SH FILES
 179 .BR /var/lib/nfs/state
 180 .br
 181 .BR /var/lib/nfs/sm/*
 182 .br
 183 .BR /var/lib/nfs/sm.bak/*
 184 .SH SEE ALSO
 185 .BR rpc.nfsd(8),
 186 .BR portmap(8)
 187 .SH AUTHORS
 188 .br
 189 Jeff Uphoff <juphoff@users.sourceforge.net>
 190 .br
 191 Olaf Kirch <okir@monad.swb.de>
 192 .br
 193 H.J. Lu <hjl@gnu.org>
 194 .br
 195 Lon Hohberger <hohberger@missioncriticallinux.com>
 196 .br
 197 Paul Clements <paul.clements@steeleye.com>