Command Line Transfers with ATCM

Transfers with 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 (asperaweb_id_dsa.openssh), retrieve the Basic token associated with your ATCM access key, and compose a command line transfer.

  1. To retrieve the Aspera Connect private key, download and install the freely available IBM Aspera CLI (which also includes the Aspera command line tools ascp and ascp4).
  2. If you are using a computer with a Linux or Mac operating system, change the permissions of the private key to 600 by running the following command:
    $ chmod 600 /full/path/to/asperaweb_id_dsa.openssh
  3. 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, see the next step for an example).

    Windows:

    > set ASPERA_SCP_TOKEN=Basic actual_token_value

    For example:

    > set ASPERA_SCP_TOKEN=Basic ZDFQbGJaQjN4cHRxS3d2a29hM19TdeopsedoitgxcTRUWi05SmxSTld2SGlRZ1VQZmxZQ0tlQjVWRlFsbXBKdDUtQ3ZS

    Linux and Mac OS X:

    # export ASPERA_SCP_TOKEN="Basic actual_token_value"

    For example:

    # export ASPERA_SCP_TOKEN="Basic ZDFQbGJaQjN4cHRxS3d2a29hM19TdeopsedoitgxcTRUWi05SmxSTld2SGlRZ1VQZmxZQ0tlQjVWRlFsbXBKdDUtQ3ZS"
  5. Initiate a command line transfer to ATCM.
    To transfer with your ATCM object storage, specify the path to the Aspera Connect private key in your .ssh directory and the paths of the source and destination. xfer is the standard node username associated with ATCM nodes. The following is the upload syntax if the Basic token is set as an environment variable.
    $> ascp -i /full/path/to/asperaweb_id_dsa.openssh -P 33001 -l target_rate /path/to/source/filename xfer@node_dns:destination_path

    Where 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 /Users/aspera/.ssh/asperaweb_id_dsa.openssh -P 33001 -l 200m /Users/aspera/Desktop/Test/smallfile01 xfer@my-atc.example.com:/images

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

    $> ascp -i /full/path/to/asperaweb_id_dsa.openssh -W "Basic token_string" -P 33001 -l target_rate source_files xfer@:node_dnsdestination_path

    For example:

    $> ascp -i /Users/aspera/.ssh/asperaweb_id_dsa.openssh -W "Basic ZGlEZXVGTGNwRzlJWWRzdnhqMFNDcTRtT29oTkpUS3ZwNVEyblJXakRnSUE6YXNwZXJh" -P 33001 -l 200m /Users/aspera/Desktop/Images/image01 xfer@my-atc.example.com:/images