mirror of
https://git.FreeBSD.org/src.git
synced 2025-01-17 15:27:36 +00:00
man(7) -> mdoc(7).
This commit is contained in:
Ruslan Ermilov
parent
df32668400
commit
8d79d770c5
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=71219
@ -25,105 +25,145 @@
|
||||
.\" @(#) $FreeBSD$
|
||||
.\"
|
||||
.\"
|
||||
.de EX \"Begin example
|
||||
.ne 5
|
||||
.if n .sp 1
|
||||
.if t .sp .5
|
||||
.nf
|
||||
.in +.5i
|
||||
..
|
||||
.de EE
|
||||
.fi
|
||||
.in -.5i
|
||||
.if n .sp 1
|
||||
.if t .sp .5
|
||||
..
|
||||
.TH ATMARPD 8 "1998-08-04" "HARP"
|
||||
|
||||
.SH NAME
|
||||
atmarpd \- ATMARP/SCSP interface daemon
|
||||
.SH SYNOPSIS
|
||||
.B atmarpd
|
||||
[\fB-l\fP <log file>]
|
||||
[\fB-d\fP]
|
||||
<netif> ...
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fIAtmarpd\fP provides an interface between the ATMARP server in the
|
||||
.Dd August 04, 1998
|
||||
.Dt ATMARPD 8
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm atmarpd
|
||||
.Nd "ATMARP/SCSP interface daemon"
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl d
|
||||
.Op Fl l Aq Ar log_file
|
||||
.Aq Ar net_intf
|
||||
.Ar ...
|
||||
.Sh DESCRIPTION
|
||||
.Nm Atmarpd
|
||||
provides an interface between the ATMARP server in the
|
||||
kernel and the SCSP daemon for the Host ATM Research Platform
|
||||
(HARP) networking software.
|
||||
\fIAtmarpd\fP reads the ATMARP cache from the kernel periodically
|
||||
and passes any updated entries to \fIscspd\fP so they will be
|
||||
.Nm Atmarpd
|
||||
reads the ATMARP cache from the kernel periodically
|
||||
and passes any updated entries to
|
||||
.Xr scspd 8
|
||||
so they will be
|
||||
propagated to remote servers.
|
||||
It also accepts updated entries that remote servers have sent to
|
||||
\fIscspd\fP and, if they are
|
||||
.Xr scspd 8
|
||||
and, if they are
|
||||
new or more up to date than current entries, installs them
|
||||
in the kernel's ATMARP cache.
|
||||
Both \fIatmarpd\fP and \fIscspd\fP must be running before any ATMARP
|
||||
cache synchronization can take place.
|
||||
|
||||
When \fIatmarpd\fP starts, it parses its command line and puts
|
||||
Both
|
||||
.Nm
|
||||
and
|
||||
.Xr scspd 8
|
||||
must be running before any ATMARP cache synchronization can take place.
|
||||
.Pp
|
||||
When
|
||||
.Nm
|
||||
starts, it parses its command line and puts
|
||||
itself into the background.
|
||||
|
||||
.Pp
|
||||
The command-line options are:
|
||||
.IP "\fB-l\fP <log file>" 15
|
||||
Specifies that \fIatmarpd\fP is to write log messages to the
|
||||
file named <log file> rather than to the system log.
|
||||
.IP "\fB-d\fP" 15
|
||||
Specifies that \fIatmarpd\fP is to be run in debug mode.
|
||||
In debug mode, \fIatmarpd\fP is not put into the background.
|
||||
.Bl -tag -width "-l <log_file>"
|
||||
.It Fl l Aq Ar log_file
|
||||
Specifies that
|
||||
.Nm
|
||||
is to write log messages to the
|
||||
file named
|
||||
.Aq Ar log_file
|
||||
rather than to the system log.
|
||||
.It Fl d
|
||||
Specifies that
|
||||
.Nm
|
||||
is to be run in debug mode.
|
||||
In debug mode,
|
||||
.Nm
|
||||
is not put into the background.
|
||||
Log messages are written to standard output instead of to
|
||||
the log file.
|
||||
.IP "<netif>" 15
|
||||
.It Aq Ar net_intf
|
||||
Specifies the network interface(s) for which the host is providing
|
||||
ATMARP service and whose caches are to be synchronized using SCSP.
|
||||
If multiple network interface names are specified, \fIatmarpd\fP
|
||||
will provide an interface to \fIscspd\fP for the servers on all the
|
||||
If multiple network interface names are specified,
|
||||
.Nm
|
||||
will provide an interface to
|
||||
.Xr scspd 8
|
||||
for the servers on all the
|
||||
specified interfaces.
|
||||
|
||||
.SH SIGNAL PROCESSING
|
||||
The following signals can be used to control \fIatmarpd\fP:
|
||||
|
||||
.IP \fBSIGINT\fP 10
|
||||
.El
|
||||
.Sh SIGNAL PROCESSING
|
||||
The following signals can be used to control
|
||||
.Nm :
|
||||
.Bl -tag -width indent
|
||||
.It Dv SIGINT
|
||||
Dump debugging information to a file.
|
||||
When it receives a SIGINT signal, \fIatmarpd\fP dumps a summary of
|
||||
its control blocks to a text file (see "\fBFILES\fB").
|
||||
|
||||
.SH FILES
|
||||
|
||||
.IP "/tmp/atmarpd.<pid>.<seq>.out"
|
||||
When it receives a
|
||||
.Dv SIGINT
|
||||
signal,
|
||||
.Nm
|
||||
dumps a summary of
|
||||
its control blocks to a text file (see
|
||||
.Sx FILES ) .
|
||||
.El
|
||||
.Sh FILES
|
||||
.Bl -tag -width indent
|
||||
.It Xo
|
||||
.Sm off
|
||||
.Pa /tmp/atmarpd.
|
||||
.Aq Ar pid
|
||||
.Pa \&.
|
||||
.Aq Ar seq
|
||||
.Pa .out
|
||||
.Sm on
|
||||
.Xc
|
||||
Debugging information dump file name.
|
||||
\fIAtmarpd\fP writes a summary of its control blocks to this file
|
||||
when it receives a SIGINT signal.
|
||||
<pid> is the process ID of the daemon and <seq> is a sequence
|
||||
.Nm Atmarpd
|
||||
writes a summary of its control blocks to this file
|
||||
when it receives a
|
||||
.Dv SIGINT
|
||||
signal.
|
||||
.Aq Ar pid
|
||||
is the process ID of the daemon and
|
||||
.Aq Ar seq
|
||||
is a sequence
|
||||
number which is incremented every time a dump is taken.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
\fIatm\fP (8);
|
||||
\fIscspd\fP (8);
|
||||
RFC 1577, \fIClassical IP and ARP over ATM\fP;
|
||||
RFC 2225, \fIClassical IP and ARP over ATM\fP;
|
||||
RFC 2334, \fIServer Cache Synchronization Protocol (SCSP)\fP;
|
||||
draft-ietf-ion-scsp-atmarpd-00.txt, \fIA Distributed ATMARP Service
|
||||
Using SCSP\fP.
|
||||
|
||||
|
||||
.SH BUGS
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr atm 8 ,
|
||||
.Xr scspd 8
|
||||
.Rs
|
||||
.%T "Classical IP and ARP over ATM"
|
||||
.%O "RFC 1577"
|
||||
.Re
|
||||
.Rs
|
||||
.%T "Classical IP and ARP over ATM"
|
||||
.%O "RFC 2225"
|
||||
.Re
|
||||
.Rs
|
||||
.%T "Server Cache Synchronization Protocol (SCSP)"
|
||||
.%O "RFC 2334"
|
||||
.Re
|
||||
.Rs
|
||||
.%T "A Distributed ATMARP Service Using SCSP"
|
||||
.%O "draft\-ietf\-ion\-scsp\-atmarpd\-00.txt"
|
||||
.Re
|
||||
.Sh BUGS
|
||||
Results are unpredictable if multiple instantiations of
|
||||
\fIatmarpd\fP are run simulatneously for a given network interface.
|
||||
|
||||
Please report any bugs to harp-bugs@magic.net.
|
||||
|
||||
.SH COPYRIGHT
|
||||
.Nm
|
||||
are run simultaneously for a given network interface.
|
||||
.Pp
|
||||
Please report any bugs to
|
||||
.Aq harp\-bugs@magic.net .
|
||||
.Sh COPYRIGHT
|
||||
Copyright (c) 1994-1998, Network Computing Services, Inc.
|
||||
|
||||
.SH AUTHORS
|
||||
John Cavanaugh, Network Computing Services, Inc.
|
||||
.br
|
||||
Mike Spengler, Network Computing Services, Inc.
|
||||
.br
|
||||
Joe Thomas, Network Computing Services, Inc.
|
||||
.fi
|
||||
.SH ACKNOWLEDGMENTS
|
||||
.Sh AUTHORS
|
||||
.An John Cavanaugh ,
|
||||
Network Computing Services, Inc.
|
||||
.An Mike Spengler ,
|
||||
Network Computing Services, Inc.
|
||||
.An Joe Thomas ,
|
||||
Network Computing Services, Inc.
|
||||
.Sh ACKNOWLEDGMENTS
|
||||
This software was developed with the support of the Defense
|
||||
Advanced Research Projects Agency (DARPA).
|
||||
|
||||
@ -25,39 +25,35 @@
|
||||
.\" @(#) $FreeBSD$
|
||||
.\"
|
||||
.\"
|
||||
.de EX \"Begin example
|
||||
.ne 5
|
||||
.if n .sp 1
|
||||
.if t .sp .5
|
||||
.nf
|
||||
.in +.5i
|
||||
..
|
||||
.de EE
|
||||
.fi
|
||||
.in -.5i
|
||||
.if n .sp 1
|
||||
.if t .sp .5
|
||||
..
|
||||
.TH SCSPD 8 "1998-08-21" "HARP"
|
||||
|
||||
.SH NAME
|
||||
scspd \- SCSP daemon
|
||||
.SH SYNOPSIS
|
||||
.B scspd
|
||||
[\fB-f\fP <cfg-file>]
|
||||
[\fB-d\fP]
|
||||
[\fB-T\fP<options>]
|
||||
|
||||
.SH DESCRIPTION
|
||||
\fIScspd\fP is an implementation of the Server Cache Synchronization
|
||||
.Dd August 21, 1998
|
||||
.Dt SCSPD 8
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm scspd
|
||||
.Nd "SCSP daemon"
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl f Aq Ar cfg\-file
|
||||
.Op Fl d
|
||||
.Op Fl T Ns Aq Ar options
|
||||
.Sh DESCRIPTION
|
||||
.Nm Scspd
|
||||
is an implementation of the Server Cache Synchronization
|
||||
Protocol (SCSP) for the Host ATM Research Platform (HARP)
|
||||
networking software.
|
||||
\fIScspd\fP synchronizes the cache(s) of server(s)
|
||||
.Nm Scspd
|
||||
synchronizes the cache(s) of server(s)
|
||||
running on a host with the caches of servers on remote hosts.
|
||||
SCSP is defined for a number of different protocols, but the present
|
||||
version of \fIscspd\fP only supports ATMARP.
|
||||
.PP
|
||||
By using \fIscspd\fP and \fIatmarpd\fP, one can provide multiple
|
||||
version of
|
||||
.Nm
|
||||
only supports ATMARP.
|
||||
.Pp
|
||||
By using
|
||||
.Nm
|
||||
and
|
||||
.Xr atmarpd 8 ,
|
||||
one can provide multiple
|
||||
ATMARP servers in a single ATM LIS.
|
||||
This might be useful, for example, when a LIS consists of a number of
|
||||
local-area ATM networks connected by long-distance links.
|
||||
@ -65,379 +61,567 @@ Each local-area network could have its own ATMARP server, with all the
|
||||
servers' caches being synchronized by SCSP.
|
||||
Then, if a long-distance link fails, hosts on a local-area network
|
||||
will still have connectivity to other local hosts (since they all use
|
||||
the local ATMARP server); when the long-distance link is restored,
|
||||
the local ATMARP server); when the long-distance link is restored,
|
||||
SCSP will re-synchronize the servers' caches, restoring
|
||||
connectivity to remote hosts.
|
||||
Both \fIscspd\fP and \fIatmarpd\fP must be running before any ATMARP
|
||||
Both
|
||||
.Nm
|
||||
and
|
||||
.Xr atmarpd 8
|
||||
must be running before any ATMARP
|
||||
cache synchronization can take place.
|
||||
.PP
|
||||
\fIScspd\fP implements SCSP as specified in RFC 2334, \fIServer Cache
|
||||
Synchronization Protocol (SCSP)\fP and
|
||||
draft-ietf-ion-scspd-atmarpd-00.txt, \fIA Distributed ATMARP Service
|
||||
using SCSP\fP.
|
||||
|
||||
When \fIscspd\fP starts, it parses its command line and puts
|
||||
.Pp
|
||||
.Nm Scspd
|
||||
implements SCSP as specified in RFC 2334,
|
||||
.%T "Server Cache Synchronization Protocol (SCSP)"
|
||||
and
|
||||
.Pa draft\-ietf\-ion\-scspd\-atmarpd\-00.txt ,
|
||||
.%T "A Distributed ATMARP Service using SCSP" .
|
||||
.Pp
|
||||
When
|
||||
.Nm
|
||||
starts, it parses its command line and puts
|
||||
itself into the background.
|
||||
|
||||
.SH TERMINOLOGY
|
||||
.Sh TERMINOLOGY
|
||||
Some of the vocabulary associated with SCSP can be confusing.
|
||||
In this document, the following definitions are used:
|
||||
|
||||
\fBClient server\fP or \fBlocal server\fP means the server running on
|
||||
the same host as \fIscspd\fP whose cache is to be synchronized with that
|
||||
.Pp
|
||||
.Em "Client server"
|
||||
or
|
||||
.Em "local server"
|
||||
means the server running on
|
||||
the same host as
|
||||
.Nm
|
||||
whose cache is to be synchronized with that
|
||||
of one or more remote servers.
|
||||
When the word \fBserver\fP is used alone, it means "client server".
|
||||
|
||||
\fBRemote server\fP means a server running on some host other than
|
||||
the one where \fIscspd\fP is running.
|
||||
|
||||
\fBDirectly Connected Server\fP (DCS) means a remote server that
|
||||
\fIscspd\fP communicates with directly.
|
||||
When the word
|
||||
.Em server
|
||||
is used alone, it means
|
||||
.Em "client server" .
|
||||
.Pp
|
||||
.Em "Remote server"
|
||||
means a server running on some host other than
|
||||
the one where
|
||||
.Nm
|
||||
is running.
|
||||
.Pp
|
||||
.Em "Directly Connected Server"
|
||||
(DCS) means a remote server that
|
||||
.Nm
|
||||
communicates with directly.
|
||||
The remote server will also be running an implementation of SCSP.
|
||||
|
||||
\fBCache Alignment\fP (CA) has two meanings.
|
||||
.Pp
|
||||
.Em "Cache Alignment"
|
||||
(CA) has two meanings.
|
||||
The Cache Alignment protocol is a part of the SCSP protocol
|
||||
specification, and the Cache Alignment finite state machine (FSM)
|
||||
is a finite state machine that implements the Cache Alignment
|
||||
protocol.
|
||||
|
||||
.SH OPTIONS
|
||||
.Pp
|
||||
.Sh OPTIONS
|
||||
The command-line options are:
|
||||
.IP "\fB-f\fP <cfg-file>" 15
|
||||
.Bl -tag -width "-f <cfg\-file>"
|
||||
.It Fl f Aq Ar cfg\-file
|
||||
Specifies the name of the configuration file.
|
||||
If this option is not specified, \fIscspd\fP looks for the
|
||||
file /etc/scspd.conf.
|
||||
.IP "\fB-d\fP" 15
|
||||
Specifies that \fIscspd\fP is to be run in debug mode.
|
||||
If this option is not specified,
|
||||
.Nm
|
||||
looks for the
|
||||
file
|
||||
.Pa /etc/scspd.conf .
|
||||
.It Fl d
|
||||
Specifies that
|
||||
.Nm
|
||||
is to be run in debug mode.
|
||||
In debug mode, the daemon is not put into the background.
|
||||
Log messages are written to standard output instead of to
|
||||
the log file specified in the configuration file.
|
||||
.IP "\fB-T\fP<options>" 15
|
||||
Specifies that \fIscspd\fP will trace specified events and messages
|
||||
.It Fl T Ns Aq Ar options
|
||||
Specifies that
|
||||
.Nm
|
||||
will trace specified events and messages
|
||||
as it executes.
|
||||
The \fB-T\fP flag is followed by one or more of the following
|
||||
The
|
||||
.Fl T
|
||||
flag is followed by one or more of the following
|
||||
options:
|
||||
.in +4
|
||||
.ti -4
|
||||
\fBc\fP\ -\ trace \fIscspd\fP's CA Finite State Machine (FSM),
|
||||
.ti -4
|
||||
\fBh\fP\ -\ trace \fIscspd\fP's Hello FSM,
|
||||
.ti -4
|
||||
\fBi\fP\ -\ trace \fIscspd\fP's Client Interface FSM,
|
||||
.ti -4
|
||||
\fBC\fP\ -\ trace CA, CSUS, CSU Request, and CSU Reply messages,
|
||||
.ti -4
|
||||
\fBH\fP\ -\ trace Hello messages,
|
||||
.ti -4
|
||||
\fBI\fP\ -\ trace interface messages to and from \fIscspd\fP's
|
||||
.Pp
|
||||
.Bl -tag -width 4n -compact
|
||||
.It Cm c
|
||||
trace
|
||||
.Nm Ns 's
|
||||
CA Finite State Machine (FSM),
|
||||
.It Cm h
|
||||
trace
|
||||
.Nm Ns 's
|
||||
Hello FSM,
|
||||
.It Cm i
|
||||
trace
|
||||
.Nm Ns 's
|
||||
Client Interface FSM,
|
||||
.It Cm C
|
||||
trace CA, CSUS, CSU Request, and CSU Reply messages,
|
||||
.It Cm H
|
||||
trace Hello messages,
|
||||
.It Cm I
|
||||
trace interface messages to and from
|
||||
.Nm Ns 's
|
||||
clients.
|
||||
.in -4
|
||||
.SH CONFIGURATION
|
||||
|
||||
.El
|
||||
.El
|
||||
.Sh CONFIGURATION
|
||||
The configuration file consists of a sequence of configuration
|
||||
statements.
|
||||
These statements specify information about the servers,
|
||||
both local and remote, whose
|
||||
caches are to be synchronized by \fIscspd\fP.
|
||||
RFC 2334, \fIServer Cache
|
||||
Synchronization Protocol (SCSP)\fP and
|
||||
draft-ietf-ion-scspd-atmarpd-00.txt, \fIA Distributed ATMARP Service
|
||||
using SCSP\fP
|
||||
will be valuable in understanding how to configure \fIscspd\fP.
|
||||
|
||||
caches are to be synchronized by
|
||||
.Nm .
|
||||
RFC 2334,
|
||||
.%T "Server Cache Synchronization Protocol (SCSP)"
|
||||
and
|
||||
.Pa draft\-ietf\-ion\-scspd\-atmarpd\-00.txt ,
|
||||
.%T "A Distributed ATMARP Service using SCSP"
|
||||
will be valuable in understanding how to configure
|
||||
.Nm .
|
||||
.Pp
|
||||
A configuration statement other than a comment is terminated by a
|
||||
semicolon.
|
||||
Some statements contain blocks, delimited by braces ("{" and "}").
|
||||
Some statements contain blocks, delimited by braces
|
||||
.No ( Dq Li {
|
||||
and
|
||||
.Dq Li } ) .
|
||||
Configuration statement keywords are not case-sensitive,
|
||||
but some parameters (e.g. interface names) are.
|
||||
Configuration statments can span multiple lines.
|
||||
|
||||
.SS Comments
|
||||
Configuration statements can span multiple lines.
|
||||
.Ss Comments
|
||||
Three types of comments are allowed:
|
||||
|
||||
\fB# comments\fP:
|
||||
any characters from "#" to the end of the line are ignored.
|
||||
|
||||
\fBC comments\fP:
|
||||
any characters between "/*" and "*/" are ignored.
|
||||
|
||||
\fBC++ comments\fP:
|
||||
any characters from "//" to the end of the line are ignored.
|
||||
|
||||
.SS "Statements"
|
||||
The configuration statements recognized by \fIscspd\fP are:
|
||||
|
||||
.Bl -hang
|
||||
.It Sy "# comments" :
|
||||
any characters from
|
||||
.Dq Li #
|
||||
to the end of the line are ignored.
|
||||
.It Sy "C comments" :
|
||||
any characters between
|
||||
.Dq Li /*
|
||||
and
|
||||
.Dq Li */
|
||||
are ignored.
|
||||
.It Sy "C++ comments" :
|
||||
any characters from
|
||||
.Dq Li //
|
||||
to the end of the line are ignored.
|
||||
.El
|
||||
.Ss Statements
|
||||
The configuration statements recognized by
|
||||
.Nm
|
||||
are:
|
||||
.Bd -literal
|
||||
Server <name> {
|
||||
.in +5
|
||||
Protocol <protocol ID>;
|
||||
.br
|
||||
Netif <if_name>;
|
||||
.br
|
||||
ServerGroupID <ID>;
|
||||
.br
|
||||
FamilyID <ID>;
|
||||
.br
|
||||
DCS {
|
||||
.in +5
|
||||
ATMaddr <ATM address>;
|
||||
.br
|
||||
ID <host>;
|
||||
.br
|
||||
CAReXmitInt <int>;
|
||||
.br
|
||||
CSUSReXmitInt <int>;
|
||||
.br
|
||||
CSUReXmitInt <int>;
|
||||
.br
|
||||
CSUReXmitMax <cnt>;
|
||||
.br
|
||||
HelloDead <cnt>;
|
||||
.br
|
||||
HelloInt <int>;
|
||||
.br
|
||||
Hops <cnt>;
|
||||
.in -5
|
||||
Protocol <protocol ID>;
|
||||
Netif <if_name>;
|
||||
ServerGroupID <ID>;
|
||||
FamilyID <ID>;
|
||||
DCS {
|
||||
ATMaddr <ATM address>;
|
||||
ID <host>;
|
||||
CAReXmitInt <int>;
|
||||
CSUSReXmitInt <int>;
|
||||
CSUReXmitInt <int>;
|
||||
CSUReXmitMax <cnt>;
|
||||
HelloDead <cnt>;
|
||||
HelloInt <int>;
|
||||
Hops <cnt>;
|
||||
};
|
||||
};
|
||||
.in -5
|
||||
};
|
||||
.sp
|
||||
|
||||
Log {
|
||||
.in +5
|
||||
File <file name>;
|
||||
.br
|
||||
Syslog;
|
||||
.in -5
|
||||
File <file name>;
|
||||
Syslog;
|
||||
};
|
||||
.PP
|
||||
.Ed
|
||||
.Pp
|
||||
Where a host address needs to be specified in the configuration file,
|
||||
either a DNS name or an IP address in dotted decimal format can
|
||||
be used.
|
||||
.PP
|
||||
.Pp
|
||||
ATM addresses are specified as strings of hex digits, with an
|
||||
optional leading "0x".
|
||||
optional leading
|
||||
.Dq Li 0x .
|
||||
Fields within the address may be separated by periods, but periods
|
||||
are for readability only and are ignored.
|
||||
ATM addresses are 20 bytes long.
|
||||
The full address, including any leading zeroes, must be given.
|
||||
For example:
|
||||
.in +5
|
||||
0x47.0005.80.ffe100.0000.f21a.0170.0020481a0170.00
|
||||
.in -5
|
||||
|
||||
.SS "Server Statement"
|
||||
The \fBserver\fP statement specifies a client server whose cache
|
||||
.Pp
|
||||
.Dl "0x47.0005.80.ffe100.0000.f21a.0170.0020481a0170.00"
|
||||
.Ss "Server Statement"
|
||||
The
|
||||
.Ic server
|
||||
statement specifies a client server whose cache
|
||||
to be synchronized with the caches of other servers
|
||||
running on remote hosts.
|
||||
There will be one \fBserver\fP statement in the configuration file
|
||||
for each client server whose cache is to be synchronized by \fIscspd\fP.
|
||||
The format of the \fBserver\fP statement is:
|
||||
.ti +5
|
||||
\fBServer <name> { <statements> };\fP
|
||||
|
||||
A name must be specified on the \fBserver\fP statement, but it is
|
||||
not used by \fIscspd\fP.
|
||||
There will be one
|
||||
.Ic server
|
||||
statement in the configuration file
|
||||
for each client server whose cache is to be synchronized by
|
||||
.Nm .
|
||||
The format of the
|
||||
.Ic server
|
||||
statement is:
|
||||
.Bd -ragged -offset indent
|
||||
.Ic Server
|
||||
.Aq Ar name
|
||||
{
|
||||
.Aq Ar statements
|
||||
};
|
||||
.Ed
|
||||
.Pp
|
||||
A
|
||||
.Ar name
|
||||
must be specified on the
|
||||
.Ic server
|
||||
statement, but it is
|
||||
not used by
|
||||
.Nm .
|
||||
It is expected to give a brief description of the server's purpose.
|
||||
|
||||
The \fBserver\fP statement has several sub-statements
|
||||
that specify the details of the \fIscspd\fP's configuration.
|
||||
.Pp
|
||||
The
|
||||
.Ic server
|
||||
statement has several sub-statements
|
||||
that specify the details of the
|
||||
.Nm Ns 's
|
||||
configuration.
|
||||
They are:
|
||||
.IP "\fBProtocol ATMARP;\fP" 5
|
||||
The only protocol supported by the current version of \fIscspd\fP
|
||||
is ATMARP.
|
||||
The \fBprotocol\fP statement must always be specified.
|
||||
.IP "\fBNetif <intf>;\fP" 5
|
||||
The \fBnetif\fP statement specifies the name of the ATM network
|
||||
.Bl -tag -width indent
|
||||
.It Ic Protocol Cm ATMARP ;
|
||||
The only protocol supported by the current version of
|
||||
.Nm
|
||||
is
|
||||
.Cm ATMARP .
|
||||
The
|
||||
.Ic protocol
|
||||
statement must always be specified.
|
||||
.It Ic Netif Aq Ar intf ;
|
||||
The
|
||||
.Ic netif
|
||||
statement specifies the name of the ATM network
|
||||
interface on which a client server is providing service.
|
||||
The \fBnetif\fP statement must always be specified.
|
||||
.IP "\fBServerGroupID <ID>;\fP" 5
|
||||
The \fBServerGroupID\fP statement specifies an identifier for the
|
||||
group of servers being synchronized by \fIscspd\fP.
|
||||
The ID is specified as a decimal number in the range 0 - 65,535.
|
||||
The
|
||||
.Ic netif
|
||||
statement must always be specified.
|
||||
.It Ic ServerGroupID Aq Ar ID ;
|
||||
The
|
||||
.Ic ServerGroupID
|
||||
statement specifies an identifier for the
|
||||
group of servers being synchronized by
|
||||
.Nm .
|
||||
The
|
||||
.Ar ID
|
||||
is specified as a decimal number in the range 0 - 65,535.
|
||||
The server group ID must be the same for all servers whose caches
|
||||
are being synchronized by an SCSP session.
|
||||
That is, the server group ID for a host must be the same for all
|
||||
Directly Connected Servers (DCSs) pointed to within a
|
||||
\fBserver\fP statement.
|
||||
The \fBServerGroupID\fP statement must always be specified.
|
||||
.IP "\fBFamilyID <ID>;\fP" 5
|
||||
The \fBfamilyID\fP statement specifies an identifier for a family
|
||||
.Ic server
|
||||
statement.
|
||||
The
|
||||
.Ic ServerGroupID
|
||||
statement must always be specified.
|
||||
.It Ic FamilyID Aq Ar ID ;
|
||||
The
|
||||
.Ic familyID
|
||||
statement specifies an identifier for a family
|
||||
of parallel SCSP sessions running between a group of hosts (i.e. a
|
||||
set of SCSP sessions with different protocol IDs but the same set
|
||||
of servers).
|
||||
The ID is specified as a decimal number in the range 0 - 65,535.
|
||||
The family ID is currently not used by \fIscspd\fP.
|
||||
|
||||
.SS "DCS Statement"
|
||||
The \fBDCS\fP statement is a sub-statement of the \fBserver\fP statement
|
||||
The
|
||||
.Ar ID
|
||||
is specified as a decimal number in the range 0 - 65,535.
|
||||
The family ID is currently not used by
|
||||
.Nm .
|
||||
.El
|
||||
.Ss "DCS Statement"
|
||||
The
|
||||
.Ic DCS
|
||||
statement is a sub-statement of the
|
||||
.Ic server
|
||||
statement
|
||||
that specifies the characteristics of a Directly Connected Server (DCS).
|
||||
The \fBserver\fP statement will have one \fBDCS\fP statement for
|
||||
each DCS that \fIscspd\fP is to exchange information with.
|
||||
The \fBDCS\fP statement has a number of sub-statements that specify the
|
||||
details of the configuration for the DCS. They are:
|
||||
.IP "\fBATMaddr <ATM address>;\fP" 5
|
||||
The \fBATMaddr\fP statement specifies the ATM address of the DCS.
|
||||
The \fBATMaddr\fP statement must always be specified.
|
||||
.IP "\fBID <host>;\fP" 5
|
||||
The \fBID\fP statement specifies the SCSP identifier of the DCS.
|
||||
The
|
||||
.Ic server
|
||||
statement will have one
|
||||
.Ic DCS
|
||||
statement for
|
||||
each DCS that
|
||||
.Nm
|
||||
is to exchange information with.
|
||||
The
|
||||
.Ic DCS
|
||||
statement has a number of sub-statements that specify the
|
||||
details of the configuration for the DCS.
|
||||
They are:
|
||||
.Bl -tag -width indent
|
||||
.It Ic ATMaddr Aq Ar ATM\ address ;
|
||||
The
|
||||
.Ic ATMaddr
|
||||
statement specifies the ATM address of the DCS.
|
||||
The
|
||||
.Ic ATMaddr
|
||||
statement must always be specified.
|
||||
.It Ic ID Aq Ar host ;
|
||||
The
|
||||
.Ic ID
|
||||
statement specifies the SCSP identifier of the DCS.
|
||||
For ATMARP, the ID is the IP address or DNS name associated with the
|
||||
ATM interface of the DCS.
|
||||
The \fBID\fP statement must always be specified.
|
||||
.IP "\fBCAReXmitInt <int>;\fP" 5
|
||||
The \fBCAReXmitInt\fP statement specifies the interval that is
|
||||
The
|
||||
.Ic ID
|
||||
statement must always be specified.
|
||||
.It Ic CAReXmitInt Aq Ar int ;
|
||||
The
|
||||
.Ic CAReXmitInt
|
||||
statement specifies the interval that is
|
||||
allowed to elapse between retransmissions of CA messages.
|
||||
If a CA message is sent and an acknowledgement is not received within
|
||||
CAReXmitInt seconds, the message will be retransmitted.
|
||||
The default value for \fBCAReXmitInt\fP is 3 seconds.
|
||||
.IP "\fBCSUSReXmitInt <int>;\fP" 5
|
||||
The \fBCSUSReXmitInt\fP statement specifies the interval that is
|
||||
.Ic CAReXmitInt
|
||||
seconds, the message will be retransmitted.
|
||||
The default value for
|
||||
.Ic CAReXmitInt
|
||||
is 3 seconds.
|
||||
.It Ic CSUSReXmitInt Aq Ar int ;
|
||||
The
|
||||
.Ic CSUSReXmitInt
|
||||
statement specifies the interval that is
|
||||
allowed to elapse between retransmissions of CSU Solicit messages.
|
||||
When a CSUS message is sent, any Cache State Advertisements (CSAs)
|
||||
requested by the CSUS that have
|
||||
not been received within CSUSReXmitInt seconds will be requested
|
||||
not been received within
|
||||
.Ic CSUSReXmitInt
|
||||
seconds will be requested
|
||||
again by another CSUS message.
|
||||
The default value for \fBCSUSReXmitInt\fP is 3 seconds.
|
||||
Be careful not to confuse \fBCSUSReXmitInt\fP and \fBCSUReXmitInt\fP.
|
||||
.IP "\fBCSUReXmitInt <int>;\fP" 5
|
||||
The \fBCSUReXmitInt\fP statement specifies the interval that is
|
||||
The default value for
|
||||
.Ic CSUSReXmitInt
|
||||
is 3 seconds.
|
||||
Be careful not to confuse
|
||||
.Ic CSUSReXmitInt
|
||||
and
|
||||
.Ic CSUReXmitInt .
|
||||
.It Ic CSUReXmitInt Aq Ar int ;
|
||||
The
|
||||
.Ic CSUReXmitInt
|
||||
statement specifies the interval that is
|
||||
allowed to elapse between retransmissions of CSU Request messages.
|
||||
When a CSU Request message is sent, any CSAs that are not acknowledged
|
||||
by a CSU Reply message within CSUReXmitInt seconds will
|
||||
by a CSU Reply message within
|
||||
.Ic CSUReXmitInt
|
||||
seconds will
|
||||
be retransmitted.
|
||||
The default value for \fBCSUReXmitInt\fP is 2 seconds.
|
||||
Be careful not to confuse \fBCSUReXmitInt\fP and \fBCSUSReXmitInt\fP.
|
||||
.IP "\fBCSUReXmitMax <cnt>;\fP" 5
|
||||
The \fBCSUReXmitMax\fP statement specifies the number of times that
|
||||
The default value for
|
||||
.Ic CSUReXmitInt
|
||||
is 2 seconds.
|
||||
Be careful not to confuse
|
||||
.Ic CSUReXmitInt
|
||||
and
|
||||
.Ic CSUSReXmitInt .
|
||||
.It Ic CSUReXmitMax Aq Ar cnt ;
|
||||
The
|
||||
.Ic CSUReXmitMax
|
||||
statement specifies the number of times that
|
||||
a CSA will be retransmitted as described above before SCSP gives up
|
||||
on the CSA and discards it.
|
||||
The default value for \fBCSUReXmitMax\fP is 5.
|
||||
.IP "\fBHelloDead <cnt>;\fP" 5
|
||||
The \fBHelloDead\fP statement specifies the Hello Dead Factor that
|
||||
The default value for
|
||||
.Ic CSUReXmitMax
|
||||
is 5.
|
||||
.It Ic HelloDead Aq Ar cnt ;
|
||||
The
|
||||
.Ic HelloDead
|
||||
statement specifies the Hello Dead Factor that
|
||||
will be sent to the DCS in Hello messages.
|
||||
A "DCS down" condition will be detected when nothing is received from
|
||||
a DCS in HelloDead * HelloInt seconds.
|
||||
The default value for \fBHelloDead\fP is 3.
|
||||
.IP "\fBHelloInt <int>;\fP" 5
|
||||
The \fBHelloInt\fP statement specifies the Hello Interval that
|
||||
A
|
||||
.Dq "DCS down"
|
||||
condition will be detected when nothing is received from
|
||||
a DCS in
|
||||
.Ic HelloDead No * Ic HelloInt
|
||||
seconds.
|
||||
The default value for
|
||||
.Ic HelloDead
|
||||
is 3.
|
||||
.It Ic HelloInt Aq Ar int ;
|
||||
The
|
||||
.Ic HelloInt
|
||||
statement specifies the Hello Interval that
|
||||
will be sent to the DCS in Hello messages.
|
||||
The default value for \fBHelloInt\fP is 3 seconds.
|
||||
.IP "\fBHops <cnt>;\fP" 5
|
||||
The \fBHops\fP statement specifies the number of hops (DCS to DCS)
|
||||
The default value for
|
||||
.Ic HelloInt
|
||||
is 3 seconds.
|
||||
.It Ic Hops Aq Ar cnt ;
|
||||
The
|
||||
.Ic Hops
|
||||
statement specifies the number of hops (DCS to DCS)
|
||||
that will be specified in CSAs originating from the local server.
|
||||
This number must be at least as large as the diameter of the
|
||||
server group.
|
||||
That is, it must be large enough for a CSA to be propagated from
|
||||
server to server all the way across the server group.
|
||||
The default value for \fBHops\fP is 3.
|
||||
|
||||
.SS "Log Statement"
|
||||
The \fBlog\fP statement specifies how \fIscspd\fP is to log
|
||||
The default value for
|
||||
.Ic Hops
|
||||
is 3.
|
||||
.El
|
||||
.Ss "Log Statement"
|
||||
The
|
||||
.Ic log
|
||||
statement specifies how
|
||||
.Nm
|
||||
is to log
|
||||
information about its operation.
|
||||
\fIScspd\fP can write log information to a file, to the system log,
|
||||
.Nm Scspd
|
||||
can write log information to a file, to the system log,
|
||||
or both.
|
||||
.IP "\fBFile <file name>;\fP" 5
|
||||
The \fBfile\fP statement specifies that \fIscspd\fP is to write
|
||||
.Bl -tag -width indent
|
||||
.It Ic File Aq Ar file\ name ;
|
||||
The
|
||||
.Ic file
|
||||
statement specifies that
|
||||
.Nm
|
||||
is to write
|
||||
its log messages to the named file.
|
||||
Log messages will be appended to the end of the file if
|
||||
it already exists.
|
||||
.IP "\fBSyslog;\fP" 5
|
||||
The \fBsyslog\fP statement specifies that \fIscspd\fP is to write
|
||||
.It Ic Syslog ;
|
||||
The
|
||||
.Ic syslog
|
||||
statement specifies that
|
||||
.Nm
|
||||
is to write
|
||||
its log messages to the syslog facility.
|
||||
\fIScspd\fP writes its messages to syslog with a facility code
|
||||
of LOG_DAEMON.
|
||||
|
||||
.in -5
|
||||
If no \fBlog\fP statement is specified, \fIscspd\fP writes log
|
||||
.Nm Scspd
|
||||
writes its messages to syslog with a facility code
|
||||
of
|
||||
.Dv LOG_DAEMON .
|
||||
.El
|
||||
.Pp
|
||||
If no
|
||||
.Ic log
|
||||
statement is specified,
|
||||
.Nm
|
||||
writes log
|
||||
messages to the system log.
|
||||
If both \fBfile\fP and \fBsyslog\fP are specified, \fIscspd\fP will
|
||||
If both
|
||||
.Ic file
|
||||
and
|
||||
.Ic syslog
|
||||
are specified,
|
||||
.Nm
|
||||
will
|
||||
write log messages to both the named file and the system log.
|
||||
|
||||
.SS Examples
|
||||
|
||||
An example of a simple configuration file for \fIscspd\fP might be:
|
||||
.in +5
|
||||
.Ss Examples
|
||||
An example of a simple configuration file for
|
||||
.Nm
|
||||
might be:
|
||||
.Bd -literal -offset indent
|
||||
server atmarp_ni0 {
|
||||
.in +5
|
||||
protocol ATMARP;
|
||||
.br
|
||||
netif ni0;
|
||||
.br
|
||||
ServerGroupID 23;
|
||||
.br
|
||||
DCS {
|
||||
.in +5
|
||||
.br
|
||||
ID 10.1.1.2;
|
||||
.br
|
||||
ATMaddr 0x47.0005.80.ffdc00.0000.0002.0001.002048061de7.00;
|
||||
.br
|
||||
hops 2;
|
||||
.in -5
|
||||
protocol ATMARP;
|
||||
netif ni0;
|
||||
ServerGroupID 23;
|
||||
DCS {
|
||||
ID 10.1.1.2;
|
||||
ATMaddr 0x47.0005.80.ffdc00.0000.0002.0001.002048061de7.00;
|
||||
hops 2;
|
||||
};
|
||||
};
|
||||
.in -5
|
||||
};
|
||||
.in -5
|
||||
|
||||
.Ed
|
||||
.Pp
|
||||
This configuration would synchronize the cache of the ATMARP server
|
||||
operating on network interface ni0 with the cache of a second server
|
||||
running on a host whose IP address is 10.1.1.2.
|
||||
Log messages would be written to the system log.
|
||||
|
||||
|
||||
.SH SIGNAL PROCESSING
|
||||
The following signals can be used to control \fIscspd\fP:
|
||||
|
||||
.IP \fBSIGHUP\fP 10
|
||||
Reread the configuration file and restart \fIscspd\fP.
|
||||
|
||||
.IP \fBSIGINT\fP 10
|
||||
.Sh SIGNAL PROCESSING
|
||||
The following signals can be used to control
|
||||
.Nm :
|
||||
.Bl -tag -width indent
|
||||
.It Dv SIGHUP
|
||||
Reread the configuration file and restart
|
||||
.Nm .
|
||||
.It Dv SIGINT
|
||||
Dump debugging information to a file.
|
||||
When it receives a SIGINT signal, \fIscspd\fP dumps a summary of
|
||||
its control blocks to a text file (see "\fBFILES\fP").
|
||||
|
||||
.SH FILES
|
||||
|
||||
.IP "/etc/scspd.conf"
|
||||
\fIScspd\fP default configuration file name.
|
||||
A different file name can be specified with the \fB-f\fP command-line
|
||||
When it receives a
|
||||
.Dv SIGINT
|
||||
signal,
|
||||
.Nm
|
||||
dumps a summary of
|
||||
its control blocks to a text file (see
|
||||
.Sx FILES ) .
|
||||
.El
|
||||
.Sh FILES
|
||||
.Bl -tag -width indent
|
||||
.It Pa /etc/scspd.conf
|
||||
.Nm Scspd
|
||||
default configuration file name.
|
||||
A different file name can be specified with the
|
||||
.Fl f
|
||||
command-line
|
||||
option.
|
||||
|
||||
.IP "/tmp/scspd.<pid>.<seq>.out"
|
||||
.It Xo
|
||||
.Sm off
|
||||
.Pa /tmp/scspd.
|
||||
.Aq Ar pid
|
||||
.Pa \&.
|
||||
.Aq Ar seq
|
||||
.Pa .out
|
||||
.Sm on
|
||||
.Xc
|
||||
Debugging information dump file name.
|
||||
\fIScspd\fP writes a summary of its control blocks to this file
|
||||
when it receives a SIGINT signal.
|
||||
<pid> is the process ID of the daemon and <seq> is a sequence
|
||||
.Nm Scspd
|
||||
writes a summary of its control blocks to this file
|
||||
when it receives a
|
||||
.Dv SIGINT
|
||||
signal.
|
||||
.Aq Ar pid
|
||||
is the process ID of the daemon and
|
||||
.Aq Ar seq
|
||||
is a sequence
|
||||
number which is incremented every time a dump is taken.
|
||||
|
||||
.IP "/tmp/scspd.<pid>.trace"
|
||||
.It Xo
|
||||
.Sm off
|
||||
.Pa /tmp/scspd.
|
||||
.Aq Ar pid
|
||||
.Pa .trace
|
||||
.Sm on
|
||||
.Xc
|
||||
Trace file.
|
||||
\fIScspd\fP writes trace information to this file if the \fB-T\fP
|
||||
.Nm Scspd
|
||||
writes trace information to this file if the
|
||||
.Fl T
|
||||
option is specified on the command line.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
\fIatm\fP (8);
|
||||
\fIatmarpd\fP (8);
|
||||
RFC 2334, \fIServer Cache Synchronization Protocol (SCSP)\fP;
|
||||
draft-ietf-ion-scsp-atmarpd-00.txt, \fIA Distributed ATMARP Service
|
||||
Using SCSP\fP.
|
||||
|
||||
|
||||
.SH BUGS
|
||||
If \fIscspd\fP terminates and is restarted, there will be a period of
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr atm 8 ,
|
||||
.Xr atmarpd 8
|
||||
.Rs
|
||||
.%O "RFC 2334"
|
||||
.%T "Server Cache Synchronization Protocol (SCSP)"
|
||||
.Re
|
||||
.Rs
|
||||
.%O "draft\-ietf\-ion\-scsp\-atmarpd\-00.txt"
|
||||
.%T "A Distributed ATMARP Service Using SCSP"
|
||||
.Re
|
||||
.Sh BUGS
|
||||
If
|
||||
.Nm
|
||||
terminates and is restarted, there will be a period of
|
||||
instability while previously-synchronized cache entries time out and are
|
||||
refreshed.
|
||||
|
||||
Please report any bugs to harp-bugs@magic.net.
|
||||
|
||||
.SH COPYRIGHT
|
||||
.Pp
|
||||
Please report any bugs to
|
||||
.Aq harp\-bugs@magic.net .
|
||||
.Sh COPYRIGHT
|
||||
Copyright (c) 1994-1998, Network Computing Services, Inc.
|
||||
|
||||
.SH AUTHORS
|
||||
John Cavanaugh, Network Computing Services, Inc.
|
||||
.br
|
||||
Mike Spengler, Network Computing Services, Inc.
|
||||
.br
|
||||
Joe Thomas, Network Computing Services, Inc.
|
||||
.fi
|
||||
.SH ACKNOWLEDGMENTS
|
||||
.Sh AUTHORS
|
||||
.An John Cavanaugh ,
|
||||
Network Computing Services, Inc.
|
||||
.An Mike Spengler ,
|
||||
Network Computing Services, Inc.
|
||||
.An Joe Thomas ,
|
||||
Network Computing Services, Inc.
|
||||
.Sh ACKNOWLEDGMENTS
|
||||
This software was developed with the support of the Defense
|
||||
Advanced Research Projects Agency (DARPA).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user