faspex Command Reference

Faspex Subcommands

The faspex command offers the following subcommands:

browse	view the contents of a source directory
dropbox	show information about a dropbox
get	download a package
list	show information about an inbox
send	send a package

For examples of Faspex subcommands in use, see Faspex Examples

The browse Subcommand

Use the browse subcommand to browse a remote source that is defined in the .aspera_cli_conf file. The syntax for browse is as follows:

$ aspera faspex browse [args]

The arguments you give to the browse subcommand specify the remote source by source ID name, and the directory you want to browse. The output shows a list of the directories and files, in human-readable format. If you prefer to retrieve the output in JSON format for integration into your automation workflow, use the -j parameter.

-cnum --count=num	List only up to num items.
-j --json	Output raw JSON.
-ppath --path=path	The path to the source you want to view. This path is relative to the path you specified in .aspera_cli_conf.
-knum --skip=num	Skip the first num items.
-oorder --sort=order	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)
-sid/name --source=id/name	The ID or name of the source server (a matching ID takes precedence over a matching name), as defined in the .aspera_cli_conf configuration file.
-v --verbose	Show more verbose output, for debugging.
-bpath --base-ca-path=path	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/certs.

The dropbox Subcommand

Use the dropbox subcommand to show information about dropboxes. The syntax for dropbox is as follows:

$ aspera faspex dropbox [args]

Arguments for the dropbox subcommand:

-i ---insecure	Accept the certificate, even if it's invalid.
-j --json	Output raw JSON.
-ldropbox-id --list=dropbox-id	Show info for this dropbox only. The dropbox-id is defined in the Faspex application.
-a --list-all	Show info for all dropboxes.
-p[password] --password=[password]	The Faspex user password. If you specify -p but omit the password value, the system assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable.
-uusername --user=username	The Faspex username.
-v --verbose	Show more verbose output, for debugging.
-bpath --base-ca-path=path	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/certs.

The get Subcommand

Use the get subcommand to download a Faspex package. The syntax for get is as follows:

$ aspera faspex get [args]

Arguments for the get subcommand:

-f path ---file path	The file path to download to.
-i ---insecure	Accept the certificate, even if it's invalid.
--url="URL"	The FASP URL from which to download. To find the FASP URL for a package, use the list subcommand.
-p[password] --password=[password]	The Faspex user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable.
-uusername --user=username	The Faspex username.
-v --verbose	Show more verbose output, for debugging.
--target-rate newRate	Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps.
--min-rate newRate	Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps.
--rate-policy policy	Attempt to revise the rate policy (if server settings allow). The options for policy are fixed, high, fair, or low.
--cipher cipher	Attempt to set the encryption cipher (if server settings allow). The options for cipher are aes-128, aes-192, aes-256, and none.
-bpath --base-ca-path=path	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/certs.

The Faspex list Subcommand

Use the list subcommand to see the contents of a user's inbox. The syntax for list is as follows:

$ aspera faspex list [args]

Arguments for the list subcommand:

-a ---archived	List archived packages.
-n ---inbox	List the packages in the inbox.
-i ---insecure	Accept the certificate, even if it's invalid.
-p[password] --password=[password]	The Faspex user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable.
-s ---sent	List sent packages.
-uusername --user=username	The Faspex username.
-v --verbose	Show more verbose output, for debugging.
-x --xml	Get raw XML RSS atom for this inbox. Note: As the format returned with this option is XML, if you want to download a package referenced in a link tag, make sure that you un-escape the returned XML value in the href= attribute.
-bpath --base-ca-path=path	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/certs.

The send Subcommand

Use the send subcommand to send a Faspex package. The syntax for send is as follows:

$ aspera faspex send [args]

Arguments for the send subcommand:

-f path ---file path	The file to send. You can specify this option multiple times, to indicate multiple files.
-i ---insecure	Accept the certificate, even if it's invalid.
-m metadata ---metadata metadata	Send metadata (JSON object text) with the package.
-n "bodyText" ---note "bodyText"	A note for the body of the email message.
-p[password] --password=[password]	The Faspex user password. If you specify -p but omit the password value, the Aspera CLI assumes an empty string for this value. If you do not specify -p, the Aspera CLI prompts you for a non-echoing password. Alternatively, you can set the ASPERA_PASS environment variable.
-rrecipient --recipient=recipient	Recipient(s) of the package. You can specify this option multiple times, to indicate multiple recipients. The recipient can be a valid email address, a Faspex user account name, a Faspex dropbox name, or a workgroup.
-sID --source-id=ID	Send a file from a source ID (as defined in the Faspex application).
-ttitleText --title=titleText	A title (subject line) for the email message.
-uusername --user=username	The Faspex username.
-v --verbose	Show more verbose output, for debugging.
--target-rate newRate	Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps.
--min-rate newRate	Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps.
--rate-policy policy	Attempt to revise the rate policy (if server settings allow). The options for policy are fixed, high, fair, or low.
--cipher cipher	Attempt to set the encryption cipher (if server settings allow). The options for cipher are aes-128, aes-192, aes-256, and none.
-bpath --base-ca-path=path	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/certs.