LocalLB::RateClass¶
Introduced : BIG-IP_v9.0
The RateClass interface enables you to work with the definitions and
attributes of a rate class class. Rate filtering refers to the ability
to enforce configurable bandwidth consumption limitations upon
user-defined traffic classes. The purpose of a Rate class is to allow
the network administrator to effectively divide a single bandwidth
resource through a gateway among preferred applications or traffic
classes. Rate filtering is somewhat related to packet filtering. The
key difference between the two is that packet filters seek to enforce
an access policy on traffic, and Rate Filter classes seek to enforce a
throughput policy on traffic.
Methods¶
| Method | Description | Introduced |
| create | Creates the specified rate classes. Note that this method is deprecated. Please use create_v2. | BIG-IP_v9.0 |
| create_drop_policy | Creates the specified drop policies, given the drop policy type, the general strategy used by the rate filter to throttle traffic. Note that pre-defined drop policies exist with a basic configuration for each type - “tail”, “red”, and “fred”. Also note that a rate filter class defaults to using a “tail” drop policy. | BIG-IP_v10.1.0 |
| create_queueing_method | Creates the specified queueing methods, given their queueing method type. | BIG-IP_v10.1.0 |
| create_shaping_policy | Creates the specified shaping policies. | BIG-IP_v10.1.0 |
| create_v2 | Creates the specified rate classes. | BIG-IP_v12.1.0 |
| delete_all_drop_policies | Deletes all drop policies | BIG-IP_v10.1.0 |
| delete_all_queueing_methods | Deletes all queueing methods. | BIG-IP_v10.1.0 |
| delete_all_rate_classes | Deletes all rate classes. | BIG-IP_v9.0 |
| delete_all_shaping_policies | Deletes all shaping policies. | BIG-IP_v10.1.0 |
| delete_drop_policy | Deletes the specified drop policies | BIG-IP_v10.1.0 |
| delete_queueing_method | Deletes the specified queueing methods. | BIG-IP_v10.1.0 |
| delete_rate_class | Deletes the specified rate classes. | BIG-IP_v9.0 |
| delete_shaping_policy | Deletes the specified shaping policies. | BIG-IP_v10.1.0 |
| get_all_statistics | Gets the statistics for all the rate classes. | BIG-IP_v9.0 |
| get_base_rate | Gets the base rates for the specified rate classes. The base rate specifies the maximum throughput to allot to traffic handled by the Rate Class. Packets in excess of the posted rate will be dropped. Note that this method is deprecated. Please use get_base_rate_v2. | BIG-IP_v9.0 |
| get_base_rate_v2 | Gets the base rates for the specified rate classes. The base rate specifies the maximum throughput to allot to traffic handled by the Rate Class. Packets in excess of the posted rate will be dropped. | BIG-IP_v12.1.0 |
| get_burst_size | Gets the burst sizes for the specified rate classes. The burst size specifies maximum number of bytes that traffic is allowed to burst beyond the base rate. | BIG-IP_v9.0 |
| get_ceiling_rate | Gets the ceiling rates for the specified rate classes. The ceiling rate specifies how far beyond the base rate the traffic is allowed to flow when bursting. The ceiling rate is an absolute limit - it is impossible for traffic to flow at a higher rate than the ceiling rate, even when bursting. If the ceiling rate is omitted or is equal to the base rate, the traffic may not exceed the base rate. It is illegal for the ceiling rate to be less than the base rate. Note that this method is deprecated. Please use get_ceiling_rate_v2. | BIG-IP_v9.0 |
| get_ceiling_rate_v2 | Gets the ceiling rates for the specified rate classes. The ceiling rate specifies how far beyond the base rate the traffic is allowed to flow when bursting. The ceiling rate is an absolute limit - it is impossible for traffic to flow at a higher rate than the ceiling rate, even when bursting. If the ceiling rate is omitted or is equal to the base rate, the traffic may not exceed the base rate. It is illegal for the ceiling rate to be less than the base rate. | BIG-IP_v12.1.0 |
| get_description | Gets the descriptions for a set of rate filter classes. | BIG-IP_v11.0.0 |
| get_direction | Gets the direction types being used by the specified rate classes. | BIG-IP_v9.0 |
| get_direction_vlan | Gets the VLAN whose outbound traffic is rate filtered. This is only valid for the DIRECTION_VLAN direction. | BIG-IP_v10.1.0 |
| get_drop_policy | Gets the name of the drop policy, specifying how a rate filter drops packets when the rate filter is throttling traffic. | BIG-IP_v10.1.0 |
| get_drop_policy_average_packet_size | Gets the average packet (maximum transmission unit (MTU)) size. This is only valid for the “fred” and “red” types. | BIG-IP_v10.1.0 |
| get_drop_policy_description | Gets the descriptions for a set of drop policies. | BIG-IP_v11.0.0 |
| get_drop_policy_drop_limit_factor | Gets the drop limit factor. This is only valid for the “fred” type. | BIG-IP_v10.1.0 |
| get_drop_policy_list | Gets a list of all drop policies | BIG-IP_v10.1.0 |
| get_drop_policy_maximum_active_connections | Gets the maximum number of active connections for each queue. This is only valid for the “fred” type. | BIG-IP_v10.1.0 |
| get_drop_policy_maximum_probability | Gets the maximum probability for dropping packets when the average queue length is between the minimum and maximum thresholds. This is only valid for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| get_drop_policy_maximum_queue_size | Gets the maximum queue size. This is only valid for the “red” type. | BIG-IP_v10.1.0 |
| get_drop_policy_maximum_queue_threshold | Gets the queue length threshold above which packets are dropped when the rate filter is throttling traffic. This is only valid for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| get_drop_policy_minimum_queue_threshold | Gets the queue length threshold below which packets are not dropped when the rate filter is throttling traffic. This is only valid for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| get_drop_policy_no_drop_limit_factor | Gets the no-drop limit factor. This is only valid for the “fred” type. | BIG-IP_v10.1.0 |
| get_drop_policy_type | Gets the drop policy type | BIG-IP_v10.1.0 |
| get_drop_policy_weight | Gets the weight used to calculate the average queue lengths. This is only valid for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| get_list | Gets a list of all rate classes. | BIG-IP_v9.0 |
| get_parent | Gets the name of the parent rate class. Any child Rate Class has the ability to borrow bandwidth from its parent. If the parent rate class is not specified in the definition of a rate class, the Rate Class is not a child, but may be a parent if another Rate Class refers to it as such. | BIG-IP_v9.0 |
| get_percent_of_parent_base_rate | Gets the base rate, if specified as a percentage of the parent rate filter class&apos base rate. This is zero if the base rate is specified as bandwidth (see set/get_base_rate). | BIG-IP_v10.1.0 |
| get_percent_of_parent_ceiling_rate | Gets the ceiling rate, if specified as a percentage of the parent&aposs ceiling rate. This is zero if the ceiling rate is specified as a throughput (see set/get_ceiling_rate). | BIG-IP_v10.1.0 |
| get_queue_type | Gets the queue types being used by the specified rate classes. See also the get_queueing_method method. | BIG-IP_v9.0 |
| get_queueing_method | Gets the queueing method, specifying how packets are queued for rate filtering, effectively determining the class of traffic which is dropped if necessary. | BIG-IP_v10.1.0 |
| get_queueing_method_bucket_count | Gets the number of the buckets used to divide the traffic for each queue. This is only valid for the stochastic fair queueing type. | BIG-IP_v10.1.0 |
| get_queueing_method_bucket_size | Gets the size of the buckets used to divide the traffic for each queue. This is only valid for the stochastic fair queueing type. | BIG-IP_v10.1.0 |
| get_queueing_method_description | Gets the descriptions for a set of queueing methods. | BIG-IP_v11.0.0 |
| get_queueing_method_list | Gets a list of all queueing methods | BIG-IP_v10.1.0 |
| get_queueing_method_maximum_queue_size | Gets the maximum queue size. This is only valid for the Priority FIFO queueing type. | BIG-IP_v10.1.0 |
| get_queueing_method_minimum_queue_size | Gets the minimum queue size. This is only valid for the Priority FIFO queueing type. | BIG-IP_v10.1.0 |
| get_queueing_method_perturbation_interval | Gets the perburation interval, the interval at which the system reconfigures the bucket hash function. This is only valid for the stochastic fair queueing type. | BIG-IP_v10.1.0 |
| get_queueing_method_type | Gets the queueing method types, i.e., the method use to store and remove traffic from the queues managed by a rate filter. | BIG-IP_v10.1.0 |
| get_shaping_policy | Gets the name of shaping policy, used to specify custom drop policies and queueing methods. | BIG-IP_v10.1.0 |
| get_shaping_policy_burst_size | Gets the burst size for a shaping policy, the maximum number of bytes that traffic is allowed to burst beyond the base rate. | BIG-IP_v10.1.0 |
| get_shaping_policy_description | Gets the descriptions for a set of shaping policies. | BIG-IP_v11.0.0 |
| get_shaping_policy_drop_policy | Gets the name of the drop policy for a shaping policy, specifying how a rate filter drops packets when the rate filter is throttling traffic. | BIG-IP_v10.1.0 |
| get_shaping_policy_list | Gets a list of all shaping policies | BIG-IP_v10.1.0 |
| get_shaping_policy_percent_of_parent_base_rate | Gets the base rate for a shaping policy, if specified as a percentage of the parent rate filter class&apos base rate. | BIG-IP_v10.1.0 |
| get_shaping_policy_percent_of_parent_ceiling_rate | Gets the ceiling rate for a shaping policy, if specified as a percentage of the parent rate filter class&apos ceiling rate. | BIG-IP_v10.1.0 |
| get_shaping_policy_queueing_method | Gets the queueing method for a shaping policy, specifying how packets are queued for rate filtering, effectively determining the class of traffic which is dropped if necessary. | BIG-IP_v10.1.0 |
| get_statistics | Gets the statistics for the specified rate classes. | BIG-IP_v9.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v9.0 |
| reset_statistics | Resets the statistics for the specified rate classes. | BIG-IP_v9.0 |
| set_base_rate | Sets the base rates for the specified rate classes. The base rate specifies the maximum throughput to allot to traffic handled by the Rate Class. Packets in excess of the posted rate will be dropped. Note that this method is deprecated. Please use set_base_rate_v2. | BIG-IP_v9.0 |
| set_base_rate_v2 | Sets the base rates for the specified rate classes. The base rate specifies the maximum throughput to allot to traffic handled by the Rate Class. Packets in excess of the posted rate will be dropped. | BIG-IP_v12.1.0 |
| set_burst_size | Sets the burst sizes for the specified rate classes. The burst size specifies maximum number of bytes that traffic is allowed to burst beyond the base rate. | BIG-IP_v9.0 |
| set_ceiling_rate | Sets the ceiling rates for the specified rate classes. The ceiling rate specifies how far beyond the base rate the traffic is allowed to flow when bursting. The ceiling rate is an absolute limit - it is impossible for traffic to flow at a higher rate than the ceiling rate, even when bursting. If the ceiling rate is omitted or is equal to the base rate, the traffic may not exceed the base rate. It is illegal for the ceiling rate to be less than the base rate. Note that this method is deprecated. Please use set_ceiling_rate_v2. | BIG-IP_v9.0 |
| set_ceiling_rate_v2 | Sets the ceiling rates for the specified rate classes. The ceiling rate specifies how far beyond the base rate the traffic is allowed to flow when bursting. The ceiling rate is an absolute limit - it is impossible for traffic to flow at a higher rate than the ceiling rate, even when bursting. If the ceiling rate is omitted or is equal to the base rate, the traffic may not exceed the base rate. It is illegal for the ceiling rate to be less than the base rate. | BIG-IP_v12.1.0 |
| set_description | Sets the description for a set of rate filter classes. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_direction | Sets the direction types to be used by the specified rate classes. For the DIRECTION_VLAN type, it is best to use set_direction_vlan. | BIG-IP_v9.0 |
| set_direction_vlan | Sets the direction type to apply rate filtering to traffic leaving via a specified VLAN. | BIG-IP_v10.1.0 |
| set_drop_policy | A drop policy controls which packets are dropped when a rate filter needs to throttle traffic. A rate filter collects traffic in a number of queues, classified according to the rate filter&aposs queueing method (see set_queueing_method). The drop policy determines how traffic is dropped from each queue with each queue&aposs being treated the same. This method sets the name of the drop policy. Three pre-defined drop policies exist. “fred” drops packets according to the type of traffic. “red” drops packets randomly. “tail” drops packets from the end of the queues. | BIG-IP_v10.1.0 |
| set_drop_policy_average_packet_size | Sets the average packet (maximum transmission unit (MTU)) size. This is only valid for the “fred” and “red” types. | BIG-IP_v10.1.0 |
| set_drop_policy_description | Sets the description for a set of drop policies. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_drop_policy_drop_limit_factor | Sets the drop limit factor. A larger value increases the hard drop limit. This is only valid for the “fred” type. | BIG-IP_v10.1.0 |
| set_drop_policy_maximum_active_connections | Sets the maximum number of active connections for each queue. This is only valid for the “fred” type. | BIG-IP_v10.1.0 |
| set_drop_policy_maximum_probability | Sets the maximum probability for dropping packets when the average queue length is between the minimum and maximum thresholds. This is only used for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| set_drop_policy_maximum_queue_size | Sets the maximum queue size. If a queue exceeds that size, any additional packets are dropped if the rate filter is throttling traffic. This is only valid for the “red” type. | BIG-IP_v10.1.0 |
| set_drop_policy_maximum_queue_threshold | Sets the queue length threshold above which packets are dropped when the rate filter is throttling traffic. This is only used for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| set_drop_policy_minimum_queue_threshold | Sets the queue length threshold below which packets are not dropped when the rate filter is throttling traffic. This is only used for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| set_drop_policy_no_drop_limit_factor | Sets the no-drop limit factor. A larger value prevents packets from being dropped. This is only valid for the “fred” type. | BIG-IP_v10.1.0 |
| set_drop_policy_type | Sets the drop policy type, i.e., the general strategy for a rate filter&aposs dropping packets when throttling traffic. See the DropPolicyType enumeration for details. | BIG-IP_v10.1.0 |
| set_drop_policy_weight | Sets the weight used to calculate the average lengths of the rate filter&aposs queues. This is only used for the “red” and “fred” types. | BIG-IP_v10.1.0 |
| set_parent | Sets the name of the parent rate class. Any child Rate Class has the ability to borrow bandwidth from its parent. If the parent rate class is not specified in the definition of a rate class, the Rate Class is not a child, but may be a parent if another Rate Class refers to it as such. | BIG-IP_v9.0 |
| set_percent_of_parent_base_rate | Sets base rate by specifying a percentage of the parent&aposs base rate. The base rate is the maximum throughput for traffic handled by the rate filter. | BIG-IP_v10.1.0 |
| set_percent_of_parent_ceiling_rate | Sets the ceiling rate by specifying a percentage of the parent&aposs ceiling rate. The ceiling rate specifies the absolute throughput limit for traffic handled by the rate filter. | BIG-IP_v10.1.0 |
| set_queue_type | Sets the queue types to be used by the specified rate classes. See also the set_queueing_method method. | BIG-IP_v9.0 |
| set_queueing_method | Sets the queueing method, specifying how packets are queued for rate filtering, effectively determining the class of traffic which is dropped, if necessary. Two pre-defined methods exist. “sfq” queues traffic according to the connection information, i.e., being fair to individual connections. “pfifo” queues traffic according to the Type of Service (ToS) packet field. This method is a more expansive version of the set_queue_type method, whose two enumerated types map exactly to the pre-defined “pfifo” and “sfq” objects. | BIG-IP_v10.1.0 |
| set_queueing_method_bucket_count | Sets the number of the buckets used to divide the traffic for each queue. This is only used by the stochastic fair queueing type. | BIG-IP_v10.1.0 |
| set_queueing_method_bucket_size | Sets the size of the buckets used to divide the traffic for each queue. This is only used by the stochastic fair queueing type. | BIG-IP_v10.1.0 |
| set_queueing_method_description | Sets the description for a set of queueing methods. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_queueing_method_maximum_queue_size | Sets the maximum queue size. This is only used by the Priority FIFO queueing type. | BIG-IP_v10.1.0 |
| set_queueing_method_minimum_queue_size | Sets the minimum queue size. This is only used by the Priority FIFO queueing type. | BIG-IP_v10.1.0 |
| set_queueing_method_perturbation_interval | Sets the perturbation interval, i.e. the interval at which the rate filter reconfigures the bucket hash function. This is only used by the stochastic fair queueing type. | BIG-IP_v10.1.0 |
| set_queueing_method_type | Sets the queueing method type, i.e., the method use to store and remove traffic from the queues managed by a rate filter. See the QueueType enumeration for more details. | BIG-IP_v10.1.0 |
| set_shaping_policy | Sets the shaping policy, used to specify custom drop policies and queueing methods. A shaping policy encapsulates a set of rate filter class configuration attributes into a single object. Once created, this object can be used to create rate filter classes more easily, by specifying a shaping policy rather than all of its attributes individually. Note that this is purely a convenience interface. There is nothing in a shaping policy which cannot also be done via a rate filter class object. | BIG-IP_v10.1.0 |
| set_shaping_policy_burst_size | Sets the burst size in a shaping policy, the maximum number of bytes that traffic is allowed to burst beyond the base rate. | BIG-IP_v10.1.0 |
| set_shaping_policy_description | Sets the description for a set of shaping policies. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.0.0 |
| set_shaping_policy_drop_policy | Sets the name of the drop policy in a shaping policy, specifying how the rate filter drops packets when throttling traffic. Three pre-defined drop policies exist. “fred” drops packets according to the type of traffic. “red” drops packets randomly. “tail” drops packets from the end of the queues. See the drop policy methods for more information. | BIG-IP_v10.1.0 |
| set_shaping_policy_percent_of_parent_base_rate | Sets base rate in a shaping policy by specifying a percentage of the parent&aposs rate filter class&apos base rate. The base rate is the maximum throughput for traffic handled by the rate filter. | BIG-IP_v10.1.0 |
| set_shaping_policy_percent_of_parent_ceiling_rate | Sets the ceiling rate for a shaping policy by specifying a percentage of the parent&aposs rate filter class&apos ceiling rate. The ceiling rate specifies the absolute throughput limit for traffic handled by the rate filter. | BIG-IP_v10.1.0 |
| set_shaping_policy_queueing_method | Sets the queueing method for a shaping policy, specifying how packets are queued for rate filtering, effectively determining the class of traffic which is dropped if necessary. Two pre-defined methods exist. “sfq” queues traffic according to the connection information, i.e., fair to individual connections. “pfifo” queues traffic according to the Type of Service (ToS) packet field. See the queueing method methods for more details. | BIG-IP_v10.1.0 |
Structures¶
Structure
Description
A struct that describes statistics for a particular rate class.
A struct that describes rate class statistics and timestamp.
A struct that describes rate and the unit being used.
A struct that describes rate and the unit being used.
Enumerations¶
| Enumeration | Description |
| DirectionType | A list of different directions to indicate how rate shaping should be applied to. |
| DropPolicyType | A list of drop policy types |
| QueueType | Queueing method types |
| UnitType | A list of unit types. |
Aliases¶
| Alias | Type | Description |
| DirectionTypeSequence | DirectionType [] | A sequence of direction types. |
| DropPolicyTypeSequence | DropPolicyType [] | A sequence of drop policy types |
| QueueTypeSequence | QueueType [] | A sequence of queueing method types. |
| RateClassStatisticEntrySequence | RateClassStatisticEntry [] | A sequence of rate class statistics. |
| RateUnitSequence | RateUnit [] | A sequence of rates and their units. |
| RateUnitV2Sequence | RateUnitV2 [] | A sequence of rates and their units. |
| UnitTypeSequence | UnitType [] | A sequence of unit types. |
See Also¶
Warning
The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.
Sample Code¶
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.