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