usr.sbin/flowctl/flowctl.8

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