Release Notes: IBM Aspera Command-Line Interface 3.9.2
Release Notes Updated: August 28, 2019
This release of the IBM Aspera Command-Line Interface (the Aspera CLI) provides the new features, fixes, and other changes listed below.
NEW FEATURES
- Private Key Can Now Be Passed Via an Environment Variable
When you use the Aspera CLI with Aspera on Cloud, you use a public/private keypair to authenticate the CLI with AoC as a client application. In most cases, you store the private key in a file on the client computer.
But if for security reasons the private key should not be stored on disk, you can now set an environment variable for it, and pass the key to the Aspera CLI through the environment variable. To do this, set the ACLI_PRIVATE_KEY64 environment variable after installing the CLI.Note: When you set the environment variable, give the base64 value typically used in PEM formats.If you don't set an environment variable for the private key, the Aspera CLI reverts to finding the key in the etc directory of your CLI installation, in the file you name in the .aspera_cli_conf configuration file.
- Support for Custom Tags
The Aspera CLI now correctly supports the ascp arguments --tags and --tags64 as arguments to the Aspera CLI. These arguments are for custom metadata you may include with the content you transfer.Note: To use these arguments correctly, pass them as part of your Aspera CLI command sequence, not as ascp arguments appended to that sequence.
These arguments are supported for the aspera aoc upload and aspera aoc download subcommands.
With --tags, specify a string in JSON format; with --tags64, specify a string in base64-encoded JSON format.Note: On Windows hosts, Aspera recommends you use the --tags64 argument rather than --tags: With --tags, you must escape the JSON string. For example:--tags={\"aspera\":{\"node\":{\"other\":\"value\"},\"key2\":\"value\"},\"other\":{\"key\":\"value\"}} - --preserve-dates Option Extended
The --preserve-dates option is now available for the ats download, node download, and shares download subcommands. When you include this argument, the CLI preserves the original timestamps on files that are transferred. (CIM-2428)
- Decryption Support
In addition to the encryption of transfers, support has now been added for decryption of these transfers. Decryption support has been added for the aspera node and aspera shares commands, and for the aspera ats download subcommand.
To decrypt transfers, set the ASPERA_SCP_FILEPASS environment variable with your passphrase for decryption. Then specify the --file-decrypt option in your command sequence.
ISSUES FIXED IN THIS RELEASE
ACLI-502 - An issue has been fixed in which the body of messages were not included with notification emails about packages sent to Aspera on Cloud. (CIM-2509)
ACLI-472 - For transfers with Aspera on Cloud, the Aspera CLI transferred packages as if the --public-link option were always set.
ACLI-455 - Transfers into and and out of Aspera on Cloud were not included in the AoC Analytics app.
SYSTEM REQUIREMENTS
- This release of the Aspera CLI does not support the Shares Management API.
- This release of the Aspera CLI does not support the Faspex v4 API.
- OS versions (glibc 2.9 and higher): RHEL 6.7,7.3, 7.4, CentOS 6-7, Debian 7-9, Fedora 26-27, SLES 11-12, OpenSUSE 42.3, Ubuntu 16.04 LTS, 17.10
- Required Libraries: OpenSSL 1.0.2g or higher, glib2 2.28 or higher
Mac: OS X 10.11, macOS 10.12, 10.13.
Windows: Windows 7, 8, 10, or Windows Server 2008 R2, 2012 R2, 2016.
PREVIOUS RELEASE NOTES
PACKAGE INFORMATION
OTHER RESOURCES
KNOWN ISSUES
aspera
ACLI-71 - [Mac OS X only] If you install the Aspera CLI to a location to which you lack permissions, the installation fails, but the installer nevertheless reports a successful installation.
ACLI-61 - [Windows only] When you specify a filepath using the %homepath% variable, the Aspera CLI action fails.
Cannot parse an empty string Workaround:
Remove XML escape sequences (either manually or with an XML parser) from URLS before passing
them as input to a faspex get subcommand.
JSON Exception: Error: Path not found The error does not indicate
that authorization is denied.
Setting up FASP parameters... Invalid access: Cannot convert empty value.
ascp
ATT-657 - Multi-session transfers that use -k1, or multi-session
transfers from cloud storage to local storage, can result in files on the destination that
are missing bytes. This occurs when a file is split between sessions; the first session
creates matching attributes for the source and destination (partial) file, and the other
sessions do not recognize that there are more bytes for transfer. Workaround: For
multi-session downloads from cloud storage, use --overwrite=always (to
prevent resuming file transfers) or --multi-session-threshold=0 (to
prevent file-splitting across sessions).
ATT-613 - When uploading files to a HST Server on a Windows computer, if the file name contains a carriage return character ("\r"), then the transfer fails. (CIM-1205)
ATT-435 - save-before-overwrite is not supported for URI.
ATT-361 - ascp transfers to S3 fail when the
--symbolic-link=copy or --symbolic-link=copy+force
option is used.
ATT-226 - If the docroot is a URL path, ascp reports incorrect bytes for the sessions that are involved in a multi-session transfer.
ATT-185 - ascp does not reconnect to Redis database when
asperanoded is restarted.
ES-645 - The ascp -@ option is not supported when the destination is
stdio://.
ES-359 - ascp downloads from SoftLayer do not support
--move-after-transfer.
ES-177 - The range_low value of a -@ argument is not
respected.
#35010 - If the source path in an ascp transfer is a file that is named \ (which is not supported by Aspera), the file is not transferred and an error is generated, but the folder then contains the file and all other files in that folder are transferred.
#34322 - [Linux CentOS 7.2] ascp fails to authenticate SSH with a large banner file size (approximately 2000 bytes).
#32890 - During an ascp transfer that uses the --preserve-xattrs= metafile --remote-preserve-xattrs=metafile options, the metafile is not transferred.
#32680 - The option to create a directory (ascp -d) may create a directory at a destination before an expected session failure.
#30324 - During an ascp upload to cloud storage, if a mid-file read failure occurs on the sending computer (which is rare) it can cause the server-side ascp to crash and possibly fail to report transfer completion. This read failure can be caused when a source file is truncated during transfer, a drive or file system fails, or a transfer is canceled with Ctrl+C or other means.
#28939 - If command line ascp neglects to specify a destination host, then the failed transfer (error: "no remote host specified") gets recorded in SQLite with client_node_id NULL, instead of being populated with the uuid of the node. This database error causes an issue with Console.
#26281 - If you run approximately 100 (or a similarly high number) concurrent uploads to S3, intermittent transfer session failures can occur.
#26185 - During an upload to S3 storage, an error may result if ascp reports a successful file transfer before the transfer to S3 completes.
ascp4
ATT-717 - Persistent Ascp4 sessions do not report SSH errors (such as an invalid hostname, username, password, port, or file list) to management.
ATT-637 - As of 3.7.4, an empty folder is created on the destination even when the source
folder is excluded from the transfer (by using -E
/folder/pathname).
ATT-621 - As of 3.8.0, Ascp 4 is not backward compatible.
ATT-583 - Ascp 4 does not automatically create a destination folder when the source is a file list and the destination does not exist. Instead, it writes all the files in the file list into one file. (CIM-1198)
ATT-582 - Ascp 4 sessions run with -d and a file list do not report an error if the destination already exists and is not a folder. (CIM-1199)
ATT-545 - Ascp 4 downloads all content from an AWS S3 docroot, rather than the specified
content, if the docroot contains ?storage-class=REDUCED_REDUNDANCY.
ATT-515 - When ascp4 is used by the GUI and transfers are encrypted with AES-128, the GUI incorrectly shows that encryption is "none". (CIM-953)
ATT-477 - When files are transferred to a server with an S3 docroot and quickly
retransferred with the --delete-before-transfer enabled, some files are
deleted from the destination.
ATT-473 - Ascp 4 uploads to object storage that specify -k 1 (resume if
file sizes match) are also sensitive to checksum, such that if a file transfer is resumed
and the file has the same size but a different checksum then the entire file is
retransferred, rather than resumed from the last successful chunk.
ATT-451 - Ascp 4 does not respect exclude filters if the file path is specified in the command line.
ATT-438 - Ascp 4 downloads from object storage fail if the source filename contains special Unicode characters, such as Japanese font.
ATT-432 - [Linux Ubuntu] When downloading files from a server by using ascp4, if a docroot is configured for the transfer user and multiple source files are specified on the command line then only the first file is downloaded.
ATT-428 - During a persistent ascp4 session, when it a file transferred to a non-existent path and -d is used, the file transfers successfully and the destination path is created but the file is renamed to the last element of the destination path instead of being placed inside.
ATT-409 - If a file list contains an invalid path, no error is reported or logged.
aspera.session.upload.max-jobs to one larger than
the number of ascp4 threads. For
example,# Number of jobs allowed to run in parallel for uploads.
# Default is 15
aspera.session.upload.max-jobs=50ATT-191 - [Linux] Symbolic links are not updated on the destination when the symbolic
link option is follow (the default value when none is set) or
copy.
ATT-186 - An ascp4 multicast session does not fail if the multicast IP address and port is already in use on the receiver.
ATT-29 - Files that are transferred to S3 storage with ascp4 retain a .partial extension when viewed in the GUI.
ATT-2 (#32295) - The default minimum transfer rate set in aspera.conf is not respected.
ES-247 - Console-initiated ascp4 transfers fail if the docroot on the
source is a UNC path (for example, \\localhost\SHARE), returning the
error ERR Source base/path is not a valid directory/file (doesn't match any source
path). (CIM-397)
ES-151 - ascp4 does not recognize the UNC-path docroot of a Console transfer user. (CIM-197)
PRODUCT SUPPORT
For on-line support resources for Aspera products, including raising new support tickets, please visit the Aspera Support Portal. Note that you may have an existing account if you contacted the Aspera support team in the past. Before creating a new account, first try setting a password for the email that you use to interact with us. You may also call one of our regional support centers.