xref: /freebsd/usr.sbin/flowctl/flowctl.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
19672556cSGleb Smirnoff.\" Copyright (c) 2004-2005 Gleb Smirnoff <glebius@FreeBSD.org>
2d9a134bfSGleb Smirnoff.\" All rights reserved.
3d9a134bfSGleb Smirnoff.\"
4d9a134bfSGleb Smirnoff.\" Redistribution and use in source and binary forms, with or without
5d9a134bfSGleb Smirnoff.\" modification, are permitted provided that the following conditions
6d9a134bfSGleb Smirnoff.\" are met:
7d9a134bfSGleb Smirnoff.\" 1. Redistributions of source code must retain the above copyright
8d9a134bfSGleb Smirnoff.\"    notice, this list of conditions and the following disclaimer.
9d9a134bfSGleb Smirnoff.\" 2. Redistributions in binary form must reproduce the above copyright
10d9a134bfSGleb Smirnoff.\"    notice, this list of conditions and the following disclaimer in the
11d9a134bfSGleb Smirnoff.\"    documentation and/or other materials provided with the distribution.
12d9a134bfSGleb Smirnoff.\"
13d9a134bfSGleb Smirnoff.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14d9a134bfSGleb Smirnoff.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15d9a134bfSGleb Smirnoff.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16d9a134bfSGleb Smirnoff.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17d9a134bfSGleb Smirnoff.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18d9a134bfSGleb Smirnoff.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19d9a134bfSGleb Smirnoff.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20d9a134bfSGleb Smirnoff.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21d9a134bfSGleb Smirnoff.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22d9a134bfSGleb Smirnoff.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23d9a134bfSGleb Smirnoff.\" SUCH DAMAGE.
24d9a134bfSGleb Smirnoff.\"
253097b95aSAlexander V. Chernikov.Dd June 8, 2012
26d9a134bfSGleb Smirnoff.Dt FLOWCTL 8
27aa12cea2SUlrich Spörlein.Os
28d9a134bfSGleb Smirnoff.Sh NAME
29d9a134bfSGleb Smirnoff.Nm flowctl
30d9a134bfSGleb Smirnoff.Nd
31d9a134bfSGleb Smirnoff.Xr ng_netflow 4
32d9a134bfSGleb Smirnoffcontrol utility
33d9a134bfSGleb Smirnoff.Sh SYNOPSIS
34d9a134bfSGleb Smirnoff.Nm
35d9a134bfSGleb Smirnoff.Op Fl d Ar level
36a1068a7dSGleb Smirnoff.Ar path command
37d9a134bfSGleb Smirnoff.Sh DESCRIPTION
38d9a134bfSGleb SmirnoffThe
39d9a134bfSGleb Smirnoff.Nm
40d9a134bfSGleb Smirnoffutility is intended to control the
41d9a134bfSGleb Smirnoff.Xr ng_netflow 4
42d9a134bfSGleb Smirnoffnodes.
43d9a134bfSGleb SmirnoffIt has a single option:
44d9a134bfSGleb Smirnoff.Bl -tag -width ".Fl d Ar level"
45d9a134bfSGleb Smirnoff.It Fl d Ar level
46d9a134bfSGleb SmirnoffSet the
47d9a134bfSGleb Smirnoff.Xr netgraph 3
48d9a134bfSGleb Smirnoffdebugging level to
49d9a134bfSGleb Smirnoff.Ar level .
50d9a134bfSGleb Smirnoff.El
51d9a134bfSGleb Smirnoff.Sh COMMANDS
52d9a134bfSGleb SmirnoffCurrently,
53d9a134bfSGleb Smirnoff.Nm
54d9a134bfSGleb Smirnoffsupports only one command.
55d9a134bfSGleb Smirnoff.Bl -tag -width ".Cm show"
563097b95aSAlexander V. Chernikov.It Cm show Oo Cm ipv4|ipv6 Oc Op Cm human|verbose
57d9a134bfSGleb SmirnoffThis command is the analog of the
58d9a134bfSGleb Smirnoff.Dq "show ip cache flow"
59d9a134bfSGleb Smirnoffcommand of a Cisco router.
60d9a134bfSGleb SmirnoffIt dumps the contents of the flow cache in Cisco-like format.
61344c81a1SWarren BlockSpecifying either
62a1068a7dSGleb Smirnoff.Cm ipv4
63a1068a7dSGleb Smirnoffor
64a1068a7dSGleb Smirnoff.Cm ipv6
65a1068a7dSGleb Smirnoffwould extract only IPv4 or IPv6 flows respectively.
669672556cSGleb SmirnoffIt has optional parameter
679672556cSGleb Smirnoff.Cm verbose ,
689672556cSGleb Smirnoffwhich is analog of the
699672556cSGleb Smirnoff.Dq "show ip cache verbose flow"
703097b95aSAlexander V. Chernikovcommand. Additionally,
713097b95aSAlexander V. Chernikov.Cm human
723097b95aSAlexander V. Chernikovparameter can be specify to show selected flows in human-readable format.
73d9a134bfSGleb Smirnoff.El
74a866e170SRuslan Ermilov.Sh EXIT STATUS
75d9a134bfSGleb Smirnoff.Ex -std
76d9a134bfSGleb Smirnoff.Sh SEE ALSO
77d9a134bfSGleb Smirnoff.Xr netgraph 3 ,
78d9a134bfSGleb Smirnoff.Xr ng_netflow 4
79d9a134bfSGleb Smirnoff.Sh AUTHORS
80d9a134bfSGleb Smirnoff.An -nosplit
81d9a134bfSGleb SmirnoffThe
82d9a134bfSGleb Smirnoff.Nm
83d9a134bfSGleb Smirnoffutility was written by
84*01c2b8acSBaptiste Daroussin.An Gleb Smirnoff Aq Mt glebius@FreeBSD.org ,
85d9a134bfSGleb Smirnoffbased on
86d9a134bfSGleb Smirnoff.Nm ipacctctl
87d9a134bfSGleb Smirnoffwritten by
88*01c2b8acSBaptiste Daroussin.An Roman V. Palagin Aq Mt romanp@unshadow.net .
89