xref: /freebsd/usr.sbin/flowctl/flowctl.8 (revision 01c2b8ac0d5d7a787a7853f0988b505d26cf8136)
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.\"
25d9a134bfSGleb Smirnoff.\" $FreeBSD$
26d9a134bfSGleb Smirnoff.\"
273097b95aSAlexander V. Chernikov.Dd June 8, 2012
28d9a134bfSGleb Smirnoff.Dt FLOWCTL 8
29aa12cea2SUlrich Spörlein.Os
30d9a134bfSGleb Smirnoff.Sh NAME
31d9a134bfSGleb Smirnoff.Nm flowctl
32d9a134bfSGleb Smirnoff.Nd
33d9a134bfSGleb Smirnoff.Xr ng_netflow 4
34d9a134bfSGleb Smirnoffcontrol utility
35d9a134bfSGleb Smirnoff.Sh SYNOPSIS
36d9a134bfSGleb Smirnoff.Nm
37d9a134bfSGleb Smirnoff.Op Fl d Ar level
38a1068a7dSGleb Smirnoff.Ar path command
39d9a134bfSGleb Smirnoff.Sh DESCRIPTION
40d9a134bfSGleb SmirnoffThe
41d9a134bfSGleb Smirnoff.Nm
42d9a134bfSGleb Smirnoffutility is intended to control the
43d9a134bfSGleb Smirnoff.Xr ng_netflow 4
44d9a134bfSGleb Smirnoffnodes.
45d9a134bfSGleb SmirnoffIt has a single option:
46d9a134bfSGleb Smirnoff.Bl -tag -width ".Fl d Ar level"
47d9a134bfSGleb Smirnoff.It Fl d Ar level
48d9a134bfSGleb SmirnoffSet the
49d9a134bfSGleb Smirnoff.Xr netgraph 3
50d9a134bfSGleb Smirnoffdebugging level to
51d9a134bfSGleb Smirnoff.Ar level .
52d9a134bfSGleb Smirnoff.El
53d9a134bfSGleb Smirnoff.Sh COMMANDS
54d9a134bfSGleb SmirnoffCurrently,
55d9a134bfSGleb Smirnoff.Nm
56d9a134bfSGleb Smirnoffsupports only one command.
57d9a134bfSGleb Smirnoff.Bl -tag -width ".Cm show"
583097b95aSAlexander V. Chernikov.It Cm show Oo Cm ipv4|ipv6 Oc Op Cm human|verbose
59d9a134bfSGleb SmirnoffThis command is the analog of the
60d9a134bfSGleb Smirnoff.Dq "show ip cache flow"
61d9a134bfSGleb Smirnoffcommand of a Cisco router.
62d9a134bfSGleb SmirnoffIt dumps the contents of the flow cache in Cisco-like format.
63344c81a1SWarren BlockSpecifying either
64a1068a7dSGleb Smirnoff.Cm ipv4
65a1068a7dSGleb Smirnoffor
66a1068a7dSGleb Smirnoff.Cm ipv6
67a1068a7dSGleb Smirnoffwould extract only IPv4 or IPv6 flows respectively.
689672556cSGleb SmirnoffIt has optional parameter
699672556cSGleb Smirnoff.Cm verbose ,
709672556cSGleb Smirnoffwhich is analog of the
719672556cSGleb Smirnoff.Dq "show ip cache verbose flow"
723097b95aSAlexander V. Chernikovcommand. Additionally,
733097b95aSAlexander V. Chernikov.Cm human
743097b95aSAlexander V. Chernikovparameter can be specify to show selected flows in human-readable format.
75d9a134bfSGleb Smirnoff.El
76a866e170SRuslan Ermilov.Sh EXIT STATUS
77d9a134bfSGleb Smirnoff.Ex -std
78d9a134bfSGleb Smirnoff.Sh SEE ALSO
79d9a134bfSGleb Smirnoff.Xr netgraph 3 ,
80d9a134bfSGleb Smirnoff.Xr ng_netflow 4
81d9a134bfSGleb Smirnoff.Sh AUTHORS
82d9a134bfSGleb Smirnoff.An -nosplit
83d9a134bfSGleb SmirnoffThe
84d9a134bfSGleb Smirnoff.Nm
85d9a134bfSGleb Smirnoffutility was written by
86*01c2b8acSBaptiste Daroussin.An Gleb Smirnoff Aq Mt glebius@FreeBSD.org ,
87d9a134bfSGleb Smirnoffbased on
88d9a134bfSGleb Smirnoff.Nm ipacctctl
89d9a134bfSGleb Smirnoffwritten by
90*01c2b8acSBaptiste Daroussin.An Roman V. Palagin Aq Mt romanp@unshadow.net .
91