IN THIS ARTICLE:
A Vlink (virtual link) is a “virtual” aggregate bandwidth cap that can be applied to transfer sessions. Vlinks are defined by their ID, a number between 1 and 255 corresponding to the last octet of the multicast IP address of the Vlink, and their capacity which is the bandwidth cap in Kbps. Transfer sessions assigned to the same Vlink attain an equal share of the capacity defined by the Vlink. Vlinks can be applied to transfers globally, as well as to transfers for specific groups and users.
Use the instructions below to create a Vlink for your Enterprise Server, which can then later be applied to transfers (see this Knowledge Base article for more on how to apply Vlinks). You can create a Vlink in any of following ways: through your server GUI, through Aspera Console and through the command line with asconfigurator. These methods modify the aspera.conf file for you, which stores your transfer configuration settings. If necessary, this file can be edited manually to specify Vlinks.
Method 1: Server GUI
In your server GUI application, click the Configuration button in the top right corner. On the left, click on the VLinks tab. If any Vlinks currently exist, you will see a list of them here.
Click the plus button to add a Vlink, after which you will be prompted to enter an ID for the Vlink. You can assign it any number between 1 and 255 that is not already being used.
Once it is created, you can configure 3 settings by selecting the Override option next to the setting, and choosing your desired value. The first is the Vlink name, which can be anything you want, or it can be left blank. The second option determines whether the Vlink is enabled, and so should be switched to true if you’d like to enable it. The third option controls the capacity enforced by the Vlink.
Click Apply to save the changes to your Vlink, then OK to exit.
Method 2: Aspera Console
If you have Aspera Console, you may also create Vlinks on the Console web interface. To do so, select the Nodes tab on the main navigation menu. Find the node you would like to create the Vlink for and select the edit button on its row. On the node's Node Maintenance page, select the Vlink tab.
If any Vlinks currently exist, you will see a list of them here. To create a new Vlink, select the New Vlink button.
You configure the Vlink by filling out the form. Enter an ID for the Vlink, which can be any number between 1 and 255 that is not already being used. You can enter a name for your Vlink, or just leave the name blank. Select whether you want the Vlink turned on (true) or turned off (false). Finally, enter the capacity of the Vlink in Kbps. Click Create to save your Vlink.
Method 3: asconfigurator
You can also add Vlinks via the command line with asconfigurator, a tool that edits the aspera.conf file where the Vlink configurations are set.
The general command for adding a Vlink and configuring its settings is as below:
asconfigurator -x "set_trunk_data;id,ID;trunk_name,NAME;trunk_capacity,CAPACITY;trunk_on,TRUE/FALSE"
set_trunk_data defines our command to set Vlink information, and is followed by the following specific parameters to set:
- id: The desired Vlink ID. Replace ID with any number 1-255 not already being used by another Vlink.
- trunk_name: The desired Vlink name. Replace NAME with anything, or leave blank.
- capacity: The desired capacity. Replace CAPACITY with the desired bandwidth cap in Kbps.
- trunk_on: Whether the Vlink is enabled or not. Set to true to enable, false to disable.
For example, to create a new Vlink with ID 100, name local and capacity 300Mbps, the command would look like the following:
asconfigurator -x "set_trunk_data;id,100;trunk_name,local;trunk_capacity,300000;trunk_on,true"
The previous methods all modify aspera.conf in the same way to create a Vlink. Usually it is not necessary to edit aspera.conf directly, but you can create Vlinks manually this way by following the correct format. If you choose to edit aspera.conf, exercise extreme caution when doing so as malformed syntax will cause the entire configurations file to be invalid. You can validate aspera.conf after making changes as described at the end of this article.
The file may be found in the following locations:
- Linux: /opt/aspera/etc
- Windows: C:\Program Files (x86)\Aspera\<product name>\etc (replace <product name> with your installed product)
- Mac: /Library/Aspera/etc
As an example, a Vlink with ID 100, name local and capacity 300Mbps would be defined by a section like the following in the file:
The <id> tags set the Vlink ID to any number 1-255 not already being used by another Vlink, the <name> tags set the Vlink name, the <capacity> tags set the capacity, and the <on> tags enable or disable the Vlink.
If you make changes to aspera.conf, ensure you have edited it correctly by running a validation command to check for errors, which is one of the following depending on your system.
For Mac OS X:
"C:\Program Files (x86)\Aspera\Enterprise Server\bin\asuserdata" -v