Using Console with Aspera Files or ATS



As part of Aspera Files Business and Enterprise Editions, customers have access to an Aspera Console Entitlement.

As of this writing, use of the included Aspera Console is restricted to the Aspera Files and Aspera Transfer Service Entitlements, and can not be used with Aspera on Demand or on-premise (permanent) licensed transfer servers. This opposite is also true (on-premise Aspera Console can not be used with Entitlements).

NOTE: You must request the enablement of Console on the customer entitlement before proceeding.

Please note : While the Entitlement to use Aspera Console is included, the customer is responsible for providing the compute (either on-premise or cloud).


The customer is assumed to have the following:

  • An Entitlement for a supported Edition of Aspera Files or ATS
  • Access Key and Secret for storage and folders to be monitored
  • Server to run Aspera Console on
  • Entitlement Info (from welcome email)
  • Aspera Console and Aspera Enterprise Server Linux installers (ES is needed for ALEE)

Please Note : Only the installation of Aspera Console 3.2+ on a Linux platform is supported. This will not work for Windows installations.

Aspera Console Installation

  1. Download and install the latest version of Aspera Enterprise Server :
  2. Download latest version of Console:
  3. Following the normal installation procedure
  4. After the install, perform the steps below to connect Aspera Console to the Entitlement:

For further information, see this KB:

Enable ALEE Service and Restart Node

# /opt/aspera/bin/ enable
# service asperanoded restart

Enable Entitlement

# cd /opt/aspera/console/
# export RAILS_ENV=production
# export PATH=/opt/aspera/common/ruby/bin:$PATH

Turn on Entitlement and Restart Console

# rake --trace aspera:ami:entitlement:license_mode_on
# asctl all:restart

Entitle the Software

# rake --trace aspera:ami:entitlement:config_license_server EL_KEY="long-entitle-ment-key-goes-here" EL_CUSTOMER_ID="Test"

Add the Managed Clusters to Console

For further information, see The Console Admin Guide

  1. Find the name of the Cluster within Aspera Files
    1. The cluster name can be found in Aspera Files under the Admin view. Select "Nodes and Storage". You can copy the domain name (without the https:// and :port) as such:
    2. ""
    3. ""
  2. Now, within Aspera Console, Go to Nodes and click the New Managed Cluster button
  3. Enter the cluster's domain name address in the Domain Name field (or paste what was copied in step 1.2 above)
  4. Name the cluster
  5. Configure the cluster API port. Port 443 is the default port for communicating with Aspera clusters
  6. If you want to use HTTPS to connect to node, select "Use HTTPS" to connect to node. Aspera recommends using this feature for security reasons
  7. If you want Console to verify the SSL certificate of cluster nodes, select "Require signed SSL certifcate" (NOTE: This may not be available on all Clusters)
  8. Click Create
  9. Console redirects you to the Credentials page to add access keys for authentication. See the next section.

Add Access Keys For Each Folder To Monitor

For further information, see The Console Admin Guide

Create the Access Keys within Aspera Files

  1. NOTE: Each transfer cluster can have multiple access keys
  2. Access Keys are created in Aspera Files under the Admin view. Select "Nodes and Storage", select the node where the Access Key will be created, and enter the associated secret
  3. Click on "Shared Folders"
  4. Select "Keys" for the folder you wish to monitor
  5. Click Click here to create your first client access key to create the Access Key
  6. A key will be generated. SAVE THIS KEY AS YOU WILL NOT BE ABLE TO RETREIVE IT AT A LATER TIME. Download the key pair as a text file. Click OK.
  7. Click the Pencil icon next to "New Key Name" and enter a name for this key (eg "Console")
  8. Click DONE

Within Aspera Console, Go to Nodes and click Edit for the Managed Node you want to monitor

  1. Select "Credentials"
  2. Click Add Access Key
  3. Enter the ID and Secret generated in step 7 above
  4. Give the Access Key a Name (eg "AWS East - Folder 1")
  5. Click Update
  6. Test your new access key by clicking the "test" link
  7. Repeat as necessary for multiple folders or nodes

Continue setting up and configuring Aspera Console as normal

Powered by Zendesk