share/man/man7ipp/flowacct.7ipp

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems Inc.  All Rights Reserved
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH FLOWACCT 7IPP "Sep 29, 2004"
   7 .SH NAME
   8 flowacct \- Flow Accouting module
   9 .SH DESCRIPTION
  10 .sp
  11 .LP
  12 The flow accounting module \fBflowacct\fR enables you to record flow details.
  13 You use flow details to gather statistics and/or for billing purposes.
  14 Accounting consists of recording flow details in a location you designate and
  15 in a format that you can retrieve at a later stage. IPQoS accounting relies on
  16 the exacct mechanism to store and retrieve flow information.
  17 .sp
  18 .LP
  19 A flow is defined by the 5-tuple - saddr, sport, daddr, dport and protocol.
  20 .sp
  21 .LP
  22 Typically, the accounting module is the last datapath element in a sequence of
  23 actions. Flow attributes include ToS/DS, user id, project id, creation time
  24 (time the flow was created), last seen (when pkts for the flow were last seen),
  25 action name (instance that recorded the flow information), nbytes and npackets.
  26 Attributes are split into groups entitled \fBbasic\fR and \fBextended\fR. The
  27 basic group records only the nbytes, npackets and action name, while the
  28 extended group is a superset of the basic group and records all attributes. The
  29 attributes to be recorded, in addition to the accounting file that contains
  30 flow details, are selected using \fBacctadm\fR(1M). The \fBflowacct\fR module
  31 does not provide a mechanism to retrieve flow information from the accounting
  32 file nor to interpret the retrieved information.
  33 .SH STATISTICS
  34 .sp
  35 .LP
  36 The flowacct module exports the following statistics available through kstat:
  37 .sp
  38 .in +2
  39 .nf
  40 module: flowacct                   instance: <action id>
  41   name: Flowacct statistics        class <action name>
  42         bytes_in_tbl               <bytes in the flow table>
  43         epackets                   <packets in error>
  44         flows_in_tbl               <flow records in the flow table>
  45         nbytes                     <number of bytes through this instance>
  46         npackets                   <number of packets>
  47         usedmem                    <memory, in bytes, used by the flow table>
  48 .fi
  49 .in -2
  50
  51 .SH FILES
  52 .sp
  53 .ne 2
  54 .na
  55 \fB\fB/kernel/ipp/sparcv9/flowacct\fR\fR
  56 .ad
  57 .sp .6
  58 .RS 4n
  59 64-bit module (SPARC only.)
  60 .RE
  61
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBipqosconf\fR(1M), \fBacctadm\fR(1M), \fBlibexacct3LIB\fR,
  66 \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp), \fBipqos\fR(7ipp), \fBipgpc\fR(7ipp),
  67 \fBtokenmt\fR(7ipp), \fBtswtclmt\fR(7ipp)