How Do I Configure AXIS Cloud Sync Bandwidth Throttling

AXIS Cloud Sync’s bandwidth throttling feature allows you to configure the maximum number of Kilobytes that can be transferred (uploaded or downloaded) per second. This feature lets you conserve resources used by one machine, or one organization, in order to allow other machines to transfer data more efficiently when the server or agent location has limited bandwidth.

As an administrator, you can configure bandwidth throttling settings at the organization level, or for individual machines. Additionally, end users can configure their own bandwidth settings through their AXIS Cloud Sync Tool preferences on their local machines.

What to Consider

While bandwidth throttling settings should be considered based on specific environment and network variables, it is important to understand how bandwidth throttling works before making changes to an organization or a machine policy.

Bandwidth throttling settings allow administrators to specify a maximum amount of data (in Kilobytes) to transfer per second; these settings are not configured based on a percentage of available bandwidth. If the server sends a block of data, the network will send it as quickly as possible. When download or upload speeds hit the maximum bandwidth setting, the speed is throttled back before the next block of data is sent.

If bandwidth settings are too high for a specific environment, upload and download speeds will rarely be throttled, and a network monitor might not display a watermark. If bandwidth settings are extremely low relative to the total available bandwidth, then a network monitor might display spikes as each block of data is sent, but will be throttled accurately and will smooth out as the transfer continues.

Tracking Bandwidth Usage

You can use the AXIS Cloud Sync Dashboard as well as reports to understand bandwidth usage.

In the Dashboard, click the highest level organization to view collective information about all organizations, or use the Organization navigation menu to view specific information for individual organizations. 

You can use the Bandwidth Over Time widget to view the total amount of data transferred—both uploaded and downloaded—over time. 

The Top Bandwidth Machines widget shows a list of machines, ordered by bandwidth usage. In this widget, Bytes Sent refers to data sent from the server to the agent. Bytes Received refers to data sent from the agent to the server.

bandwidth.png bandwidth2.png

Additionally, when you create reports, you can view top bandwidth machines within an organization (or all organizations). In the Report Settingspage, click the Top Bandwidth Machines checkbox to generate information for the selected organization. Within the generated report, Bytes Sent refers to data sent from the server to the agent. Bytes Received refers to data sent from the agent to the server. For more information about reports, please reference the Reporting Feature Knowledge Base article.

report.png

Setting Bandwidth Throttling Policies at the Organization Level

To configure bandwidth settings at the organization level:

  1. In the appropriate organization, click the Settings tab. The Organization Settings page displays.
  2. In the Organization Settings page, click the Policies tab. The Policies page displays for the selected organization.
  3. In the Policies page, scroll down to the Bandwidth Settings section of the page.
    bandwidth1.png
  4. In the Bandwidth Settings section, you can configure bandwidth settings for the selected organization.
    • In the Throttle Bandwidth field, enter the number of KB/second for the organization. Alternatively, enter 0 for unlimited, or leave the field blank.
    • Optionally, click the Enable Throttle Exception checkbox. The page expands, allowing you to specify an exception period.
      Note:  This exception period provides the opportunity for secondary bandwidth throttling settings, allowing you to configure throttling all of the time, or part of the time. If you turn on throttling without setting an exception, bandwidth will be throttled at the defined rate until it is set back to 0 (unlimited). If you configure an exception, bandwidth will be throttled at the defined rate EXCEPT during the exception days and times that you define.

      • In the Exception Days section, select the Weekdays, Weekends, or Custom radio button to specify the time period when bandwidth throttling will not be in effect.
      • In the Start Time field, use the sliding scales to adjust the hour and minute when the exception will take effect. Optionally, click the Now button to set the sliders to the current time. Click the Done button when you are finished.
      • In the End Time field, use the sliding scales to adjust the hour and minute when the exception will take effect. Optionally, click the Now button to set the sliders to the current time. Click the Done button when you are finished.
        bandwidth2.gif
    • Click the Save button when you are finished making changes.

Setting Bandwidth Throttling Policies at the Machine Level

Alternatively, you can set bandwidth settings for a specific machine.

To set bandwidth settings at the machine level:

  1. In the appropriate organization, click the Machines tab. The Machines page displays, showing a list of all registered machines in the selected organization.
  2. In the Machines page, click the specific Machine Name link.
    1.png
    The Machine Settings page displays.
    1.png
  3. In the Machines Settings page, configure bandwidth settings for the selected machine.
    • In the Throttle Bandwidth field, enter the number of KB/second for the machine. Alternatively, enter 0 for unlimited.
    • Optionally, click the Enable Throttle Exception checkbox. The page expands, allowing you to specify an exception period.
      Note:  This exception period provides the opportunity for secondary bandwidth throttling settings, allowing you to configure throttling all of the time, or part of the time. If you turn on throttling without setting an exception, bandwidth will be throttled at the defined rate until it is set back to 0 (unlimited). If you configure an exception, bandwidth will be throttled at the defined rate EXCEPT during the exception days and times that you define.

      • In the Exception Days section, select the Weekdays, Weekends, or Custom radio button to specify the time period when bandwidth throttling will not be in effect.
      • In the Start Time field, use the sliding scales to adjust the hour and minute when the exception will take effect. Optionally, click the Now button to set the sliders to the current time. Click the Done button when you are finished.
      • In the End Time field, use the sliding scales to adjust the hour and minute when the exception will take effect. Optionally, click the Now button to set the sliders to the current time. Click the Done button when you are finished.
        bandwidth5.gif
    • Click the Save button when you are finished making changes.

Setting Bandwidth Throttling Policies through AXIS Cloud Sync Tool

End users can configure bandwidth policies through the AXIS Cloud Sync Tool system tray icon. Agent settings allow for separate throttling configurations for uploads and downloads.

Note: AXIS Cloud Sync will override higher-value bandwidth throttling settings with lower-value settings. For example, if an end-user configures his agent settings to be X KB/s, and organization settings are set to (X+1) KB/s, then the agent will use the former to send and receive data.

To configure bandwidth settings on a local machine:

  1. Click the AXIS Cloud Sync icon on your computer’s system tray, and select Properties. The AXIS CloudSync Tool Preferences dialog box displays.
  2. In the AXIS CloudSync Tool Preferences dialog box, click the Bandwidth tab. The Bandwidth tab displays, showing bandwidth configuration options.
  3. In the Upload section, select bandwidth settings for uploading documents from the local machine.
    • Click the Don’t Limit radio button (default) if you do not want to configure bandwidth throttling for uploads.
    • Click the Automatic radio button to automatically set bandwidth settings.
    • Click the Limit KB/s radio button to specify a number of KBs per second that will be used to determine upload speeds.
  4. In the Download section, select bandwidth settings for downloading documents to the local machine.
    • Click the Don’t Limit radio button (default) if you do not want to configure bandwidth throttling for downloads.
    • Click the Limit KB/s radio button to specify a number of KBs per second that will be used to determine download speeds.
  5. Click the OK button when you are finished.