Skip to content

Commit 5330b56

Browse files
jaredhendrickson13jaredhendrickson13
committed
Minor adjustments to APIFirewallTrafficShaperQueueCreate model and added documentation for the /api/v1/firewall/traffic_shaper/queue endpoint
1 parent bd6c4f4 commit 5330b56

2 files changed

Lines changed: 232 additions & 4 deletions

File tree

‎docs/documentation.json‎

Lines changed: 228 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3965,6 +3965,234 @@
39653965
{
39663966
"name": "TRAFFIC_SHAPER",
39673967
"item": [
3968+
{
3969+
"name": "QUEUE",
3970+
"item": [
3971+
{
3972+
"name": "Create Traffic Shaper Queue",
3973+
"request": {
3974+
"method": "POST",
3975+
"header": [],
3976+
"body": {
3977+
"mode": "raw",
3978+
"raw": "{\n \"interface\": \"lan\",\n \"scheduler\": \"PRIQ\",\n \"bandwidthtype\": \"Gb\",\n \"bandwidth\": 1,\n \"enabled\": false,\n \"qlimit\": 1000,\n \"tbrconfig\": 1000,\n \"apply\": true\n}",
3979+
"options": {
3980+
"raw": {
3981+
"language": "json"
3982+
}
3983+
}
3984+
},
3985+
"url": {
3986+
"raw": "https://{{$hostname}}/api/v1/firewall/traffic_shaper?interface=string&name=string&priority=integer&description=string&enabled=boolean&default=boolean&red=boolean&rio=boolean&ecn=boolean&codel=boolean&qlimit=integer&bandwidthtype=string&bandwidth=integer&buckets=string&hogs=string&borrow=boolean&upperlimit=boolean&upperlimit1=string&upperlimit2=integer&upperlimit3=string&linkshare=boolean&linkshare1=string&linkshare2=integer&linkshare3=string&realtime=boolean&realtime1=string&realtime2=integer&realtime3=string&apply=integer",
3987+
"protocol": "https",
3988+
"host": [
3989+
"{{$hostname}}"
3990+
],
3991+
"path": [
3992+
"api",
3993+
"v1",
3994+
"firewall",
3995+
"traffic_shaper"
3996+
],
3997+
"query": [
3998+
{
3999+
"key": "interface",
4000+
"value": "string",
4001+
"description": "Specify the parent interface to create the traffic shaper queue for. You may specify either the interface's descriptive name, the pfSense ID (wan, lan, optx), or the physical interface id (e.g. igb0). "
4002+
},
4003+
{
4004+
"key": "name",
4005+
"value": "string",
4006+
"description": "Specify a name for this queue. This name must be 15 characters or less, and unique from all other queues on the parent interface."
4007+
},
4008+
{
4009+
"key": "priority",
4010+
"value": "integer",
4011+
"description": "Specify the priority of this queue. This field Is only available when the parent traffic shaper's `scheduler` Is set to "
4012+
},
4013+
{
4014+
"key": "description",
4015+
"value": "string",
4016+
"description": "Specify a description for this queue. (optional)"
4017+
},
4018+
{
4019+
"key": "enabled",
4020+
"value": "boolean",
4021+
"description": "Enable or disable this traffic queue upon creation. Specify `true` to enable or `false` to disable. Defaults to `true`. (optional)"
4022+
},
4023+
{
4024+
"key": "default",
4025+
"value": "boolean",
4026+
"description": "Specify whether or not this queue should be set as the default queue for the parent. Set to `true` to enable. Defaults to `false`. (optional)"
4027+
},
4028+
{
4029+
"key": "red",
4030+
"value": "boolean",
4031+
"description": "Set the Random Early Detection option for this queue. Set `true` to enable. Defaults to `false`. (optional)"
4032+
},
4033+
{
4034+
"key": "rio",
4035+
"value": "boolean",
4036+
"description": "Set the Random Early Detection In and Out option for this queue. Set `true` to enable. Defaults to `false`. (optional)"
4037+
},
4038+
{
4039+
"key": "ecn",
4040+
"value": "boolean",
4041+
"description": "Set the Explicit Congestion Notification option for this queue. Set `true` to enable. Defaults to `false`. (optional) "
4042+
},
4043+
{
4044+
"key": "codel",
4045+
"value": "boolean",
4046+
"description": "Set the Codel Active Queue option for this queue. Set `true` to enable. Defaults to `false`. (optional)"
4047+
},
4048+
{
4049+
"key": "qlimit",
4050+
"value": "integer",
4051+
"description": "Specify the queue limit value for this queue. If set, this must be a value of `1` or greater. Defaults to no limit. (optional)"
4052+
},
4053+
{
4054+
"key": "bandwidthtype",
4055+
"value": "string",
4056+
"description": "Specify the bandwidth type to use when setting the bandwidth. Choices are `%` for percentage based bandwidth, `b` for bits, `Kb` for kilobits, `Mb` for megabits, and `Gb` for gigabits. Only available when the parent traffic shaper's `scheduler` Is set to `HFSC`, `CBQ`, or `FAIRQ`. (optional)"
4057+
},
4058+
{
4059+
"key": "bandwidth",
4060+
"value": "integer",
4061+
"description": "Specify the bandwidth of this traffic shaper. This must be a numeric value of `1` or greater. If you have set the `bandwidthtype` to `%`, this value must be `100` or less. Only available when the parent traffic shaper's `scheduler` Is set to `HFSC`, `CBQ`, or `FAIRQ`. The sum of this value and all other child queues must be less than the parent traffic shaper's `bandwidth` value. (optional)"
4062+
},
4063+
{
4064+
"key": "buckets",
4065+
"value": "string",
4066+
"description": "Set the bandwidth buckets value for this queue. Only available when the parent traffic shaper's `scheduler` Is set to `FAIRQ`. (optional) "
4067+
},
4068+
{
4069+
"key": "hogs",
4070+
"value": "string",
4071+
"description": "Set the bandwidth hogs value for this queue. Only available when the parent traffic shaper's `scheduler` Is set to `FAIRQ`. (optional)"
4072+
},
4073+
{
4074+
"key": "borrow",
4075+
"value": "boolean",
4076+
"description": "Allow queue to borrow bandwidth from other queues when available. Only available when the parent traffic shaper's `scheduler` Is set to `CBQ`. (optional)"
4077+
},
4078+
{
4079+
"key": "upperlimit",
4080+
"value": "boolean",
4081+
"description": "Enable the upperlimit (max bandwidth) option for this queue. Set `true` to enable. Defaults to `false`. Only available when parent traffic shaper's `scheduler` is set to `HFSC`. (optional)"
4082+
},
4083+
{
4084+
"key": "upperlimit1",
4085+
"value": "string",
4086+
"description": "Set the first upper limit value (m1). This value must be a bandwidth formatted string (e.g. `100Mb`, `1Gb`, etc.). Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `upperlimit` value is enabled. (optional)"
4087+
},
4088+
{
4089+
"key": "upperlimit2",
4090+
"value": "integer",
4091+
"description": "Set the second upper limit value (d). This value must an integer of 1 or greater. This value will required If an `upperlimit1` value was specified. Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `upperlimit` value is enabled. (optional)"
4092+
},
4093+
{
4094+
"key": "upperlimit3",
4095+
"value": "string",
4096+
"description": "Set the third upper limit value (m2). This value must be a bandwidth formatted string (e.g. `100Mb`, `1Gb`, etc.). Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `upperlimit` value is enabled. This value Is required if the`upperlimit` value is enabled."
4097+
},
4098+
{
4099+
"key": "linkshare",
4100+
"value": "boolean",
4101+
"description": "Enable the linkshare (shared bandwidth) option for this queue. Set `true` to enable. Defaults to `false`. Only available when parent traffic shaper's `scheduler` is set to `HFSC`. (optional)"
4102+
},
4103+
{
4104+
"key": "linkshare1",
4105+
"value": "string",
4106+
"description": "Set the first linkshare value (m1). This value must be a bandwidth formatted string (e.g. `100Mb`, `1Gb`, etc.). Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `linkshare` value is enabled. (optional)"
4107+
},
4108+
{
4109+
"key": "linkshare2",
4110+
"value": "integer",
4111+
"description": "Set the second linkshare value (d). This value must an integer of 1 or greater. This value will required If an `linkshare1` value was specified. Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `linkshare` value is enabled. (optional)"
4112+
},
4113+
{
4114+
"key": "linkshare3",
4115+
"value": "string",
4116+
"description": "Set the third linkshare value (m2). This value must be a bandwidth formatted string (e.g. `100Mb`, `1Gb`, etc.). Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `linkshare` value is enabled. This value Is required if the`linkshare` value is enabled."
4117+
},
4118+
{
4119+
"key": "realtime",
4120+
"value": "boolean",
4121+
"description": "Enable the realtime (minimum bandwidth) option for this queue. Set `true` to enable. Defaults to `false`. Only available when parent traffic shaper's `scheduler` is set to `HFSC`. (optional)"
4122+
},
4123+
{
4124+
"key": "realtime1",
4125+
"value": "string",
4126+
"description": "Set the first realtime value (m1). This value must be a bandwidth formatted string (e.g. `100Mb`, `1Gb`, etc.). Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `realtime` value is enabled. (optional)"
4127+
},
4128+
{
4129+
"key": "realtime2",
4130+
"value": "integer",
4131+
"description": "Set the second realtime value (d). This value must an integer of 1 or greater. This value will required If an `realtime1` value was specified. Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `realtime` value is enabled. (optional)"
4132+
},
4133+
{
4134+
"key": "realtime3",
4135+
"value": "string",
4136+
"description": "Set the third realtime value (m2). This value must be a bandwidth formatted string (e.g. `100Mb`, `1Gb`, etc.). Only available when the parent traffic shaper's `scheduler` is set to `HFSC` and the `realtime` value is enabled. This value Is required if the`linkshare` value is enabled."
4137+
},
4138+
{
4139+
"key": "apply",
4140+
"value": "integer",
4141+
"description": "Specify whether this traffic shaper should be applied immediately after creation. If `true`, the filter will be reloaded after creation. Otherwise, if `false`, the filter will not be reloaded and the change will not be applied until the next filter reload. Defaults to `false`. (optional)"
4142+
}
4143+
]
4144+
},
4145+
"description": "Add a queue to an traffic shaper interface.<br><br>\n\n_Requires at least one of the following privileges:_ [`page-all`, `page-firewall-trafficshaper-queues`]"
4146+
},
4147+
"response": []
4148+
},
4149+
{
4150+
"name": "Delete Traffic Shaper Queue",
4151+
"request": {
4152+
"method": "DELETE",
4153+
"header": [],
4154+
"body": {
4155+
"mode": "raw",
4156+
"raw": "{\n \"interface\": \"lan\",\n \"scheduler\": \"PRIQ\",\n \"bandwidthtype\": \"Gb\",\n \"bandwidth\": 1,\n \"enabled\": false,\n \"qlimit\": 1000,\n \"tbrconfig\": 1000,\n \"apply\": true\n}",
4157+
"options": {
4158+
"raw": {
4159+
"language": "json"
4160+
}
4161+
}
4162+
},
4163+
"url": {
4164+
"raw": "https://{{$hostname}}/api/v1/firewall/traffic_shaper?interface=string&name=string",
4165+
"protocol": "https",
4166+
"host": [
4167+
"{{$hostname}}"
4168+
],
4169+
"path": [
4170+
"api",
4171+
"v1",
4172+
"firewall",
4173+
"traffic_shaper"
4174+
],
4175+
"query": [
4176+
{
4177+
"key": "interface",
4178+
"value": "string",
4179+
"description": "Specify the parent interface to delete the traffic shaper queue from. You may specify either the interface's descriptive name, the pfSense ID (wan, lan, optx), or the physical interface id (e.g. igb0). "
4180+
},
4181+
{
4182+
"key": "name",
4183+
"value": "string",
4184+
"description": "Specify a name of the queue to delete. This must be an existing queue name configured on the parent traffic shaper."
4185+
}
4186+
]
4187+
},
4188+
"description": "Delete a queue from a traffic shaper interface.<br><br>\n\n_Requires at least one of the following privileges:_ [`page-all`, `page-firewall-trafficshaper-queues`]"
4189+
},
4190+
"response": []
4191+
}
4192+
],
4193+
"protocolProfileBehavior": {},
4194+
"_postman_isSubFolder": true
4195+
},
39684196
{
39694197
"name": "Create Traffic Shaper",
39704198
"request": {

‎pfSense-pkg-API/files/etc/inc/api/models/APIFirewallTrafficShaperQueueCreate.inc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -230,8 +230,8 @@ class APIFirewallTrafficShaperQueueCreate extends APIModel {
230230
}
231231

232232
private function __validate_bandwidth() {
233-
# Only validate this field if the parent shaper's scheduler is set to FAIRQ or CBQ
234-
if (in_array($this->parent["scheduler"], ["FAIRQ", "CBQ"])) {
233+
# Only validate this field if the parent shaper's scheduler is set to HFSC FAIRQ or CBQ
234+
if (in_array($this->parent["scheduler"], ["FAIRQ", "CBQ", "HFSC"])) {
235235
# Check for our optional `bandwidth` payload value
236236
if (isset($this->initial_data["bandwidth"])) {
237237
# Check that the bandwidth is 1 or greater
@@ -277,8 +277,8 @@ class APIFirewallTrafficShaperQueueCreate extends APIModel {
277277
}
278278

279279
private function __validate_borrow() {
280-
# Only validate this field if the parent shaper's scheduler is set to FAIRQ
281-
if (in_array($this->parent["scheduler"], ["FAIRQ"])) {
280+
# Only validate this field if the parent shaper's scheduler is set to CBQ
281+
if (in_array($this->parent["scheduler"], ["CBQ"])) {
282282
# Set the borrows options if requested
283283
if ($this->initial_data["borrow"] === true) {
284284
$this->validated_data["borrow"] = "yes";

0 commit comments

Comments
 (0)