net rate-shaping shaping-policy¶

net rate-shaping shaping-policy(1) BIG-IP TMSH Manual net rate-shaping shaping-policy(1)

NAME
shaping-policy - Configures a custom rate shaping policy for traffic flow.

MODULE
net rate-shaping

SYNTAX
Configure the shaping-policy component within the net rate-shaping module using the syntax in the following
sections.

CREATE/MODIFY
create shaping-policy [name]
modify shaping-policy [name]
options:
app-service [[string] | none]
ceiling-percentage [integer]
description [string]
drop-policy [ [name] | none]
max-burst [integer]
queue [ [name] | none]
rate-percentage [integer]

edit shaping-policy [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties

DISPLAY
list shaping-policy
list shaping-policy [ [ [name] | [glob] | [regex] ] ... ]
show running-config shaping-policy
show running-config shaping-policy [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
one-line

DELETE
delete shaping-policy [all | [name] ]

DESCRIPTION
You can use the shaping-policy component to create a custom rate shaping policy to handle traffic flow, and
then associate the shaping policy with a class.

Note that if you specify a value for the shaping-policy option of a class, the system automatically changes
the ceiling-percentage, drop-policy, max-burst, queue, and rate-percentage options of that class to match the
values in the shaping policy.

EXAMPLES
create shaping-policy my_sp

Creates a shaping policy named my_sp.

list shaping policies all-properties

Displays all of the properties of all of the shaping policies.

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-percentage
Specifies the percentage of the value of the ceiling option specified for the parent associated with the
class component to which this shaping policy is associated. The default value is 0 (zero).

description
User defined description.

drop-policy
Specifies the name of a drop policy for this traffic flow. The default value is none.

You can use one of the pre-configured drop policies, or you can create a customized drop-policy using the
drop-policy component.

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. This is the simplest
drop policy.

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 is allowed to burst beyond the value of the rate
option of the class component to which this shaping policy is associated. The default value is 0 (zero).

Valid units are byte, bytes(default), eb, gb, k, kb, mb, pb, and tb.

name Specifies a unique name for the component. This option is required for the commands create, delete, and
modify.

queue
Specifies the queuing method for this traffic flow. The default value is none. You can create a
customized queuing method using the queue component. For more information, see net rate-shaping queue.

The preconfigured queues 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.

rate-percentage
Specifies the percentage of the value of the rate option of the parent, which is associated with the
class component to which this shaping policy is associated, that is available for this traffic flow. The
default value is 0 (zero).

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.

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.

BIG-IP 2013-10-17 net rate-shaping shaping-policy(1)