CLI: Bandwidth Throttling
- Andrea Harvey
The CLI references “skysync.” This is expected.
Bandwidth throttling allows the user to limit how much upload or download bandwidth DryvIQ's jobs use. Throttling can be set up to take effect at certain times of day.
Parameters
Setting bandwidth throttling is done using the following two parameters.
Parameter | Description |
|---|---|
upload u | Sets the upload bandwidth throttling |
download d | Sets the download bandwidth throttling |
List Throttling Configuration
Command |
|---|
|
Example Result |
|---|
[
{
"upload": {
"disabled": false,
"bytes_per_second": 504000,
"window": [
{
"bytes_per_second": 222444,
"days": [
"monday",
"tuesday",
"friday",
"saturday"
],
"start_time": {
"hr": 2,
"min": 2,
"sec": 0,
"ms": 0
},
"end_time": {
"hr": 12,
"min": 13,
"sec": 0,
"ms": 0
}
}
]
},
"download": {
"disabled": true,
"bytes_per_second": 151316851,
"window": [
{
"bytes_per_second": 2000,
"days": [
"monday"
],
"start_time": {
"hr": 7,
"min": 12,
"sec": 0,
"ms": 0
},
"end_time": {
"hr": 16,
"min": 36,
"sec": 0,
"ms": 0
}
}
]
}
}
] |
Updating Throttling Configuration
If the disabled flag on the upload or download is set to true, both configurations will be ignored.
Setting Upload Throttling
Examples | |
|---|---|
| 1 |
|
| 2 |
|
| 3 |
|
| 4 |
|
Setting Download Throttling
Examples | |
|---|---|
| 1 |
|
| 2 |
|
| 3 |
|
| 4 |
|
Sample JSON File used for Update
{
"bytes_per_second": 151316851,
"disabled": false,
"window": [
{
"bytes_per_second": 0,
"days": ["monday"],
"start_time": {
"hr": 7,
"min": 12
},
"end_time": {
"hr": 16,
"min": 36
}
},
{
"bytes_per_second": 0,
"days": ["wednesday", "friday"],
"start_time": {
"hr": 8,
"min": 52
},
"end_time": {
"hr": 21,
"min": 48
}
},
{
"bytes_per_second": 6000,
"days": ["tuesday", "thursday"],
"start_time": {
"hr": 8,
"min": 52
},
"end_time": {
"hr": 21,
"min": 48
}
}
]
}
When bandwidth throttling is set through the CLI, the changes will be reflected on the Performance page in the Settings once the page is refreshed.