[apple/network_cmds.git] / rpc_statd.tproj / rpc.statd.8

.\" -*- nroff -*-
.\"
.\" Copyright (c) 1995 A.R.Gordon, andrew.gordon@net-tel.co.uk
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd September 19, 1995
.Dt RPC.STATD 8
.Os
.Sh NAME
.Nm rpc.statd
.Nd host status monitoring daemon
.Sh SYNOPSIS
.Nm
.Op Fl d
.Sh DESCRIPTION
The
.Nm
utility
is a daemon which co-operates with
.Nm
daemons on other hosts to provide
a status monitoring service.  The daemon accepts requests from
programs running on the local host (typically,
.Xr rpc.lockd 8 ,
the NFS file locking daemon) to monitor the status of specified
hosts.  If a monitored host crashes and restarts, the remote daemon will
notify the local daemon, which in turn will notify the local program(s)
which requested the monitoring service.  Conversely, if this host crashes
and re-starts, when the
.Nm
re-starts, it will notify all of the hosts which were being monitored
at the time of the crash.
.Pp
The following option is available:
.Bl -tag -width indent
.It Fl d
Cause debugging information to be written to syslog, recording
all RPC transactions to the daemon.  These messages are logged with level
LOG_DEBUG and facility LOG_DAEMON.  Error conditions are logged irrespective
of this option, using level LOG_ERR.
.It Fl n
Just send SM_NOTIFY messages to notify any hosts of a restart.
Do not start daemon.
.El
.Pp
The
.Nm
utility must NOT be invoked by
.Xr inetd 8
because the protocol assumes that the daemon will run from system start time.
Instead, it should be run from
.Xr rc 8
after the network has been started.
.Sh FILES
.Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact
.It Pa /var/db/statd.status
non-volatile record of currently monitored hosts.
.It Pa /usr/include/rpcsvc/sm_inter.x
RPC protocol specification used by local applications to register monitoring requests.
.El
.Sh SEE ALSO
.Xr syslog 3 ,
.Xr rc 8 ,
.Xr rpc.lockd 8
.Sh BUGS
There is no means for the daemon to tell when a monitored host has
disappeared permanently (eg. catastrophic hardware failure), as opposed
to transient failure of the host or an intermediate router.  At present,
it will re-try notification attempts at frequent intervals for 10 minutes,
then hourly, and finally gives up after 24 hours.
.Pp
The protocol requires that symmetric monitor requests are made to both
the local and remote daemon in order to establish a monitored relationship.
This is convenient for the NFS locking protocol, but probably reduces the
usefulness of the monitoring system for other applications.
.Pp
The current implementation uses more than 1Kbyte per monitored host in
the status file (and also in VM).  This may be inefficient for NFS servers
with large numbers of clients.
.Sh STANDARDS
The implementation is based on the specification in X/Open CAE Specification
C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9
Commit	Line	Data
ac2f15b3 A	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	.\" $FreeBSD$
	35	.\"
	36	.Dd September 19, 1995
	37	.Dt RPC.STATD 8
	38	.Os
	39	.Sh NAME
	40	.Nm rpc.statd
	41	.Nd host status monitoring daemon
	42	.Sh SYNOPSIS
	43	.Nm
	44	.Op Fl d
	45	.Sh DESCRIPTION
	46	The
	47	.Nm
	48	utility
	49	is a daemon which co-operates with
	50	.Nm
	51	daemons on other hosts to provide
	52	a status monitoring service. The daemon accepts requests from
	53	programs running on the local host (typically,
	54	.Xr rpc.lockd 8 ,
	55	the NFS file locking daemon) to monitor the status of specified
	56	hosts. If a monitored host crashes and restarts, the remote daemon will
	57	notify the local daemon, which in turn will notify the local program(s)
	58	which requested the monitoring service. Conversely, if this host crashes
	59	and re-starts, when the
	60	.Nm
	61	re-starts, it will notify all of the hosts which were being monitored
	62	at the time of the crash.
	63	.Pp
	64	The following option is available:
65	.Bl -tag -width indent
66	.It Fl d
67	Cause debugging information to be written to syslog, recording
68	all RPC transactions to the daemon. These messages are logged with level
69	LOG_DEBUG and facility LOG_DAEMON. Error conditions are logged irrespective
70	of this option, using level LOG_ERR.
71	.It Fl n
72	Just send SM_NOTIFY messages to notify any hosts of a restart.
73	Do not start daemon.
74	.El
75	.Pp
76	The
77	.Nm
78	utility must NOT be invoked by
79	.Xr inetd 8
80	because the protocol assumes that the daemon will run from system start time.
81	Instead, it should be run from
82	.Xr rc 8
83	after the network has been started.
84	.Sh FILES
85	.Bl -tag -width /usr/include/rpcsvc/sm_inter.x -compact
86	.It Pa /var/db/statd.status
87	non-volatile record of currently monitored hosts.
88	.It Pa /usr/include/rpcsvc/sm_inter.x
89	RPC protocol specification used by local applications to register monitoring requests.
90	.El
91	.Sh SEE ALSO
92	.Xr syslog 3 ,
93	.Xr rc 8 ,
94	.Xr rpc.lockd 8
95	.Sh BUGS
96	There is no means for the daemon to tell when a monitored host has
97	disappeared permanently (eg. catastrophic hardware failure), as opposed
98	to transient failure of the host or an intermediate router. At present,
99	it will re-try notification attempts at frequent intervals for 10 minutes,
100	then hourly, and finally gives up after 24 hours.
101	.Pp
102	The protocol requires that symmetric monitor requests are made to both
103	the local and remote daemon in order to establish a monitored relationship.
104	This is convenient for the NFS locking protocol, but probably reduces the
105	usefulness of the monitoring system for other applications.
106	.Pp
107	The current implementation uses more than 1Kbyte per monitored host in
108	the status file (and also in VM). This may be inefficient for NFS servers
109	with large numbers of clients.
110	.Sh STANDARDS
111	The implementation is based on the specification in X/Open CAE Specification
112	C218, "Protocols for X/Open PC Interworking: XNFS, Issue 4", ISBN 1 872630 66 9