Ascp Transfers with ATS and ATCM

Transfers with ATS and ATCM use the xfer transfer user who is authenticated with the Aspera Connect private key and authorized to the object storage by a Basic token. The Basic token can be set as the environment variable ASPERA_SCP_TOKEN or specified in the command line using -W "Basic token_string".

The following instructions describe how to retrieve and set up the Aspera Connect private key (aspera_tokenauth_id_rsa), set a Basic token associated with your ATS or ATCM access key, and compose a command line transfer.

  1. Create or retrieve your ATS or ATCM access key.
  2. For transfers with ATS, create a Basic authentication token using your Aspera access key and secret key.
    Create a basic auth token by base64-encoding the text string access_key_id:secret. Windows does not have a native base64 encoder. These instructions require that you download base64.exe, a free utility. The infile in the command below is a text file that contains the text string of access_key_id:secret.
    > base64.exe infile outfile

    The basic auth token in the outfile looks similar to the following:

    ZGlEZXVGTGNwRzlJWWRzdnhqMFNDcTRtT29oTkpUS3ZwNVEyblJXakRnSUE6YXNwZXJh

    Open the file and delete any line breaks so that the token text is one continuous string.

  3. For transfers with ATCM, retrieve the authentication token associated with your access key.
    On the Clusters page, select the cluster, click Access Keys, and click Details for your access key. Copy the value for Authentication Token.
  4. Set the token as an environment variable (optional).
    Aspera recommends setting the token as an environment variable so that you do not need to specify it in the command line (which can be done by specifying the -W option, described in the next step).
    > set ASPERA_SCP_TOKEN=Basic token_string

    For example:

    > set ASPERA_SCP_TOKEN=Basic ZDFQbGJaQjN4cHRxS3d2a29hM19TdeopsedoitgxcTRUWi05SmxSTld2SGlRZ1VQZmxZQ0tlQjVWRlFsbXBKdDUtQ3ZS
  5. Transfer with your object storage.
    The following is the upload syntax if the Basic token is set as an environment variable.
    > ascp -i /full/path/to/aspera_tokenauth_id_rsa -P 33001 -l target_rate source_files xfer@server_name:destination_path

    -i sets the path to the Aspera private key, which is:

    C:\Program Files\Aspera\Client\var\aspera_tokenauth_id_rsa

    The destination path is relative to the docroot specified in the access key (leave blank or set to "/" to transfer to the root directory).

    For example:

    > ascp -i /Library/Aspera/var/aspera_tokenauth_id_rsa -P 33001 -l 20m /Users/aspera/Desktop/Images/image01 xfer@ats-aws-us-us-east-1.aspera.io:/images

    If you did not set the token as an environment variable, use -W:

    > ascp -i /full/path/to/aspera_tokenauth_id_rsa -W "Basic token_string" -P 33001 -l target_rate source_files xfer@server_name:destination_path

    For example:

    > ascp -i /Library/Aspera/var/aspera_tokenauth_id_rsa -W "Basic ZGlEZXVGTGNwRzlJWWRzdnhqMFNDcTRtT29oTkpUS3ZwNVEyblJXakRnSUE6YXNwZXJh" -P 33001 -l 200m /Users/aspera/Desktop/Images/image01 xfer@ats-aws-us-us-east-1.aspera.io:/images