Transfer to Cloud from the Command Line (CLI)

Edit online

To transfer to and from your cloud storage through the Aspera transfer service (ATS) from the command line, download IBM Aspera Command-Line Interface (CLI) version 3.9.0 or newer, which is freely available.

You use the aspera command line tool in Aspera CLI to:

  • run high-speed transfers to and from your ATS storage
  • browse the storage
  • delete files and directories
  • rename files and directories

Transfers are authorized by the Aspera private key and authenticated with a basic token that is created from your transfer service access key ID and secret.

Prerequisites

Edit online
  • Download Aspera CLI from the IBM Aspera CLI repository.
  • For installation instructions, refer to the IBM Aspera CLI readme.
    Note: You do not need to edit the CLI configuration file when you use CLI to transfer to and from ATS.
  • Obtain a transfer service access key ID and secret from your transfer service Admin. These are required to authenticate the connection and transfer to and from your object storage. If you are an ATS admin, create the access key.
  • Obtain the transfer service URL for your storage type and region from your transfer service Admin.

Transfer

Edit online
Upload to ATS using this basic syntax: 
aspera ats upload --host=host_address --access-key=access_key_ID --secret=access_key_secret --source=source [--destination=destination_dir] [transfer options]

Where:

  • host_address is the ATS URL
  • source is the path to the source file or directory on your local storage
  • destination_dir is the path to the destination directory on the local computer. Default is ./

You can also configure many transfer settings, such as target transfer rates, encryption, and overwrite. Run man aspera to see a complete options reference.

For example:

aspera ats upload --host=ats-aws-us-us-east-1.aspera.io --access-key=d1PlbZB3456qKwvkoa3_S12T --secret=eMW81q4TZ-9JlRNW4567gUPflYCKeB5VFQlmpJt5-CvR --source=projects/project_A/images --destination=/images --target-rate=10000 --exclude="*.jpg"

Download

Edit online
Browse ATS using this basic syntax: 
aspera ats browse --host=ats-aws-us-us-east-1.aspera.io --access-key=access_key_ID --secret=access_key_secret [--path=path] [options]

Where:

  • host_address is the ATS URL
  • source is the path to the source file or directory in your cloud storage, relative to the access key path
  • destination_dir is the path to the destination directory on the local computer. Default is ./
You can also configure many transfer settings, such as target transfer rates, encryption, and overwrite. Run man aspera to see a complete options reference.

For example:

aspera ats download --host=ats-aws-us-us-east-1.aspera.io --access-key=d1PlbZB3456qKwvkoa3_S12T --secret=eMW81q4TZ-9JlRNW4567gUPflYCKeB5VFQlmpJt5-CvR --source=images --destination=/projects/project_A/images --target-rate=10000

Browse

Edit online
Browse ATS using this basic syntax: 
aspera ats browse --host=ats-aws-us-us-east-1.aspera.io --access-key=access_key_ID --secret=access_key_secret [--path=path] [options]

Where:

  • host_address is the ATS URL
  • path is the path to browse in your ATS storage ("/", the base path of the access key, by default)

More options are available for sorting the output, skipping the first number of files, and other output controls; run man aspera to see a complete options reference.

For example:

aspera ats browse --host=ats-aws-us-us-east-1.aspera.io --access-key=d1PlbZB3456qKwvkoa3_S12T --secret=eMW81q4TZ-9JlRNW4567gUPflYCKeB5VFQlmpJt5-CvR --path=images --count=100 --sort=mtime_a