APIRef_tm_net_rate-shaping_shaping-policy¶
mgmt/tm/net/rate-shaping/shaping-policy
Shaping policy configuration
REST Endpoints
- Collection URI
/mgmt/tm/net/rate-shaping/shaping-policy- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/net/rate-shaping/shaping-policy/~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. | |
ceilingPercentage |
uint64 | 0 | optional | read/write | Specifies the percentage of the ceiling rate specified for the parent in the rate class command that is available for this traffic flow. |
description |
string | optional | read/write | User defined description. | |
dropPolicy |
string | optional | read/write | Specifies the drop policy for this traffic flow. The available pre-configured settings are tail (drops the end of the traffic stream), red (randomly drops packets), and fred (drops packets according to the type of traffic in the flow). The default value is none. You can create a customized drop policy using the drop-policy command. | |
maxBurst |
integer | 0 | optional | read/write | Specifies the maximum number of bytes that traffic is allowed to burst beyond the base rate. |
queue |
string | optional | read/write | Specifies the queue discipline for this traffic flow. The available pre-configured settings are pfifo (Priority First in, First out), sfq (Stochastic Fair Queuing), and none. The default value is none. You can create a customized queue discipline using the queue command. | |
ratePercentage |
uint64 | 0 | optional | read/write | Specifies the percentage of the maximum throughput rate specified for the parent in the rate class command that is available for this traffic flow. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
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.