Networking::BWControllerPolicy¶
Introduced : BIG-IP_v11.3.0
This interface configures the Bandwidth Controller policy components
to manage the egress bandwidth per policy, per session or subscriber,
per application and various combinations of these.
Methods¶
| Method | Description | Introduced |
| add_category_maximum_percentage | Creates a set of Bandwidth Controller policy categories with the specified maximum rate percentages. Categories is a sub-policy of dynamically created instances from a dynamic enabled policies. Maximum rate percentage is the maximum percentage of maximum user rate of dynamically enabled policy. | BIG-IP_v11.3.0 |
| add_category_maximum_rate | Creates a set of Bandwidth Controller policy categories with the specified maximum rates. Categories is a sub-policy of dynamically created instances from a dynamic enabled policies. Maximum rates cannot exceed the maximum user rate of the parent Bandwidth Controller policy. | BIG-IP_v11.3.0 |
| create | Creates a set of Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| delete_all_policies | Deletes all Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| delete_policy | Deletes a set of Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_category | Gets the names of all Bandwidth Controller policy categories. Categories is a sub-policy of dynamically created instances from a dynamic enabled policy. | BIG-IP_v11.3.0 |
| get_category_ip_tos | Gets the IP-TOS value for specified Bandwidth Controller category. | BIG-IP_v11.6.0 |
| get_category_link_qos | Gets the Link-QOS for the specified Bandwidth Controller categories. | BIG-IP_v11.6.0 |
| get_category_maximum_percentage | Gets the maximum percentages of Bandwidth Controller policy categories. | BIG-IP_v11.3.0 |
| get_category_maximum_rate | Gets the maximum rates of the Bandwidth Controller policy categories. | BIG-IP_v11.3.0 |
| get_description | Gets the descriptions for the specified Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_dynamic_state | Gets the dynamic states of the specified Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_ip_tos | Gets the IP-TOS value for the specified Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_link_qos | Gets the Link-QOS for the specified Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_list | Gets the names of all Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_log_period | Gets the previously configured log period setting of the Bandwidth Controller policies. | BIG-IP_v11.6.0 |
| get_log_publisher | Returns previously configured log publisher setting for the measurement feature. | BIG-IP_v11.6.0 |
| get_maximum_rate | Gets the maximum rate for the specified Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_maximum_user_rate | Gets the maximum user rate for the specified Bandwidth Controller policies. | BIG-IP_v11.3.0 |
| get_maximum_user_rate_pps | Gets the maximum user rate in packets per second (PPS) for the specified Bandwidth Controller policies. | BIG-IP_v12.0.0 |
| get_measurement_state | Gets the currently configured enabled/disabled setting for the bandwidth measurement feature for the specified Bandwidth Controller policies. For more information about log publishers see Log::Publisher. | BIG-IP_v11.6.0 |
| get_version | Gets the version information for this interface. | BIG-IP_v11.3.0 |
| remove_all_categories | Remove all categories of the specified Bandwidth Controller policy. | BIG-IP_v11.3.0 |
| remove_category | Remove categories of the specified Bandwidth Controller policy. | BIG-IP_v11.3.0 |
| set_category_ip_tos | Sets the IP-TOS value for the specified Bandwidth Controller Category. If set then all non-conforming Layer 3 packets are set with this value. A non-conforming packet is one which exceeds the rate limit of the configured Bandwidth category. A value of 255 means it&aposs a pass through and all the Layer 3 packets are passed as seen by the Bandwidth Controller. | BIG-IP_v11.6.0 |
| set_category_link_qos | Sets the Link-QOS for the specified Bandwidth Controller categories. All non-conforming Layer 2 packets are set with this value. A non-conforming packet is one which exceeds the rate limit of the configured Bandwidth category. A value of 255 means it&aposs a pass through and all the Layer 2 packets are passed as seen by the Bandwidth Controller. | BIG-IP_v11.6.0 |
| set_category_maximum_percentage | Sets a set of Bandwidth Controller policy categories with specified rate percentages. Rate percentages is maximum percentage of the maximum user rate allowed for all the flows going through this Bandwidth Controller policy category. | BIG-IP_v11.3.0 |
| set_category_maximum_rate | Sets the Bandwidth Controller policy categories with the specified specified maximum rates. Maximum rate is the maximum bandwidth allowed for all the flows going through this policy category. Maximum rates cannot exceed the maximum user rate of the parent Bandwidth Controller policy. | BIG-IP_v11.3.0 |
| set_description | Sets the descriptions for the specified Bandwidth Controller policies. This is an arbitrary field which can be used for any purpose. | BIG-IP_v11.3.0 |
| set_ip_tos | Sets the IP-TOS value for the specified Bandwidth Controller policies. If set then all non-conforming Layer 3 packets are set with this value. A non-conforming packet is one which exceeds the rate limit of the configured Bandwidth policy. A value of 255 means it&aposs a pass through and all the Layer 3 packets are passed as seen by the Bandwidth Controller. | BIG-IP_v11.3.0 |
| set_link_qos | Sets the Link-QOS for the specified Bandwidth Controller policies. All non-conforming Layer 2 packets are set with this value. A non-conforming packet is one which exceeds the rate limit of the configured Bandwidth policy. A value of 255 means it&aposs a pass through and all the Layer 2 packets are passed as seen by the Bandwidth Controller. | BIG-IP_v11.3.0 |
| set_log_period | Specify the time interval with which bandwidth measurement log messages are sent to log server. Specified in milliseconds. | BIG-IP_v11.6.0 |
| set_log_publisher | Specify a destination log publisher for the bandwidth measurement logs to be sent. | BIG-IP_v11.6.0 |
| set_maximum_rate | Sets the maximum rate for the specified Bandwidth Controller policies. Maximum rates is maximum bandwidth allowed for all the flows going going through this policy. Maximum rates value should be between 1000000bps and 320000000000 bps. | BIG-IP_v11.3.0 |
| set_maximum_user_rate | Sets the maximum user rate for the specified Bandwidth Controller policies. Maximum user rates is maximum bandwidth allowed for all the flows going through this dynamically created instance of the Bandwidth Controller policy. Maximum user rate value should be between 5000 bps and 2000000000 bps. Maximum user rate cannot be higher than maximum rate specified for that Bandwidth Controller policy. | BIG-IP_v11.3.0 |
| set_maximum_user_rate_pps | Sets the maximum user rate in packets per second (PPS) for the specified Bandwidth Controller policies. The maximum user rate is the maximum bandwidth allowed for all the flows going through this dynamically created instance of the Bandwidth Controller policy. The maximum user rate cannot be higher than the maximum rate specified for that Bandwidth Controller policy. | BIG-IP_v12.0.0 |
| set_measurement_state | Enables/disables the measurement of bandwidth for Bandwidth Controller policies. | BIG-IP_v11.6.0 |
See Also¶
iControl ::
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.