net rate-shaping class
net rate-shaping class(1) BIG-IP TMSH Manual net rate-shaping class(1)
NAME
class - Configures a rate class.
MODULE
net rate-shaping
SYNTAX
Configure the class component within the net rate-shaping module using the syntax in the following sections.
CREATE/MODIFY
create class [name]
modify class [name]
options:
app-service [[string] | none]
ceiling [integer]
ceiling-percentage [integer]
description [string]
direction [any | to-client | to-server]
drop-policy [ [custom drop policy name ] | fred | red | tail]
max-burst [integer]
parent [class name]
queue [ [custom queue name | pfifp | sfq]
rate [integer]
rate-percentage [integer]
shaping-policy [ [custom shaping policy name] | none]
edit class [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list class
list class [ [ [name] | [glob] | [regex] ] ... ]
show running-config class
show running-config class [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
current-module
non-default-properties
one-line
show class
show class [ [ [name] | [glob] | [regex] ] ... ]
options:
current-module
(default | exa | gig | kil | meg | peta | raw | tera | yotta | zetta)
DELETE
delete class [all | [name] ]
DESCRIPTION
You can use the class component to create a rate class. A rate class lets you specify shaping properties for a specific
type of traffic, such as Layer 3 traffic that specifies a certain source, destination, or service. Specifically, a rate
class defines the number of bits per second that the system accepts per flow and the number of packets in a queue.
You configure rate shaping by creating a class and then assigning the class to a packet filter, a virtual server, or from
within an iRule. When you configure a class, you can associate another class with the class you are configuring using the
parent option.
You can also associate drop policies, shaping policies, and queues with a class using the drop-policy, shaping-policy, and
queue options of the class component. You can associate pre-configured drop policies and queues with the class, or you can
create custom drop policies, queues, and shaping policies, and then associate them with the class.
Note that if you specify a value for the shaping-policy option of the class, the system automatically changes the ceiling-
percentage, drop-policy, max-burst, queue, and rate-percentage options of the class to match the values in the specified
shaping policy.
EXAMPLES
create class my_class rate 10
Creates a class named my_class with a rate of 10.
list class all-properties
Displays all of the properties of all of the classes.
OPTIONS
app-service
Specifies the name of the application service to which the object belongs. The default value is none. Note: If the
strict-updates option is enabled on the application service that owns the object, you cannot modify or delete the
object. Only the application service can modify or delete the object.
ceiling
Specifies (in bps) how far beyond the value specified for the rate option that traffic can flow. This number sets an
absolute limit. No traffic can exceed this rate. The rate class might limit traffic throughput to the value of the
rate option when there is high contention among siblings of a parent-child class hierarchy. The default value is the
value of the rate option. The minimum value is 296 bps.
ceiling-percentage
Specifies the ceiling of the rate class as a percentage of the ceiling of the associated parent class. This option
applies only to rate classes with an associated parent rate class. The default value is 0 (zero), which indicates that
the class uses the value of the ceiling option.
description
User defined description.
direction
Specifies the direction of traffic to which the class is applied. The default value is any.
drop-policy
Specifies the name of a drop policy. You can use one of the pre-configured drop policies, or you can create a
customized drop policy using the drop-policy component.
The default value is tail, which is the simplest drop policy. The pre-configured drop policies are:
fred Specifies that the system uses Flow-based Random Early Detection to decide whether to drop packets based on the
aggressiveness of each flow.
red Specifies that the system uses Random Early Detection to determine whether to drop packets to maintain the
average queue length within the specified range.
tail Specifies that the system drops all incoming packets when the queue is full.
glob Displays the items that match the glob expression. See help glob for a description of glob expression syntax.
max-burst
Specifies the maximum number of bytes that traffic can burst beyond the value of the rate option. The traffic may not
burst higher than the value of the ceiling option. The default value is 0 (zero).
name Specifies a unique name for the component. This option is required for the commands create, delete, and modify.
parent
Associates another class with this class. The class you are configuring (which when you configure a parent class for
it becomes a child class) can borrow bandwidth from the parent class. The parent class can use any of the unused
bandwidth of the child class.
queue
Specifies the queuing method. The default value is sfq. The pre-configured options are:
pfifo
The Priority FIFO queuing method queues all traffic under a set of five sub-queues based on the Type of Service
(TOS) field of the traffic. Four of the sub-queues correspond to the four possible TOS values (Minimum delay,
Maximum throughput, Maximum reliability, and Minimum cost). The fifth sub-queue represents traffic with no TOS
value. The Priority FIFO method processes these five sub-queues in a way that preserves the meaning of the TOS
value as much as possible. For example, a packet with the TOS value of Minimum cost might yield dequeuing to a
packet with the TOS value of Minimum delay.
sfq Stochastic Fair Queuing is a queuing method that further queues packets under a set of many FIFO sub-queues.
Selecting a specific sub-queue is based on a hash of the flow address information. SFQ dequeues packets from the
set of sub-queues in a Round Robin fashion. The overall effect is that fairness of dequeuing is achieved, because
packets from one flow cannot occupy the queues at the exclusion of those of another flow.
Note that if you assign a shaping policy to the class, then the queuing discipline of the class becomes that
specified in the shaping policy. If you do not assign a shaping policy to the class, the default queue is sfq.
rate Specifies the guaranteed throughput rate of the traffic handled by this rate class, in bits per second (bps).
rate-percentage
Specifies the rate of the rate class as a percentage of the ceiling of the associated parent class. This option
applies only to rate classes with an associated parent rate class. The default value is 0 (zero), which specifies that
the system uses the value of the rate option.
regex
Displays the items that match the regular expression. The regular expression must be preceded by an at sign (@[regular
expression]) to indicate that the identifier is a regular expression. See help regex for a description of regular
expression syntax.
shaping-policy
Specifies the name of a shaping policy. The default value is none.
Note that the system automatically changes the ceiling-percentage, drop-policy, max-burst, queue, and rate-percentage
options of this class to match the values in the specified shaping policy.
SEE ALSO
create, delete, edit, glob, list, modify, net rate-shaping drop-policy, net rate-shaping queue, net rate-shaping shaping-
policy, regex, show, tmsh
COPYRIGHT
No part of this program may be reproduced or transmitted in any form or by any means, electronic or mechanical, including
photocopying, recording, or information storage and retrieval systems, for any purpose other than the purchaser's personal
use, without the express written permission of F5 Networks, Inc.
F5 Networks and BIG-IP (c) Copyright 2008-2010, 2012-2013, 2016. All rights reserved.
BIG-IP 2016-03-14 net rate-shaping class(1)