xref: /freebsd/usr.sbin/flowctl/flowctl.8 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\" Copyright (c) 2004-2005 Gleb Smirnoff <glebius@FreeBSD.org>
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd March 23, 2005
28.Os
29.Dt FLOWCTL 8
30.Sh NAME
31.Nm flowctl
32.Nd
33.Xr ng_netflow 4
34control utility
35.Sh SYNOPSIS
36.Nm
37.Op Fl d Ar level
38.Ar node command
39.Sh DESCRIPTION
40The
41.Nm
42utility is intended to control the
43.Xr ng_netflow 4
44nodes.
45It has a single option:
46.Bl -tag -width ".Fl d Ar level"
47.It Fl d Ar level
48Set the
49.Xr netgraph 3
50debugging level to
51.Ar level .
52.El
53.Sh COMMANDS
54Currently,
55.Nm
56supports only one command.
57.Pp
58.Bl -tag -width ".Cm show"
59.It Cm show
60This command is the analog of the
61.Dq "show ip cache flow"
62command of a Cisco router.
63It dumps the contents of the flow cache in Cisco-like format.
64It has optional parameter
65.Cm verbose ,
66which is analog of the
67.Dq "show ip cache verbose flow"
68command.
69.El
70.Sh EXIT STATUS
71.Ex -std
72.Sh SEE ALSO
73.Xr netgraph 3 ,
74.Xr ng_netflow 4
75.Sh AUTHORS
76.An -nosplit
77The
78.Nm
79utility was written by
80.An Gleb Smirnoff Aq glebius@FreeBSD.org ,
81based on
82.Nm ipacctctl
83written by
84.An Roman V. Palagin Aq romanp@unshadow.net .
85