APIRef_tm_net_rate-shaping_class¶

mgmt/tm/net/rate-shaping/class

Rate class configuration

REST Endpoints

Collection URI: /mgmt/tm/net/rate-shaping/class
Collection Methods: OPTIONS, GET
Resource URI: /mgmt/tm/net/rate-shaping/class/~resource id
Resource Methods: OPTIONS, GET, PUT, PATCH, DELETE, POST
Resource Natural Key: name, subPath

Properties

Name	Type	Default Value	Required	Access	Description
`appService`	string		optional	read/write	The application service that the object belongs to.
`ceiling`	uint64	296	optional	read/write	Specifies (in bps) how far beyond the value of the rate option that traffic is allowed to 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.
`ceilingPercentage`	uint64	0	optional	read/write	If you use the parent-class option to associate another class with this class, you can use this option to specify the percentage of the value of the ceiling option of the parent class that is available for this class. The default value is 0 (zero).
`description`	string		optional	read/write	User defined description.
`direction`	string	any	optional	read/write	Specifies the direction of traffic to which this class is applied. The default value is any.
`dropPolicy`	string	tail	optional	read/write	Specifies a drop-policy for this class. You can use one of the pre-configured drop policies, or you can create a customized drop-policy using the drop-policy component. The available preconfigured policies are red (randomly drops packets) and fred (drops packets according to the type of traffic in the flow). The default value is tail (drops the end of the traffic stream). Note that if you specify a value for the shaping-policy option of this class, the drop-policy specified in the specified shaping-policy option takes precedence and changes this value to conform.
`maxBurst`	integer	0	optional	read/write	Specifies the maximum number of bytes that traffic is allowed to burst beyond the value of the rate option. The default value is 0 (zero). Note that the traffic may not burst above the value of the ceiling option.
`parent`	string		optional	read/write	Specifies the class from which this class can borrow any unused bandwidth, thereby supplementing the burst size of this class. Note that borrowing bandwidth affects the value of the rate, ceiling, and queue options.
`queue`	string	sfq	optional	read/write	Specifies the queuing method. The two pre-configured options are sfq and pfifo. Stochastic Fair Queuing (sfq) is a queuing method that queues traffic under a set of many lists, choosing the specific list based on a hash of the connection information. This results in traffic from the same connection always being queued in the same list. SFQ then dequeues traffic from the set of the lists in a round-robin fashion. The overall effect is that fairness of dequeuing is achieved because one connection cannot control the queue at the exclusion of another. If the rate class has a parent class, the default queuing discipline is that of the parent class. If the rate class has no parent class, the default value is sfq. You can create a custom queuing method using the queue command. The Priority FIFO (pfifo) queuing method queues all traffic under a set of five lists based on the Type of Service (ToS) field of the traffic. Four of the lists correspond to the four possible ToS values (Minimum delay, Maximum throughput, Maximum reliability, and Minimum cost). The fifth list represents traffic with no ToS value. The Priority FIFO method processes these five lists in a way that preserves the meaning of the ToS field as much as possible. For example, a packet with the ToS field set to Minimum cost might yield dequeuing to a packet with the ToS field set to Minimum delay.
`rate`	uint64	0	optional	read/write	Specifies the throughput rate allowed for traffic handled by this class. This option is required. The minimum value is 1bps.
`ratePercentage`	uint64	0	optional	read/write	Specifies the percentage of the maximum throughput rate specified for the parent-class that is available for this class. The default value is 0.
`shapingPolicy`	string		optional	read/write	Specifies the name of a shaping policy. Note that the system automatically changes the drop-policy and queue options of this class to match the values in the specified shaping-policy. The default value is none.

iControl Reference Index

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.