apm resource client-rate-class
apm resource client-rate-classBIG-IP TMSH Manapm resource client-rate-class(1)
NAME
client-rate-class - Configures a client rate class resource.
MODULE
apm resource
SYNTAX
Configure the client-rate-class component within the resource module
using the syntax shown in the following sections.
CREATE/MODIFY
create client-rate-class [name]
modify client-rate-class [name]
options:
app-service [[string] | none]
burst [integer]
ceiling [integer]
description [[string] | none]
dscp [integer]
location-specific [true | false]
mode [borrow | discard | shape]
rate [integer]
type [best-effort | controlled-load | guaranteed]
edit client-rate-class [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
DISPLAY
list client-rate-class
list client-rate-class [ [ [name] | [glob] | [regex] ] ... ]
show running-config client-rate-class
show running-config client-rate-class [ [ [name] | [glob] | [regex] ] ... ]
options:
all-properties
non-default-properties
show client-rate-class
show client-rate-class [name]
DELETE
delete client-rate-class [name]
DESCRIPTION
You can use the client-rate-class component to configure a client rate
class resource, which is used in traffic control.
EXAMPLES
create client-rate-class sf1{ dscp 40 rate 60000 ceiling 80000 mode
shape }
Creates a client rate class resource named sf1 used in traffic
control. Sets the dscp to 40 and the rate to 60000, sets the
ceiling to 80000, and sets the mode to shape.
list client-rate-class all
Displays a list of all client rate class on the system.
delete client-rate-class sf1
Deletes the client rate class named sf1 from the system.
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.
burst
Specifies in bytes the maximum amount of data that can reach the
ceiling rate at one time. The default is 0 (zero).
ceiling
Specifies how far, beyond the value specified for the rate option,
that traffic can flow when bursting. 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 bp.
description
Specifies a description for the client rate class. The default is
none.
dscp Specifies six bits of DS field used as a codepoint to select the
PHB (Per Hope Behavior) for a packet in each network node. The
default is -1.
location-specific
Specifies whether or not this object contains one or more
attributes with values that are specific to the location where the
BIG-IP device resides. The location-specific attribute is either
true or false. When using policy sync, mark an object as location-
specific to prevent errors that can occur when policies reference
objects, such as authentication servers, that are specific to a
certain location.
[name]
Specifies a unique name to identify the client rate class.
mode Specifies the mode to use for this client rate class. The options
are:
borrow
Allows traffic on the client rate class to borrow resources
from other flows that are temporarily idle. Traffic that
borrows resources is marked as nonconforming and receives a
lower priority. This is the default.
discard
Discards packets that do not conform to the specified traffic
control descriptor.
shape
Delays packets submitted for transmission until the packets
conform to the specified flow parameters
partition
Displays the partition within which this component resides. The
default is common.
rate Specifies the guaranteed throughput rate of the traffic handled by
this rate class. You can configure the rate in bits per second
(bps), kilobits per second (Kbps), megabits per second (Mbps), or
gigabits per second (Gbps).
type Specifies the service type in use for the client rate class. The
options are:
best-effort
Windows traffic control creates a flow for this client
traffic class, and traffic on the flow is handled with the
same priority as other Best Effort traffic. This is the
default.
controlled-load
Traffic control transmits a very high percentage of packets
to the intended receivers. Packet loss for this type closely
approximates the basic packet error rate of the transmission
medium. Transmission delay for a very high percentage of the
delivered packets does not greatly exceed the minimum transit
delay experienced by any successfully delivered packet.
guaranteed
Guarantees that datagrams arrive within a specified delivery
time and will not be discarded due to queue overflows,
provided that the flow of traffic stays within specified
traffic parameters. This type is intended for applications
that require guaranteed packet delivery.
SEE ALSO
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 2011-2013, 2015. All rights
reserved.
BIG-IP 2015-07-22 apm resource client-rate-class(1)