share/man/man7ipp/ipqos.7ipp

   1 '\" te
   2 .\"  Copyright (c) 2002, Sun Microsystems Inc.
   3 .\"  All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH IPQOS 7IPP "Feb 25, 2002"
   8 .SH NAME
   9 ipqos \- IP Quality of Service
  10 .SH DESCRIPTION
  11 .sp
  12 .LP
  13 \fBipqos\fR is an implementation of the Differentiated Services model defined
  14 in \fIRFC2475: An Architecture for Differentiated Services\fR, which defines
  15 the following entities: multi-field classifier, meter, marker, and dropper. The
  16 Solaris implementation of \fBipqos\fR adds a flow accounting entity.
  17 .sp
  18 .LP
  19 These entities can be combined into processing paths that constitute a series
  20 of actions that are performed on groups of flows. The classifier groups
  21 together flows and directs them in a given processing path. Classifier
  22 configuration and path construction are achieved using the \fBipqosconf\fR(1M)
  23 command.
  24 .sp
  25 .LP
  26 A summary of the \fBipqos\fR entities follows. For more information, refer to
  27 the corresponding man page for each entity.
  28 .sp
  29 .ne 2
  30 .na
  31 \fBipgpc\fR
  32 .ad
  33 .RS 21n
  34 An implementation of the classifier defined in the model. \fBipgpc\fR has been
  35 extended and is able to select traffic based on IP header parameters, user id,
  36 project id, interface name, interface group and direction.
  37 .RE
  38
  39 .sp
  40 .ne 2
  41 .na
  42 \fBtokenmt, tswtclmt\fR
  43 .ad
  44 .RS 21n
  45 These modules implement different metering algorithms. \fBtokenmt\fR implements
  46 both \fIRFC2697: A Single Rate Three Color Marker \fR and \fIRFC 2698: A Two
  47 Rate Three Color Marker\fR. \fItswtclmt\fR implements \fIRFC2859: A Time
  48 Sliding Window Three Color Marker\fR. These modules only implement the metering
  49 functions defined in the RFCs.
  50 .RE
  51
  52 .sp
  53 .ne 2
  54 .na
  55 \fBdlcosmk\fR
  56 .ad
  57 .RS 21n
  58 A marker entity that allows the setting of the user priority field of Ethernet
  59 frames as defined in the \fIIEEE 802.1D\fR specification. \fBdlcosmk\fR is only
  60 available with VLAN capable       network interfaces.
  61 .RE
  62
  63 .sp
  64 .ne 2
  65 .na
  66 \fBdscpmk\fR
  67 .ad
  68 .RS 21n
  69 A marker entity that enables the setting of the Differentiated Services Code
  70 Point Value in the IP header as defined in \fIRFC 2474: Definition of the
  71 Differentiated Services Field (DS Field)\fR in the IPv4 and IPv6 headers.
  72 .RE
  73
  74 .sp
  75 .ne 2
  76 .na
  77 \fBflowacct\fR
  78 .ad
  79 .RS 21n
  80 An accounting module that utilizes the Solaris extended accounting facility.
  81 \fBflowacct\fR logs all flows with parameters used to build a charge back
  82 mechanism.
  83 .RE
  84
  85 .SH STATISTICS
  86 .sp
  87 .LP
  88 \fBipqos\fR modules export statistics through the \fBkstat\fR facility.
  89 Exported statistics contain the following common parameters:
  90 .sp
  91 .ne 2
  92 .na
  93 \fBmodule\fR
  94 .ad
  95 .RS 12n
  96 module name
  97 .RE
  98
  99 .sp
 100 .ne 2
 101 .na
 102 \fBinstance\fR
 103 .ad
 104 .RS 12n
 105 dynamic parameter identifying a specific instance
 106 .RE
 107
 108 .sp
 109 .ne 2
 110 .na
 111 \fBname\fR
 112 .ad
 113 .RS 12n
 114 a string  for global statistics (for example, ipgpc global stat) or a class
 115 name for per-class statistics for a classifier action
 116 .RE
 117
 118 .sp
 119 .LP
 120 To verify classifier configuration, generate traffic for each of the configured
 121 classes and check that the statistic counters for the expected class are
 122 increased. If you're unsure about the parameters for your traffic, you can use
 123 \fBsnoop\fR(1M) to determine them.
 124 .sp
 125 .LP
 126 Some actions have the instance id of the next configured action in their
 127 statistics. This instance id can be used to follow the action processing path.
 128 Instance id's -1 and -2 are the built-in actions continue and drop,
 129 respectively.
 130 .sp
 131 .LP
 132 Examples:
 133 .sp
 134 .LP
 135 To retrieve all statistics for ipgpc:
 136 .sp
 137 .LP
 138  \fBkstat -m ipgpc\fR
 139 .sp
 140 .LP
 141 To retrieve statistics for the class http:
 142 .sp
 143 .LP
 144  \fBkstat -m ipgpc -c http\fR
 145 .SH SEE ALSO
 146 .sp
 147 .LP
 148 \fBipqosconf\fR(1M), \fBdlcosmk\fR(7ipp), \fBdscpmk\fR(7ipp),
 149 \fBflowacct\fR(7ipp), \fBipgpc\fR(7ipp), \fBtokenmt\fR(7ipp),
 150 \fBtswtclmt\fR(7ipp)
 151 .sp
 152 .LP
 153 \fIRFC 2475, An Architecture for Differentiated Services\fR S. Blake, D. Black,
 154 M. Carlson, E. Davies, Z. Wang, W. Weiss \(em The Internet Society, 1998
 155 .sp
 156 .LP
 157 \fIRFC 2474, Definition of the Differentiated Services Field (DS Field) in the
 158 IPv4 and IPv6 Headers\fR K. Nichols, S. Blake, F. Baker, D. Black \(em The
 159 Internet Society, 1998
 160 .sp
 161 .LP
 162 \fIRFC 2697, A Single Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em
 163 The Internet Society, 1999
 164 .sp
 165 .LP
 166 \fIRFC 2698, A Two Rate Three Color Marker\fR J. Heinanen, R. Guerin \(em The
 167 Internet Society, 1999
 168 .sp
 169 .LP
 170 \fIRFC 2859, A Time Sliding Window Three Colour Marker (TSWTCM)\fR W. Fang, N.
 171 Seddigh, B. Nandy \(em The Internet Society, 2000