operational user interface for gated
gdc [ -q ] [ -t seconds ]
provides a user-oriented interface for the operation of the
routing daemon. It provides support for starting and
stopping the daemon, for the delivery of signals to manipulate the
daemon when it is operating, for the maintenance and syntax checking
of configuration files, and for the production and removal of state dumps
and core dumps.
can reliably determine gated's running state and
can produce a reliable
exit status when errors occur, making it advantageous for use in
shell scripts which manipulate
Commands executed using
and, optionally, error messages produced by the execution of those
commands, are logged via the same
itself uses, providing an audit trail of operations performed on
The command-line options are:
The following commands cause signals to be delivered to
gated for various purposes:
Run quietly. With this option, informational messages
which are normally printed to the standard output are
suppressed and error messages are logged via
instead of being printed to the standard error output.
This is often convenient when running gdc from a
Specifies the time in seconds which gdc will
spend waiting for gated to complete certain
operations, in particular at termination and startup. By
default this value is set to 10 seconds.
By default, gated obtains its configuration from
a file normally named /etc/gated.conf. The
gdc program also maintains several other versions
of the configuration file, in particular named:
Send an abort signal to gated,
causing it to terminate with a core dump.
Signal gated to dump its current state into the
Signal gated to recheck the interface
configuration. gated normally does this
periodically in any event, but the facility can be used to
force the daemon to check interface status immediately when
changes are known to have occurred.
Cause gated to terminate ungracefully. Normally
useful when the daemon has hung.
Signal gated to reread its configuration file,
reconfiguring its current state as appropriate.
Signal gated to terminate after shutting down all
operating routing protocols gracefully. Executing this
command a second time should cause gated to
terminate even if some protocols have not yet fully shut
If gated is currently tracing to a file, cause
tracing to be suspended and the trace file to be closed.
If gated tracing is currently suspended, cause
the trace file to be reopened and tracing initiated. This
is useful for moving trace files.
The following commands perform operations related to configuration files:
The new configuration file. When gdc
is requested to install a new configuration file,
/etc/gated.conf+ is renamed
The old configuration file. When gdc
is requested to install a new configuration file, the
previous /etc/gated.conf is renamed to
The really old configuration file. gdc
retains the previous old configuration file under
The following commands provide support for starting and
stopping gated and for determining its running
for syntax errors. This is usefully done after changes to the configuration
file but before sending a
signal to the currently running
to ensure that there are no errors in the configuration which would cause
to terminate on reconfiguration. When this command is used,
issues an informational message indicating whether there were parse
errors or not, and if so saves the error output in a file for inspection.
Like checkconf except that the new
configuration file, /etc/gated.conf+, is checked
Move the /etc/gated.conf+ file into place as
/etc/gated.conf, retaining the older versions of
the file as described above. gdc will decline to
do anything when given this command if the new
configuration file doesn't exist or otherwise looks
Rotate the configuration files in the newer
direction, in effect moving the old configuration
file to /etc/gated.conf. The command will
decline to perform the operation if
/etc/gated.conf- doesn't exist or is zero
length, or if the operation would delete an existing,
non-zero length /etc/gated.conf+ file.
Perform a backout operation even if
/etc/gated.conf+ exists and is of non-zero
Set all configuration files to mode 664, owner root, group
gdmaint. This allows a trusted non-root user to modify the
If /etc/gated.conf+ does not exist, create a zero
length file with the file mode set to 664, owner root,
group gdmaint. This allows a trusted non-root user to
install a new configuration file.
The following commands allow the removal of files created by
the execution of some of the commands above:
Determine if gated is currently running. This is
done by checking to see if gated has a lock on
the file containing its pid, if the pid in the file is
sensible and if there is a running process with that pid.
Exits with zero status if gated is running,
Start gated. The command returns an error if
gated is already running. Otherwise, it executes
the gated binary and waits for up to the delay
interval (10 seconds by default, as set with the
-t option otherwise) until the newly started
process obtains a lock on the pid file. A non-zero exit
status is returned if an error is detected while executing
the binary, or if a lock is not obtained on the pid file
within the specified wait time.
Stop gated, gracefully if possible, ungracefully
if not. The command returns an error (with non-zero exit
status) if gated is not currently running.
Otherwise, it sends a terminate signal to gated
and waits for up to the delay interval (10 seconds by
default, as specified with the -t option
otherwise) for the process to exit. Should gated
fail to exit within the delay interval, it is then signaled
again with a second terminate signal. Should it fail to
exit by the end of the second delay interval, it is
signaled for a third time with a kill signal. This should
force immediate termination unless something is very
broken. The command terminates with zero exit status when
it detects that gated has terminated, non-zero
If gated is running, it is terminated via the
same procedure as is used for the stop command
above. When the previous gated terminates, or if
it was not running prior to command execution, a new
gated process is executed using the procedures
described for the start command above. A
non-zero exit status is returned if any step in this
procedure appears to have failed.
Removes any existing
core dump file.
Removes any existing
state dump file.
Removes the parse error file generated when a
command is executed and syntax errors are encountered in the
configuration file being checked.
Many commands only work when
is installed in the system directory it was configured with.
the gated binary
current gated configuration file
newer configuration file
older configuration file
much older configuration file
where gated stores its pid
gated's state dump file
where configuration file parse errors go
where gated drops its core file
© 2003 Caldera International, Inc. All rights reserved.
SCO OpenServer Release 5.0.7 -- 11 February 2003