84199e83f91fffbb65be51b4ec4316944a387c3c
[nfs-utils.git] / 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.
6 .\" Modified by Lon Hohberger, 2000.
7 .TH rpc.statd 8 "08 Mar 2001"
8 .SH NAME
9 rpc.statd \- NSM status monitor
10 .SH SYNOPSIS
11 .B "/sbin/rpc.statd [-F] [-d] [-?] [-o " port "] [-p " port "] [-V]"
12 .SH DESCRIPTION
13 The
14 .B rpc.statd
15 server implements the NSM (Network Status Monitor) RPC protocol.
16 This service is somewhat misnomed, since it doesn't actually provide
17 active monitoring as one might suspect; instead, NSM implements a
18 reboot notification service. It is used by the NFS file locking service,
19 .BR rpc.lockd ,
20 to implement lock recovery when the NFS server machine crashes and
21 reboots.
22 .SS Operation
23 For each NFS client or server machine to be monitored,
24 .B rpc.statd
25 creates a file in
26 .BR /var/lib/nfs/sm .
27 When starting, it iterates through these files and notifies the
28 peer
29 .B rpc.statd
30 on those machines.
31 .SH OPTIONS
32 .TP
33 .B -F
34 By default,
35 .B rpc.statd
36 forks and puts itself in the background when started. The
37 .B -F
38 argument tells it to remain in the foreground. This option is
39 mainly for debugging purposes.
40 .TP
41 .B -d
42 By default,
43 .B rpc.statd
44 sends logging messages via
45 .BR syslog (3)
46 to system log.  The
47 .B -d
48 argument forces it to log verbose output to
49 .B stderr
50 instead. This option is mainly for debugging purposes, and may only
51 be used in conjunction with the
52 .B -F
53 parameter.
54 .TP
55 .BI "\-o," "" " \-\-outgoing\-port "  port
56 specify a port for
57 .B rpc.statd
58 to send outgoing status requests from.  By default,
59 .BR rpc.statd
60 will ask
61 .BR portmap (8)
62 to assign it a port number.  As of this writing, there is not
63 a standard port number that
64 .BR portmap
65 always or usually assigns.  Specifying
66 a port may be useful when implementing a firewall.
67 .TP
68 .BI "\-p," "" " \-\-port " port
69 specify a port for
70 .B rpc.statd
71 to listen on.  By default,
72 .BR rpc.statd
73 will ask
74 .BR portmap (8)
75 to assign it a port number.  As of this writing, there is not
76 a standard port number that
77 .BR portmap
78 always or usually assigns.  Specifying
79 a port may be useful when implementing a firewall.
80 .TP
81 .B -?
82 Causes
83 .B rpc.statd
84 to print out command-line help and exit.
85 .TP
86 .B -V
87 Causes
88 .B rpc.statd
89 to print out version information and exit.
90
91
92
93 .SH TCP_WRAPPERS SUPPORT
94 This
95 .B rpc.statd
96 version is protected by the
97 .B tcp_wrapper
98 library. You have to give the clients access to
99 .B rpc.statd
100 if they should be allowed to use it. To allow connects from clients of
101 the .bar.com domain you could use the following line in /etc/hosts.allow:
102
103 statd: .bar.com
104
105 You have to use the daemon name 
106 .B statd
107 for the daemon name (even if the binary has a different name). For the
108 client names you can only use the keyword ALL or IP addresses (NOT
109 host or domain names).
110
111 For further information please have a look at the
112 .BR tcpd (8),
113 .BR hosts_allow (5)
114 and
115 .BR hosts_access (5)
116 manual pages.
117
118 .SH FILES
119 .BR /var/lib/nfs/state
120 .br
121 .BR /var/lib/nfs/sm/*
122 .br
123 .BR /var/lib/nfs/sm.bak/*
124 .SH SEE ALSO
125 .BR rpc.nfsd(8),
126 .BR portmap(8)
127 .SH AUTHORS
128 .br
129 Jeff Uphoff <juphoff@transmeta.com>
130 .br
131 Olaf Kirch <okir@monad.swb.de>
132 .br
133 H.J. Lu <hjl@gnu.org>
134 .br
135 Lon Hohberger <hohberger@missioncriticallinux.com>