How to apply a Vlink to your transfers

Description

A Vlink (virtual link) is a “virtual” aggregate bandwidth cap that can be applied to transfer sessions. Vlinks can be applied to transfers globally, as well as to transfers for specific groups and users.

Use the instructions below to apply a Vlink to transfers. You can apply 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 apply Vlinks as well.

The instructions assume you already have a Vlink created and configured. For more detailed information on how to create a Vlink, see this Knowledge Base article.

Instructions

Method 1: Server GUI

In your server GUI application, click the Configuration button in the top right corner.

On the left, click on the Global tab. Here you will be able to set a global Vlink that applies by default to all transfers. Click the Bandwidth tab on the right panel.

You can apply a Vlink on all incoming traffic by setting the Incoming Vlink ID. Select the Override check box and choose the ID of the Vlink you want to apply from the drop-down box. You can do the same thing for all outgoing traffic by setting the Outgoing Vlink ID.

vlink-apply-gui.jpg

Groups and Users

Applying Vlinks to specific groups and users, rather than globally, is similar to the above process.

In order to apply a Vlink to a group, select Groups on the left panel of the Configuration window. Choose your desired group from the list on the left, then click the Bandwidth tab on the right panel. Set the Incoming Vlink ID and Outgoing Vlink ID.

In order to apply a Vlink to a user, select Users on the left panel of the Configuration window. Choose your desired user from the list on the left, then click the Bandwidth tab on the right panel. Set the Incoming Vlink ID and Outgoing Vlink ID.

Click Apply to save your changes, then OK to exit.

Method 2: Aspera Console

If you have Aspera Console, you may also apply Vlinks on the Console web interface. To set a global Vlink that applies to all transfers, 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 Configuration tab.

vlink-apply-console.jpg

Expand the Bandwidth section. To set a Vlink for all incoming traffic on the node, set the Incoming Vlink ID by selecting the Override check box and choosing the ID of the Vlink you want to apply from the drop-down box. To set a Vlink for all outgoing traffic on the node, do the same for Outgoing Vlink ID.

Groups and Users

Applying Vlinks to specific groups and users, rather than globally, is similar to the above process. On the Node Maintenance page, select Accounts.

In order to apply a Vlink to a group, choose your desired group from the list, and click edit on the group's row. Expand the Bandwidth section on the group setting page, and set the Incoming Vlink ID and Outgoing Vlink ID accordingly.

In order to apply a Vlink to a user, choose your desired user from the list, and click edit on the user's row. Expand the Bandwidth section on the group setting page, and set the Incoming Vlink ID and Outgoing Vlink ID accordingly.

Click Save Changes to apply the Vlink.

Method 3: asconfigurator

You can also apply Vlinks via the command line with asconfigurator, a tool that edits the aspera.conf file where the Vlink configurations are set.

The general commands for setting a global Vlink and configuring its settings are as below:

asconfigurator -x "set_node_data;transfer_in_bandwidth_aggregate_trunk_id,ID"
asconfigurator -x "set_node_data;transfer_out_bandwidth_aggregate_trunk_id,ID"

set_node data defines our command to apply our Vlink globally. Following this is transfer_in_bandwidth_aggregate_trunk, which specifies our Vlink to be applied to all incoming traffic, or transfer_out_bandwidth_aggregate_trunk_id, which specifies our Vlink to be applied to all outgoing traffic. Last comes the ID parameter, where you enter the ID of the Vlink you want to be applied.

For example, to apply a global Vlink with ID 101 to only outgoing traffic, you would do the following:

asconfigurator -x "set_node_data;transfer_out_bandwidth_aggregate_trunk_id,101"

Groups and Users

Applying Vlinks to specific groups and users, rather than globally, uses separate though similar commands. 

In order to apply a Vlink to a group run the following, replacing GROUPNAME with the name of the group, and ID with the Vlink ID you want to apply:

asconfigurator -x "set_group_data;group_name,GROUPNAME;transfer_in_bandwidth_aggregate_trunk_id,ID"
asconfigurator -x "set_group_data;group_name,GROUPNAME;transfer_out_bandwidth_aggregate_trunk_id,ID"

 For example, to apply a Vlink with ID 101 to the group local_users only on outgoing traffic, you would do the following:

asconfigurator -x "set_group_data;group_name,local_users;transfer_in_bandwidth_aggregate_trunk_id,101"

In order to apply a Vlink to a user run the following, replacing USERNAME with the name of the user, and ID with the Vlink ID you want to apply:

asconfigurator -x "set_user_data;user_name,USERNAME;transfer_in_bandwidth_aggregate_trunk_id,ID"
asconfigurator -x "set_user_data;user_name,USERNAME;transfer_out_bandwidth_aggregate_trunk_id,ID"

 For example, to apply a Vlink with ID 101 to the user janedoe only on outgoing traffic, you would do the following:

asconfigurator -x "set_user_data;user_name,janedoe;transfer_out_bandwidth_aggregate_trunk_id,101"

Method 4: aspera.conf

The previous methods all modify aspera.conf in the same way to apply a Vlink. Usually it is not necessary to edit aspera.conf directly, but you can apply 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, below is a sample of a Vlink with ID 101 applied to all incoming and outgoing traffic, as a global default set within aspera.conf:

<default>
    <transfer>
      <out>
        <bandwidth>
          <aggregate>
            <trunk_id>101</trunk_id>
          </aggregate>
        </bandwidth>
      </out>
      <in>
        <bandwidth>
          <aggregate>
            <trunk_id>101</trunk_id>
          </aggregate>
        </bandwidth>
      </in>
    </transfer>
  </default>

Below is an example of a Vlink with ID 100 applied to all outgoing transfers in the user group local_users:

<group>
<name>local_users</name>
<transfer>
<out>
<bandwidth>
<aggregate>
<trunk_id>100</trunk_id>
</aggregate>
</bandwidth>
</out>
</transfer>
</group>

Below is an example of a Vlink with ID 100 applied to all outgoing transfers for the user aspera:

<user>
<name>aspera</name>
<transfer>
<out>
<bandwidth>
<aggregate>
<trunk_id>100</trunk_id>
</aggregate>
</bandwidth>
</out>
</transfer>
</user>

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 OSX:

/Library/Aspera/bin/asuserdata -v

For Windows:

 "C:\Program Files (x86)\Aspera\Enterprise Server\bin\asuserdata" -v

For Linux:

/opt/aspera/bin/asuserdata -v
Have more questions? Submit a request

0 Comments

Article is closed for comments.
Powered by Zendesk