faspex Command Reference

Faspex Subcommands

The faspex command offers the following subcommands:
dropbox Show information about a dropbox.
get Download a package from a URL.
help View Help information for a command.
list List the contents of an inbox (Inbox, Sent, or Archived).
send Send a package.

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:

Option Definition
-a

--list-all

[Optional] Show info for all dropboxes.
-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 hostname or IP address of the Faspex server.
--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 dropbox_id

--list dropbox_id

[Optional] Show info for this dropbox only.

The dropbox_id is defined in the Faspex application.

-L path

--log-path path

[Optional] The path to the log file.
-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. For instructions, see Installing the Aspera CLI.

--source path The source server ID or name, as given in the .aspera_cli_conf configuration file.
-T port_number

--port port_number

[Optional] The listening port on the Faspex server.
--user username [Optional] The username of the Aspera transfer user.
-u username

--username username

The Faspex username.
-U url_prefix

--url-prefix url_prefix

[Optional] A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.

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:

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.
--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 [Optional] Specify a passphrase used to encrypt/decrypt files.
-E pattern

--exclude pattern

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

--file path

The file path to download to.
-H host

--host host

The hostname or IP address of the Faspex server.
--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 log file.
--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]

--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. For instructions, see Installing the Aspera CLI.

--rate-policy policy [Optional] Attempt to revise the rate policy (if server settings allow).
The options for policy are
  • fixed
  • high
  • fair
  • low
--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 Specify the source server ID or name, as given in the .aspera_cli_conf configuration file.
-T port_number

--port port_number

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

--username username

The Faspex username.
--url URL" The FASP URL from which to download.

To find the FASP URL for a package, use the list subcommand.

-U url_prefix

--url-prefix url_prefix

[Optional] A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.
-x proxy_hostOrIp

--proxy proxy_hostOrIp

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

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:

Option Definition
-a

--archived

[Optional] List archived packages.
-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 hostname or IP address of the Faspex server.
--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.
-n

--inbox

[Optional] List the packages in the inbox.
-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. For instructions, see Installing the Aspera CLI.

-s

--sent

[Optional] List sent packages.
--source Specify the source server ID or name, as given in the .aspera_cli_conf configuration file.
-T port_number

--port port_number

[Optional] The listening port on the Faspex server.
--user username [Optional] The username of the Aspera transfer user.
-u username

--username username

The Faspex username.
-U url_prefix

--url-prefix url_prefix

[Optional] A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.
-x

--xml

[Optional] 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.

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:

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.
--cc-on-download [Optional] Notify users when a package is downloaded. You can notify an email address, a Faspex username, or a dropbox.
--cc-on-upload [Optional] Notify users when a package is uploaded. You can notify an email address, a Faspex username, or a dropbox.
--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
-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.
-f path

--file path

The file to send. You can specify this option multiple times, to indicate multiple files.
--fasp-proxy proxy_hostOrIp [Optional] The hostname or IP address of the proxy computer (forward proxy).
--file-checksum [Optional] Set the hash function to calculate and record file hash values. This argument can take the following values:
  • none
  • sha1
  • sha-256
  • sha-384
  • sha-512
--file-encrypt [Optional] Encrypt files. To use this option, you must first set the ASPERA_SCP_FILEPASS environment variable with the encryption/decryption passphrase.
-H host

--host host

The hostname or IP address of the Faspex server.
-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.
--metadata metadata [Optional] Send metadata (JSON object text) with the package.
--move-after-transfer path [Optional] Specify the directory where the file will be moved to after it is transferred.
-n "body_text"

--note" body_text"

[Optional] A note for the body of the email message.
-O port_num

--udp-port port_num

[Optional] Set the UDP port for FASP transfers.
--partial-file-suffix [Optional] Set a partial file suffix to apply to filenames.
--preserve-dates [Optional] Preserve the timestamps on transferred files.
-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.
-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. For instructions, see Installing the Aspera CLI.

--port port_number [Optional] The listening port on the Faspex server.
-q

--filelist

[Optional] Specify a file that contains a list of files to transfer.
-r recipient

--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.
-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
--remove-empty-source-directory [Optional] When the transfer is complete, remove empty source directories.
--remote-host host_address [Optional] The remote host address.
--source Specify the source server ID or name, as given in the .aspera_cli_conf configuration file.

--source-id ID

[Optional] Send a file from a source ID (as defined in the Faspex application).
--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.
-t title_text

--title title_text

A title (subject line) for the email message.
--user username [Optional] The username of the Aspera transfer user.
-u username

--username username

The Faspex username.
-U url_prefix

--url-prefix url_prefix

[Optional] A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.
-Z datagram_size

--mtu datagram_size

[Optional] Set the MTU manually, in bytes.