.\" .\" This file automatically generated from ../doc/operation_guide/gated.html by .\" `html -Tman ../doc/operation_guide/gated.html' .\" .\" .\" Public Release 3 .\" .\" $Id: gated.8,v 1.2 1997/07/17 22:40:49 chopps Exp $ .\" .\" ------------------------------------------------------------------------ .\" .\" Copyright (c) 1996, 1997 The Regents of the University of Michigan .\" All Rights Reserved .\" .\" Royalty-free licenses to redistribute GateD Release .\" 3 in whole or in part may be obtained by writing to: .\" .\" Merit GateDaemon Project .\" 4251 Plymouth Road, Suite C .\" Ann Arbor, MI 48105 .\" .\" THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER .\" EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION WARRANTIES OF .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE REGENTS OF THE .\" UNIVERSITY OF MICHIGAN AND MERIT DO NOT WARRANT THAT THE .\" FUNCTIONS CONTAINED IN THE SOFTWARE WILL MEET LICENSEE'S REQUIREMENTS OR .\" THAT OPERATION WILL BE UNINTERRUPTED OR ERROR FREE. The Regents of the .\" University of Michigan and Merit shall not be liable for .\" any special, indirect, incidental or consequential damages with respect .\" to any claim by Licensee or any third party arising from use of the .\" software. GateDaemon was originated and developed through release 3.0 .\" by Cornell University and its collaborators. .\" .\" Please forward bug fixes, enhancements and questions to the .\" gated mailing list: gated-people@gated.merit.edu. .\" .\" ------------------------------------------------------------------------ .\" .\" Copyright (c) 1990,1991,1992,1993,1994,1995 by Cornell University. .\" All rights reserved. .\" .\" THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY .\" EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT .\" LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY .\" AND FITNESS FOR A PARTICULAR PURPOSE. .\" .\" GateD is based on Kirton's EGP, UC Berkeley's routing .\" daemon (routed), and DCN's HELLO routing Protocol. .\" Development of GateD has been supported in part by the .\" National Science Foundation. .\" .\" ------------------------------------------------------------------------ .\" .\" Portions of this software may fall under the following .\" copyrights: .\" .\" Copyright (c) 1988 Regents of the University of California. .\" All rights reserved. .\" .\" Redistribution and use in source and binary forms are .\" permitted provided that the above copyright notice and .\" this paragraph are duplicated in all such forms and that .\" any documentation, advertising materials, and other .\" materials related to such distribution and use .\" acknowledge that the software was developed by the .\" University of California, Berkeley. The name of the .\" University may not be used to endorse or promote .\" products derived from this software without specific .\" prior written permission. THIS SOFTWARE IS PROVIDED .\" ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, .\" INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF .\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. .\" .TH GATED 8 "1994/03/16 21:39:03 UTC" Release 3.5 "Merit GateDaemon Project" .SH "NAME" \fBgated\fP - gateway routing daemon .SH "SYNOPSIS" \fBgated\fP [ \fB-c\fP ] [ \fB-C\fP ] [ \fB-n\fP ] [ \fB-N\fP ] [ \fB-t\fP \fItrace_options\fP ] [ \fB-f\fP \fIconfig_file\fP ] [ \fItrace_file\fP ] .SH "DESCRIPTION" \fBGateD\fP is a routing daemon that handles multiple routing protocols and replaces \fBrouted (8)\fP and \fBegpup (8)\fP. \fBGateD\fP currently handles the RIP, BGP, EGP, HELLO, and OSPF routing protocols. The \fBgated\fP process can be configured to perform all routing protocols or any subset of them. The command-line options are: .IP "\fB-c\fP" Specifies that the configuration file will be parsed for syntax errors and then \fBgated\fP will exit, if there were no errors, \fBgated\fP will leave a dump file in \fI/usr/tmp/gated_dump\fP. \fBGated\fP does not need to be run as the super user to use the \fB-c\fP option but it may not be possible to read the kernel forwarding table and interface configuration if not run as super user. The \fB-c\fP option implies \fI-tgeneral\fP. All \fItraceoption\fP clauses in the configuration file will be ignored. .IP "\fB-C\fP" Specifies that the configuration file will just be parsed for syntax errors. \fBgated\fP will exit with a status 1 if there were any errors and 0 if there were not. \fBGated\fP does not need to be run as the super user to use the \fB-C\fP option but it may not be possible to read the kernel forwarding table and interface configuration if not run as super user. .IP "\fB-n\fP" Specifies that \fBgated\fP will not modify the kernel forwarding table. This is used for testing \fBgated\fP configurations with actual routing data. .IP "\fB-N\fP" Specifies that \fBgated\fP will not daemonize. Normally, if tracing to stderr is not specified \fBgated\fP will daemonize if the parent process ID is not 1. This allows the use of an \fI/etc/inittab\fP-like method of invoking \fBgated\fP that does not have a PID of 1. .IP "\fB-t\fP \fItrace_options\fP" Specifies a comma separated list of trace options to be enabled on startup. If no flags are specified, \fIgeneral\fP is assumed. No space is allowed between this option and it's arguments. This option must be used to trace events that take place before the config file is parsed, such as determining the interface configuration and reading routes from the kernel. See the \fBGateD Configuration Guide\fP for valid trace options and a more detailed explaination of tracing. .IP "\fB-f\fP \fIconfig_file\fP" Use an alternate config file. By default, \fBgated\fP uses \fI/etc/gated.conf\fP. If a trace file is specified on the command line, or no trace flags are specified on the command line, \fBgated\fP detaches from the terminal and runs in the background. If trace flags are specified without specifying a trace file, \fBgated\fP assumes that tracing is desired to stderr and remains in the foreground. .PP .SH "SIGNAL PROCESSING" The following signals may be used to control \fBgated\fP: .IP "\fBSIGHUP\fP" 10 Re-read configuration. A SIGHUP causes \fBgated\fP to reread the configuration file. \fBGated\fP first performs a clean-up of all allocated policy structures. All BGP and EGP peers are flagged for deletion and the configuration file is re-parsed. If the re-parse is successful, any BGP and EGP peers that are no longer in the configuration are shut down, and new peers are started. \fBGated\fP attempts to determine if changes to existing peers require a shutdown and restart. OSPF is not capable of reconfiguring, it is shutdown and restarted during a reconfiguration. This may have an adverse impact on the routing system. It should also be possible to enable/disable any protocol without restarting \fBgated\fP. .IP "\fBSIGINT\fP" Snap-shot of current state. The current state of all \fBgated\fP tasks, timers, protocols and tables are written to \fI/usr/tmp/gated_dump\fP. On systems supporting \fIfork()\fP, this is done by forking a subprocess to dump the table information so as not to impact \fBgated\fP's routing functions. On systems where memory management does not support copy-on-write, \fIfork()\fP will cause the \fBgated\fP address space to be duplicated; this may be cause a noticeable impact on the system. On system not supporting \fIfork()\fP, the main process immediately processes the dump, which may impact \fBgated\fP's routing functions. .IP "\fBSIGTERM\fP" Graceful shutdown. On receipt of a \fBSIGTERM\fP, \fBgated\fP attempts a graceful shutdown. All tasks and protocols are asked to shutdown. Most will terminate immediately, the exception being EGP peers which wait for confirmation. It may be necessary to repeat the \fBSIGTERM\fP once or twice if it this process takes too long. All protocol routes are removed from the kernel forwarding table on receipt of a \fBSIGTERM\fP. Interface routes, routes with \fIRTF_STATIC\fP set (from the route command where supported) and static routes specifying \fIretain\fP will remain. To terminate \fBgated\fP with the exterior routes intact, use \fBSIGKILL\fP. .IP "\fBSIGUSR1\fP" Toggle tracing. On receipt of a \fBSIGUSR1\fP, \fBgated\fP will close the trace file. A subsequent SIGUSR1 will cause it to be reopened. This will allow the file to be moved regularly. It is not possible to use \fBSIGUSR1\fP if a trace file has not been specified, or tracing is being performed to stderr. .IP "\fBSIGUSR2\fP" Check for interface changes. On receipt of a \fBSIGUSR2\fP, \fBgated\fP will rescan the kernel interface list looking for changes. .PP .SH "FILES" Many of default filenames listed below contain the string %s, which is replaced by the name with which gated is invoked. Normally this is \fIgated\fP, but if invoked as \fIgated-test\fP, \fIgated\fP will by default look for \fI/etc/gated-test.conf\fP. These paths may all be changed at compilation time. .IP "/usr/tmp/gated_dump" 10 Where \fBgated\fP writes status information. The default is \fI/usr/tmp/%s_dump\fP. Another common path is \fI/var/tmp/%s_dump\fP. .IP "/etc/gated.conf" Where \fBgated\fP looks for it's configuration file. The default is \fI/etc/%s.conf\fP. .IP "/etc/gated.pid" Where \fBgated\fP writes it's process id (PID). The defalt is \fI/etc/%s.pid\fP, but \fI/var/run/%s.pid\fP is common. .PP .SH "AUTHORS" .br \fIMark Fedor .br Jeffrey C Honig .br Rob Coltun .br Dennis Ferguson \fP .SH "SEE ALSO" \fBarp (8)\fP, \fBgdc (8)\fP, \fBfork (2)\fP, \fBifconfig (8)\fP, \fBnetstat (8)\fP, \fBospf_monitor (8)\fP, \fBripquery (8)\fP, \fBrouted (8)\fP, \fBroute (8)\fP .br \fBGateD Documentation\fP .br \fBGateD Configuration Guide\fP .SH "COPYRIGHT INFORMATION" Copyright (c) 1996, 1997 The Regents of the University of Michigan All Rights Reserved License to use, copy, modify, and distribute this software and its documentation can be obtained from Merit at the University of Michigan. This package and associated documentation is Copyright (c) 1990,1991,1992,1993,1994,1995 Cornell University., all rights reserved. This software contains code that is Copyright (c) 1988 Regents of the University of California., all rights reserved.; This package contains code that is Copyright (c) 1989, 1990, 1991 The University of Maryland, College Park, Maryland., all rights reserved. This package contains code that is Copyright 1991 D.L.S. Associates., all rights reserved.