ats Command Reference

Aspera on Cloud Transfer Service Subcommands

The ats command offers the following subcommands:
browse Browse files and directories.
delete Delete one or more files or directories.
download Download a file or folder from Aspera on Cloud.
help View Help information for a command.
rename Rename a file in Aspera on Cloud.
upload Upload a file or folder to Aspera on Cloud.

The browse Subcommand

Use the browse subcommand to browse a location. The syntax for browse is as follows: 
> aspera ats browse [args]

Arguments for the browse subcommand:

Option Definition
-b path

--base-ca-path path

 [Optional] The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/etc.
Note: The Aspera CLI installer places a certificates bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument if you want to provide a different certificate location.
-c num

--count num

 [Optional] Retrieve only up to num items. The default value is 1000.
-H host

--host host

 The server's hostname or IP address.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port
-i

--insecure

 [Optional] Accept the certificate, even if it's invalid.
-j

--json

 [Optional] Output raw JSON.
-k num

--skip num

 [Optional] Skip the first num items. num must be a multiple of the value you set with --count.
-L path

--log-path path

 [Optional] The path to the AoC log file.
-o order

--sort order

 [Optional] Sort by order (required). The options for order are as follows:
  • type = sort directories first, then files
  • size_a = sort by file size (ascending)
  • size_d = sort by file size (descending)
  • mtime_a = sort by file modification time (ascending)
  • mtime_d = sort by file modification time (descending)
-p password

--secret password

 The client secret.
-P path

--path path

 [Optional] The remote path. The default value is / .
-T port_number

--port port_number

 [Optional] The listening port on the server.
-u username

--access-key username

 The client access key.

The delete Subcommand

Use the delete subcommand to browse a location. The syntax for delete is as follows: 
> aspera ats delete [args]

Arguments for the delete subcommand:

Option Definition
-b path

--base-ca-path path

 [Optional] The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/etc.
Note: The Aspera CLI installer places a certificates bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument if you want to provide a different certificate location.
-H host

--host host

 The server's hostname or IP address.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port
-i

--insecure

 [Optional] Accept the certificate, even if it's invalid.
-j

--json

 [Optional] Output raw JSON.
-L path

--log-path path

 [Optional] The path to the AoC log file.
-p password

--secret password

 The client secret.
-P path

--path path

 The remote path. The default value is / .
-T port_number

--port port_number

 [Optional] The listening port on the server.
-u username

--access-key username

 The client access key.

The download Subcommand

Use the download subcommand to download files or directories. The syntax for download is as follows: 
> aspera ats download [args]

Arguments for the download subcommand:

Option Definition
-b path

--base-ca-path path

 [Optional] The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/etc.
Note: The Aspera CLI installer places a certificates bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument if you want to provide a different certificate location.
-c cookie_string

--cookie cookie_string

 [Optional] Cookie, if one is required.
--cipher=cipher [Optional] Attempt to set the encryption cipher (if server settings allow).
cipher can have the following values:
  • aes-128 or aes-128-cfb
  • aes-192 or aes-192-cfb
  • aes-256 or aes-256-cfb
  • aes-128-gcm
  • aes-192-gcm
  • aes-256-gcm
  • none
--content-protect-password password [Optional] Specify the password that is used to encrypt/decrypt files on the server.
-d path

--destination path

 [Optional] The path to the destination. The default value is / .
-e

--remove-empty-directories

 [Optional] When the transfer is complete, remove empty directories.
-E pattern

--exclude=pattern

 [Optional] Exclude files that match the given pattern. To specify multiple patterns, repeat the -E option.
-H host

--host host

 The server's hostname or IP address.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port
-i

--insecure

 [Optional] Accept the certificate, even if it's invalid.
-L path

--log-path=path

 [Optional] The path to the logfile.
--min-rate new_rate [Optional] Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps.
-o overwrite_method

--overwrite overwrite_method

 [Optional] Overwrite existing files. overwrite_method can be any of the following values:
  • never
  • always
  • older
  • diff
  • diff+older
-p password

--secret password

 The client secret.
-R

--remove-after-transfer

 [Optional] When the transfer is complete, remove the transferred content from the source.
--rate-policy=policy [Optional] Attempt to revise the rate policy (if server settings allow).
The options for policy are
  • fixed
  • high
  • fair
  • low
-s path

--source path

 The path to the file to download. To specify multiple files, separate the files by a space character.
--save-before-overwrite [Optional] Save a copy of a file before it is overwritten by the transfer. A copy of filename.ext is saved as filename.yyyy.mm.dd.hh.mm.ss.index.ext in the same directory.
-T port_number

--port port_number

 [Optional] The listening port on the server.
--target-rate newRate [Optional] Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps.
-u username

--access-key username

 The client access key.
-x proxy_hostOrIp

--proxy proxy_hostOrIp

 [Optional] The hostname or IP address of the proxy computer (forward proxy).

The rename Subcommand

Use the rename subcommand to rename a file or directory. The syntax for rename is as follows: 
> aspera ats rename [args]

Arguments for the rename subcommand:

Option Definition
-b path

--base-ca-path path

 [Optional] The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/etc.
Note: The Aspera CLI installer places a certificates bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument if you want to provide a different certificate location.
-d path

--destination path

 The new name for the file or directory.
-H host

--host host

 The server's hostname or IP address.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port
-i

--insecure

 [Optional] Accept the certificate, even if it's invalid.
-j

--json

 [Optional] Output raw JSON.
-L path

--log-path path

 [Optional] The path to the AoC log file.
-p password

--secret password

 The client secret.
-P path

--path path

 [Optional] The remote path containing the file to be renamed. The default value is / .
-s path

--source path

 The file or directory to rename.
-T port_number

--port port_number

 [Optional] The listening port on the server.
-u username

--access-key username

 The client access key.

The upload Subcommand

Use the upload subcommand to download files or directories. The syntax for upload is as follows: 
> aspera ats upload [args]

Arguments for the upload subcommand:

Option Definition
-b path

--base-ca-path path

 [Optional] The base path for your CA certificates. If your certificates are in the default location, this argument is not required. The default path is ~/.aspera/cli/etc.
Note: The Aspera CLI installer places a certificates bundle at installation-dir/etc/curl-ca-bundle.crt. Use this argument if you want to provide a different certificate location.
-c cookie_string

--cookie cookie_string

 [Optional] Cookie, if one is required.
--cipher=cipher [Optional] Attempt to set the encryption cipher (if server settings allow).
cipher can have the following values:
  • aes-128 or aes-128-cfb
  • aes-192 or aes-192-cfb
  • aes-256 or aes-256-cfb
  • aes-128-gcm
  • aes-192-gcm
  • aes-256-gcm
  • none
-d path

--destination path

 The path to the destination. The default value is / .
-e

--remove-empty-directories

 [Optional] When the transfer is complete, remove empty directories.
-E pattern

--exclude=pattern

 [Optional] Exclude files that match the given pattern. To specify multiple patterns, repeat the -E option.
--fasp-proxy=proxy_hostOrIp [Optional] The hostname or IP address of the proxy computer (forward proxy).
--file-checksum=hash [Optional] Enable checksum reporting for transferred files.
hash is the type of checksum to calculate:
  • none (default)
  • md5
  • sha1
  • sha-256
  • sha-384
  • sha-512
--file-encrypt [Optional] Encrypt files. To use this option, you must first set the encryption/decryption passphrase with the ASPERA_SCP_FILEPASS environment variable.
-H host

--host host

 The server's hostname or IP address.
--http-proxy proxy_hostOrIp [Optional] The hostname or IP address of the HTTP proxy computer.

proxy_hostOrIP should take the following form:

scheme://proxy_address:port
-i

--insecure

 [Optional] Accept the certificate, even if it's invalid.
--ignore-host-key [Optional] Ignore the server's SSH host key fingerprint.
-j

--encode-jpeg

 [Optional] Encode all HTTP transfers as JPEG files.
-k resume_level

--resume-level=resume_level

 [Optional] Enable the resuming of partially transferred files at the specified resume level.
resume_level can have the following values:
  • 0 (default) - Always retransfer the entire file.
  • 1 - Compare file attributes and resume if they match, and retransfer if they do not.
  • 2 - Compare file attributes and the sparse file checksums; resume if they match, and retransfer if they do not.
  • 3 - Compare file attributes and the full file checksums; resume if they match, and retransfer if they do not.
-l new_rate

--target-rate=new_rate

 [Optional] Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps.
-L path

--log-path=path

 [Optional] The path to the logfile.
-m new_rate

--min-rate=new_rate

 [Optional] Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps.
--move-after-transfer=path [Optional] Specify the directory where the file will be moved to after it is transferred.
-o overwrite_method

--overwrite overwrite_method

 [Optional] Overwrite existing files. overwrite_method can be any of the following values:
  • never
  • always
  • older
  • diff
  • diff+older
-O port_num

--udp-port=port_num

 [Optional] Set the UDP port for FASP transfers.
-p password

--secret password

 The client secret.
-P port_num

--tcp-port=port_num

 [Optional] Set the TCP port for FASP transfers.
--partial-file-suffix=suffix [Optional] Set a suffix to append to the filenames of partially transferred files.
--port port_number [Optional] The listening port on the server.
--preserve-dates [Optional] Preserve the timestamps on transferred files.
-q, --filelist [Optional] Specify a file that contains a list of files to transfer.
-R

--remove-after-transfer

 [Optional] When the transfer is complete, remove the transferred content from the source.
--rate-policy=policy [Optional] Attempt to revise the rate policy (if server settings allow).
The options for policy are
  • fixed
  • high
  • fair
  • low
--remote-host=host_address [Optional] The address of the remote host.
--remove-empty-source-directory [Optional] When the transfer is complete, remove empty source directories.
-s path

--source path

 The path to the file to upload. To specify multiple files, separate the files by a space character.
--save-before-overwrite [Optional] Save a copy of a file before it is overwritten by the transfer. A copy of filename.ext is saved as filename.yyyy.mm.dd.hh.mm.ss.index.ext in the same directory.
--source-prefix=prefix_path [Optional] Set a path to be prepended to each source path.
--src-base=prefix [Optional] Strip the specified prefix from each source path. The remaining portion of the source path is kept intact at the destination.
-T

--disable-encryption

 [Optional] Disable encryption.
-u username

--access-key username

 The client access key.
--user=username [Optional] The username of the Aspera transfer user.
-Z datagram_size

--mtu=datagram_size

 [Optional] Set the MTU manually, in bytes.