Aspera Upload Acceleration

This client quickly transfers content from your local system to NetStorage using Asperasoft's accelerated transfer protocol, “FASP.”

Aspera Upload Acceleration (Aspera) utilizes a high-speed, third-party client (the "Aspera Client") that has been developed for Akamai by Asperasoft. This protocol consists of two channels:

  • Control Channel. This channel grants access to the Aspera binary via an SSH connection.
  • Transfer Channel. This channel conducts the transfer via a negotiated port (encrypted or unencrypted) using Aspera's UDP-based protocol.

Aspera client installation

To use Aspera, you need the "Aspera Client" application (or an equivalent).

Download a compatible Aspera Client

This table lists the Aspera Clients that NetStorage supports. Any client not listed is unsupported and may have problems authenticating.

System

Version

Linux (Debian)

v4.0.0.182279

Linux (Red Hat)

v4.0.0.182279

MAC

v4.0.0.182279

Windows

v4.0.0.182279

Installing legacy Aspera licenses

These installation instructions are for the legacy versions (v3.x.x) available in Download Center.

❗️

Legacy Aspera Clients - Cipher Deprecation

As part of Akamai’s process for improving security, these vulnerable ciphers used by legacy Aspera 3.x clients will begin deprecating on April 22nd, 2022:

  • diffie-hellman-group-exchange-sha1
  • diffie-hellman-group14-sha1
  • diffie-hellman-group1-sha1

These clients will fail to connect when these ciphers are removed. Upgrade to a supported version prior to April 22nd, 2022.

You must first download the Aspera Client installable and its license. Use your Control Center username and password to access these components:

  1. Access the Aspera Client page in Control Center
  2. In the Aspera Client Install section, click the “AsperaClient_(Operating System)” link for the appropriate operating system to start a download.
  3. Navigate to the directory housing the downloaded files and use an applicable decompression software to decompress the “AsperaClient_(Operating System).zip” file.

Install the client

With the client installable and license obtained, you can perform an install on your local system.

Linux

  1. Run the installer via a terminal session based on the Linux distribution in use:

    • Linux: $ dpkg -i aspera-scp-client-[version].deb
  2. Follow the prompts to perform the install.

  3. With the install complete, you must now apply the License file. This can be done in one of two ways:

  1. Via the Aspera Client UI:

    • Launch the client in a terminal (as a root user): $ asperascp
    • In the License window that is revealed, click Import License File.
    • Navigate to the directory housing the decompressed license file.
    • Select the license file, click OK, and click Close.
  2. Via a Terminal Session:

    • Open the decompressed license file and copy its contents.
    • Create the following file, and paste your license key string into it: $ /opt/aspera/etc/aspera- license
    • When finished, save and close the file.
    • Issue the following command to verify the license: $ ascp -A

Mac OS X

  1. Double-click the client installer to begin the installation.
  2. Follow the prompts displayed to install the client.
  3. Launch the Aspera Client (Macintosh HD > Applications > Aspera Client).
  4. In the dialog that is revealed, click the Import License File button.
  5. Navigate to the directory housing decompressed license file. Click it to select it, and click OK.
  6. Click Close.

Microsoft Windows

  1. Installation and use of the Aspera Client requires that the current user be Administrator-level. To begin, right-click the install file, select Run as Administrator, and input appropriate login credentials.
  2. When prompted to Choose Setup Type, click “Typical”.
  3. In the Aspera Service Account dialog, input the following:
    • User name. Input the name of a valid, Administrator-level user for the system (for example, the current login)
    • Password. Input the associated password for the user.

📘

These values are not actually used when using the Aspera Client with NetStorage, but they must be defined to complete the installation.

  1. Follow the remaining prompts to complete the installation. Ensure that the “Launch Aspera Client” checkbox is deselected, to stop the client from automatically opening upon completion.
  2. Navigate to the “bin” folder within Client install directory. (For example, with a default install, this would be C:\Program Files(x86)\Aspera\Client\bin.)
  3. Locate the “asperascp.exe” file, right-click it and select “Properties”.
  4. Select the Compatibility tab, enable 'Run this program as administrator" and click the OK button.
  5. Launch the Aspera Client (Start > All Programs > Aspera > Client > Client), and input appropriate Administrator login credentials.
  6. In the dialog that is revealed, click Import License File.
  7. Navigate to the directory housing the decompressed license file. Click it to select it, and click OK.
  8. Click Close to complete the process.

Aspera key configuration

With the Aspera client (or equivalent) installed, you need to configure it for use with NetStorage.

Configuration is required in both the NetStorage Groups UI in Control Center, as well as in the Aspera Client (or equivalent).

Generate an SSH key and enable Aspera

You need to generate an SSH key, and then access an applicable upload account to apply the key and enable Aspera Upload Acceleration.

Here, you apply an SSH key to an upload account that has been configured to access the desired storage group.

  • The "Public" instance of the key is applied to the account.
  • The "Private" instance of the key resides on the system using the Aspera Client, and the two are resolved when connecting.

This process uses a combination of the Aspera Client and the NetStorage Groups UI to accomplish this task. You must have the Aspera Client installed on your local system.

How to generate an Aspera SSH key

The Aspera Client application offers a built-in SSH key generator. For simplicity, we recommend that you use this tool to generate a new key.

  1. Launch the Aspera Client:
    • Linux (Debian/RedHat). From a Terminal Session, issue the asperascp command.
    • Mac OSX. Navigate to Macintosh HD > Applications > Aspera Client.
    • Microsoft Windows. Select Start Menu > All Programs > Aspera > Client > Client, and input appropriate Administrator login credentials.
  2. Select Tools > Manage Keys...
  3. Click the button in the upper left corner to create a new SSH key pair.
  4. Input these values:
    • Identity. Input a name for the key. Both Public and Private key files will be labeled with this name.
    • Passphrase (Optional). If desired, input a passphrase (password) to protect the key. Each time the key is used for access, this value will be requested.
    • Confirm Passphrase. Input the same value set for Passphrase (Optional).
    • Type. Set to “RSA”.
    • Access. Ensure that this checkbox de-selected
Defining options for a new SSH key pair
  1. Click OK.
  2. The new key will display in the table, with the Public instance of it displayed. Leave this window open, as you will use it later in the process.

🚧

Individual SSH keys can't be shared between NetStorage upload accounts

You must create individual, separate keys for each upload account using Aspera Upload Acceleration.

Apply the SSH key and enable Aspera

This process assumes you used the built-in SSH key generator in the Aspera Client.

  1. Open the application. Go to ORIGIN SERVICESNetStorage.
  2. Access the Upload Accounts entity.
  3. Click + Add New Upload Account or edit an existing account.
  4. In the Access Methods content panel for an upload account, access the SSH and Aspera tab.
  5. Click + Add SSH key.
  6. Return to the SSH Key window of the Aspera Client interface, select the applicable key and click Edit.
  7. Once the key loads, click Copy to Clipboard.
The Aspera SSH key window
  1. Return to the NetStorage Groups UI in Control Center, and paste the key into the SSH key field.
  2. Input Notes for the key (optional) and click Save.
  3. Set the Aspera Upload Acceleration slider switch to On.
  4. Continue with creating (or editing) the account as necessary and then click Save to save the upload account.
Add the Aspera SSH key

At this point, you need to wait for provisioning to complete. Here are some specifics on what will happen next.

  • Did you create a new Upload Account? If so, the Contact Email Address set for the account will receive a verification email including a link you must click. The account will then enter propagation, which takes roughly 60 minutes to complete. After completion (the same email address will receive a
    confirmation email), you can move on to configure the Aspera Client.
  • Did you edit an existing Upload Account? If so, the account will simply enter propagation, which takes roughly 60 minutes to complete. After completion, the Contact Email Address for the account will receive a confirmation email. At this point, you can move on to configure the Aspera Client.

Configure the Aspera Client application

You need to create a “Connection” in the Aspera Client UI.

  1. If necessary, launch the Aspera Client:

    • Linux (Debian/RedHat). From a Terminal Session, issue the asperascp command.
    • Mac OSX. Navigate to Macintosh HD > Applications > Aspera Client.
    • Microsoft Windows. Select Start Menu > All Programs > Aspera > Client > Client, and input appropriate Administrator login credentials.
  2. Click the Connections icon to open the Connection Manager.

  3. At the top of the Connection Manager interface, click "" to create a new connection.

  4. Select Create a standard connection.

  5. Click New Connection and rename it to something unique and easy to recognize. For example, you could use "NetStorage Aspera [CP Code]".

  6. Ensure that the Connection tab is selected and define these fields:

    • Host. Use <Domain name prefix>.aspera.upload.akamai.com for the storage group you're looking to access.
    • User. You must input sshacs in this field. (Do not input your Control Center user login.)
    • Authentication. Click the Public Key radio button and perform the following to configure the SSH Key for use:
  7. Click Manage Keys

  8. In the interface that is revealed, accessible “Private” keys will be revealed. The one you created
    earlier using this UI (as recommended) is revealed. Click to select it.

  9. The “Public” instance of the key will be displayed. Click the Close button to continue.

    • Storage Type: Select Akamai NetStorage.
    • Target Directory: This is where content will be uploaded in NetStorage. Input the complete path to the desired directory, including the CP code root. This can be any existing subdirectory that is accessible to the upload account.
Setting configuration options for a Connection in the Aspera Client

Increase the Default Target Rate

By default, the Aspera Client has a "Default Target Rate" setting for upload speeds of 45 Mbps. If your environment can support it, we recommended that you increase these values to allow for faster transfer rates.

  1. If necessary, launch the Aspera Client.
  2. Select Tools > Preferences...
  3. Set the Upload/Download instances of the Default Target Rate to a higher value, applicable to your environment.

🚧

Don't set the default target rate to a value higher than your data pipe can provide

Take non-Aspera upload acceleration traffic into consideration, as well. Failure to accommodate your environment’s limitations will result in high client-side error rates.

Use your access method

You can use Aspera once your upload account changes have propagated. View usage examples and limitations.


Did this page help you?