Bandwidth_Control_Policy (object)¶
Create a listener to specify how to handle traffic for policy enforcement
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
categories | This specifies the categories under policy. Note: policy need to be enabled as dynamic to configure categories. Up to a maximum of 32 categories can be configured. All the categories under the dynamic policy share the bandwidth as specified for the category, up to a maximum of maxUserBandwidth. | |||
class* | string | “Bandwidth_Control_Policy” | ||
dynamicControlEnabled | boolean | false | true, false | Specifies whether the policy is a static or dynamic policy. When enabled, the policy is dynamic, and additional settings are available. A dynamic policy enforces the specified maximum user rate and flow fairness for all traffic associated with the policy and for each session. The default is disabled, which indicates a static policy. A static policy enforces the maximum rate for combined traffic and does not guarantee fairness bandwidth for each session. |
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
loggingEnabled | boolean | false | true, false | Specifies whether the system measures bandwidth on all future instances of this bandwidth control policy. When enabled, the system measures bandwidth and sends it to the log publisher specified by the logPublisher setting. You can override this setting using iRules. For example, if you want measurement on only some instances, keep this setting disabled, and use iRules to enable measurement on specific instances. |
logPeriod | integer | 2048 | 0 - 18446744073709552000 | Specifies the frequency, in milliseconds, with which the system generates bandwidth measurement logs |
logPublisher | object | Reference to a log publisher,Reference for a BIG-IP or Use object | ||
markIP | “pass-through” | Specifies whether to mark traffic that exceeds the per-user limit by setting a Type of Service (ToS) bit in the IP headers of TCP packets associated with this bandwidth control policy. The default value is “pass-through”, which means there is no change to the ToS bit. To set a ToS bit use a value from 0 to 63. If this setting is specified, the bandwidth policy is not enforced, but rather the packets are marked for a downstream system to process. | ||
markL2 | “pass-through” | Specifies whether to mark traffic that exceeds the per-user limit by setting a Quality of Service (QoS) bit in the L2 headers of packets associated with this bandwidth control policy. The default value is “pass-through”, which means there is no change to the QoS bit. To set a QoS bit use a value from 0 to 7. If this setting is specified, the bandwidth policy is not enforced, but rather the packets are marked for a downstream system to process. | ||
maxBandwidth* | integer | 0 - 18446744073709552000 | Specifies the maximum amount of bandwidth that traffic associated with the bandwidth control policy can use. The range is from 1 Mbps to 320 Gbps (between 1000000 bps and 320000000000 bps. | |
maxBandwidthUnit | string | “Mbps” | “bps”, “Kbps”, “Mbps”, “Gbps” | Specifies the units used by the maxBandwidth property |
maxUserBandwidth | integer | 0 | 0 - 18446744073709552000 | Specifies the maximum amount of bandwidth that each session associated with the bandwidth control policy can use. The range is from 5 Kbps to 2 Gbps. Note: For FTP traffic, the throughput is roughly half of this setting, because the FTP protocol creates two connections per user: a control connection and a data connection. |
maxUserBandwidthUnit | string | “Mbps” | “bps”, “Kbps”, “Mbps”, “Gbps” | Specifies the units used by the maxUserBandwidth property |
maxUserPPS | integer | 0 | 0 - 18446744073709552000 | Specifies the limiter in packets per second that traffic is allowed per instance. It functions as a DoS limiter without fair share allocation. The system applies whichever value is lower, between this value and the specified Maximum Rate Per User. When both values are specified, both must pass for packets to go through. You can specify the rate in packets per second (PPS), kilo packets per second (KPPS), mega packets per second (MPPS), or giga packets per second (GPPS). The default value is 0 (not configured). |
maxUserPPSUnit | string | “Mpps” | “bpps”, “Kpps”, “Mpps”, “Gpps” | Specifies the units used by the maxUserBandwidthPPS property |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks |
Bandwidth_Control_Policy.logPublisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Bandwidth_Control_Policy_Category (object)¶
Create a listener to specify how to handle traffic for policy enforcement
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
markIP | “pass-through” | Specifies whether to mark traffic that exceeds the per-user limit by setting a Type of Service (ToS) bit in the IP headers of TCP packets associated with this bandwidth control policy. The default value is “pass-through”, which means there is no change to the ToS bit. To set a ToS bit use a value from 0 to 63. If this setting is specified, the bandwidth policy is not enforced, but rather the packets are marked for a downstream system to process. | ||
markL2 | “pass-through” | Specifies whether to mark traffic that exceeds the per-user limit by setting a Quality of Service (QoS) bit in the L2 headers of packets associated with this bandwidth control policy. The default value is “pass-through”, which means there is no change to the QoS bit. To set a QoS bit use a value from 0 to 7. If this setting is specified, the bandwidth policy is not enforced, but rather the packets are marked for a downstream system to process. | ||
maxBandwidth* | integer | 0 - 18446744073709552000 | Specifies the maximum bandwidth that this category of traffic can use when associated with this bandwidth control policy. The range is from 5 kbps to the value set for Maximum Rate Per User. | |
maxBandwidthUnit | string | “Mbps” | “bps”, “Kbps”, “Mbps”, “Gbps”, “%” | Specifies the units used by the maxBandwidth property |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks |