Versions Compared

Old Version 1

changes.mady.by.user Andrea Harvey

Saved on

compared with

New Version 2

changes.mady.by.user Andrea Harvey

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Image RemovedImage Added

Bandwidth throttling allows the user to limit how much upload or download bandwidth SkySync'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

node bin/skysync.js performance bandwidth_throttle show --json

Example Result

Code Block
[
  {
    "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

node bin/skysync.js performance bandwidth_throttle update --upload '{ "bytes_per_second": 504000, "disabled": false, "window": [ { "bytes_per_second": 222444, "days" : ["Monday", "Tuesday", "Friday", "Saturday"], "start_time": { "hr": 2, "min": 2, "sec": 0 },"end_time": { "hr": 12, "min": 12, "sec": 0 } }]}'

2

node bin/skysync.js performance bandwidth_throttle update --u '{ "bytes_per_second": 504000, "disabled": false, "window": [ { "bytes_per_second": 222444, "days" : ["Monday", "Tuesday", "Friday", "Saturday"], "start_time": { "hr": 2, "min": 2, "sec": 0 },"end_time": { "hr": 12, "min": 12, "sec": 0 } }]}'

3

node bin/skysync.js performance bandwidth_throttle update --upload-file {name_of_file}.json

4

node bin/skysync.js performance bandwidth_throttle update --uf {name_of_file}.json

Setting Download Throttling

Examples

1

node bin/skysync.js performance bandwidth_throttle update --download '{ "bytes_per_second": 504000, "disabled": false, "window": [ { "bytes_per_second": 222444, "days" : ["Monday", "Tuesday", "Friday", "Saturday"], "start_time": { "hr": 2, "min": 2, "sec": 0 },"end_time": { "hr": 12, "min": 12, "sec": 0 } }]}'

2

node bin/skysync.js performance bandwidth_throttle update --d '{ "bytes_per_second": 504000, "disabled": false, "window": [ { "bytes_per_second": 222444, "days" : ["Monday", "Tuesday", "Friday", "Saturday"], "start_time": { "hr": 2, "min": 2, "sec": 0 },"end_time": { "hr": 12, "min": 12, "sec": 0 } }]}'

3

node bin/skysync.js performance bandwidth_throttle update --download-file {name_of_file}.json

4

node bin/skysync.js performance bandwidth_throttle update --df {name_of_file}.json

Sample JSON File used for Update

Code Block
{
    "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
            }
        }
    ]
}

Info

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.