2001-08-17 Ragnar Kjørstad <nfs@ragnark.vestdata.no>
[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] [-?] [-n " name "] [-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 "\-n," "" " \-\-name " name 
56 specify a name for
57 .B rpc.statd
58 to use as the local hostname. By default,
59 .BR rpc.statd
60 will call
61 .BR gethostname (2)
62 to get the local hostname. Specifying
63 a local hostname may be useful for machines with more than one
64 interfaces.
65 .TP
66 .BI "\-o," "" " \-\-outgoing\-port "  port
67 specify a port for
68 .B rpc.statd
69 to send outgoing status requests from.  By default,
70 .BR rpc.statd
71 will ask
72 .BR portmap (8)
73 to assign it a port number.  As of this writing, there is not
74 a standard port number that
75 .BR portmap
76 always or usually assigns.  Specifying
77 a port may be useful when implementing a firewall.
78 .TP
79 .BI "\-p," "" " \-\-port " port
80 specify a port for
81 .B rpc.statd
82 to listen on.  By default,
83 .BR rpc.statd
84 will ask
85 .BR portmap (8)
86 to assign it a port number.  As of this writing, there is not
87 a standard port number that
88 .BR portmap
89 always or usually assigns.  Specifying
90 a port may be useful when implementing a firewall.
91 .TP
92 .B -?
93 Causes
94 .B rpc.statd
95 to print out command-line help and exit.
96 .TP
97 .B -V
98 Causes
99 .B rpc.statd
100 to print out version information and exit.
101
102
103
104 .SH TCP_WRAPPERS SUPPORT
105 This
106 .B rpc.statd
107 version is protected by the
108 .B tcp_wrapper
109 library. You have to give the clients access to
110 .B rpc.statd
111 if they should be allowed to use it. To allow connects from clients of
112 the .bar.com domain you could use the following line in /etc/hosts.allow:
113
114 statd: .bar.com
115
116 You have to use the daemon name 
117 .B statd
118 for the daemon name (even if the binary has a different name). For the
119 client names you can only use the keyword ALL or IP addresses (NOT
120 host or domain names).
121
122 For further information please have a look at the
123 .BR tcpd (8),
124 .BR hosts_allow (5)
125 and
126 .BR hosts_access (5)
127 manual pages.
128
129 .SH FILES
130 .BR /var/lib/nfs/state
131 .br
132 .BR /var/lib/nfs/sm/*
133 .br
134 .BR /var/lib/nfs/sm.bak/*
135 .SH SEE ALSO
136 .BR rpc.nfsd(8),
137 .BR portmap(8)
138 .SH AUTHORS
139 .br
140 Jeff Uphoff <juphoff@transmeta.com>
141 .br
142 Olaf Kirch <okir@monad.swb.de>
143 .br
144 H.J. Lu <hjl@gnu.org>
145 .br
146 Lon Hohberger <hohberger@missioncriticallinux.com>