xref: /freebsd/usr.sbin/flowctl/flowctl.8 (revision bdcbfde31e8e9b343f113a1956384bdf30d1ed62)
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.Dd June 8, 2012
26.Dt FLOWCTL 8
27.Os
28.Sh NAME
29.Nm flowctl
30.Nd
31.Xr ng_netflow 4
32control utility
33.Sh SYNOPSIS
34.Nm
35.Op Fl d Ar level
36.Ar path command
37.Sh DESCRIPTION
38The
39.Nm
40utility is intended to control the
41.Xr ng_netflow 4
42nodes.
43It has a single option:
44.Bl -tag -width ".Fl d Ar level"
45.It Fl d Ar level
46Set the
47.Xr netgraph 3
48debugging level to
49.Ar level .
50.El
51.Sh COMMANDS
52Currently,
53.Nm
54supports only one command.
55.Bl -tag -width ".Cm show"
56.It Cm show Oo Cm ipv4|ipv6 Oc Op Cm human|verbose
57This command is the analog of the
58.Dq "show ip cache flow"
59command of a Cisco router.
60It dumps the contents of the flow cache in Cisco-like format.
61Specifying either
62.Cm ipv4
63or
64.Cm ipv6
65would extract only IPv4 or IPv6 flows respectively.
66It has optional parameter
67.Cm verbose ,
68which is analog of the
69.Dq "show ip cache verbose flow"
70command. Additionally,
71.Cm human
72parameter can be specify to show selected flows in human-readable format.
73.El
74.Sh EXIT STATUS
75.Ex -std
76.Sh SEE ALSO
77.Xr netgraph 3 ,
78.Xr ng_netflow 4
79.Sh AUTHORS
80.An -nosplit
81The
82.Nm
83utility was written by
84.An Gleb Smirnoff Aq Mt glebius@FreeBSD.org ,
85based on
86.Nm ipacctctl
87written by
88.An Roman V. Palagin Aq Mt romanp@unshadow.net .
89