softflowd/softflowctl.8

.\" Copyright (c) 2002 Damien Miller.  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.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 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.
.\"
.Dd October 18, 2002
.Dt SOFTFLOWCTL 8
.Os
.Sh NAME
.Nm softflowctl
.Nd Remote control program for softflowd
.Sh SYNOPSIS
.Nm softflowctl
.Op Fl h
.Op Fl c Ar ctl_sock
.Ar command
.Sh DESCRIPTION
.Nm
is a remote control program used to control a running
.Xr softflowd 8
daemon.
.Pp
The command line options are as follows:
.Bl -tag -width Ds
.It Fl c Ar ctlsock
Specify an alternate location for the remote control socket.
Default is
.Pa /var/run/softflowd.ctl
.It Fl h
Display command line usage information.
.El
.Pp
.Sh COMMANDS
.Bl -tag -width Ds
.It Pa shutdown
Ask
.Xr softflowd 8
to gracefully exit.
This is equivalent to sending it a
.Dv SIGTERM
or
.Dv SIGINT .
.It Pa exit
Ask
.Xr softflowd 8
to immediately exit.
No flow expiry processing or data export is performed.
.It Pa expire-all
Immediately expire all tracked flows.
.It Pa delete-all
Immediately delete all tracked flows.
No flow expiry processing or data export is performed.
.It Pa statistics
Return statistics collected by
.Xr softflowd 8
on expired flows.
.It Pa debug+
Increase the debugging level of
.Xr softflowd 8
.It Pa debug-
Decrease the debugging level.
.It Pa stop-gather
Stops network data collection by
.Xr softflowd 8 .
.It Pa start-gather
Resumes network data collection.
.It Pa dump-flows
Return information on all tracked flows.
.It Pa timeouts
Print information on flow timeout parameters.
.It Pa send-template
Resend a NetFlow v.9 template record before the next flow export.
Has no effect for other flow export versions.
.El
.Sh BUGS
All times are unconditionally displayed in UTC, regardless of the system
timezone. 
Please report bugs in softflowctl to 
https://github.com/irino/softflowd/issues
.Sh AUTHORS
.An Damien Miller Aq djm@mindrot.org
.An Hitoshi Irino (current maintainer) Aq irino@sfc.wide.ad.jp 
.Sh SEE ALSO
.Xr softflowd 8