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.

Option Definition
-b path

--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/etc.
-c num

--count=num

 List only up to num items.
-i

--insecure

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

--json

 Output raw JSON.
-k num

--skip=num

 Skip the first num items.
-o order

--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)
-p path

--path=path

 The path to the source you want to view. This path is relative to the path you specified in .aspera_cli_conf.
-s id_or_name

--source=id_or_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.

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

 Show info for all dropboxes.
-b path

--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/etc.
-H host

--host=host

 The hostname or IP address of the Faspex server.
-i

--insecure

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

--json

 Output raw JSON.
-l dropbox_id

--list=dropbox_id

 Show info for this dropbox only.

The dropbox_id is defined in the Faspex application.
-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.
-T port_number

--port=port_number

 The listening port on the Faspex server.
--user=username The username of the Aspera transfer user.
--username=username The Faspex username.
-U url_prefix

--url-prefix=url_prefix

 A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.
-v

--verbose

 Show more verbose output, for debugging.

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.
--cipher=cipher Attempt to set the encryption cipher (if server settings allow).
cipher can have the following values:
  • aes-128
  • aes-192
  • aes-256
  • none
-E pattern

--exclude=pattern

 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.
-i

--insecure

 Accept the certificate, even if it's invalid.
--min-rate=new_rate Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps.
-o overwrite_method

--overwrite=overwrite_method

 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 Attempt to revise the rate policy (if server settings allow).
The options for policy are
  • fixed
  • high
  • fair
  • low
-T port_number

--port=port_number

 The listening port on the Faspex server.
--target-rate=new_rate Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps.
--user=username 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

 A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.
-v

--verbose

 Show more verbose output, for debugging.
-x proxy_hostOrIp

--proxy=proxy_hostOrIp

 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

 List archived packages.
-b path

--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/etc.
-H host

--host=host

 The hostname or IP address of the Faspex server.
-i

--insecure

 Accept the certificate, even if it's invalid.
-n

--inbox

 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

 List sent packages.
-T port_number

--port=port_number

 The listening port on the Faspex server.
--user=username The username of the Aspera transfer user.
-u username

--username=username

 The Faspex username.
-U url_prefix

--url-prefix=url_prefix

 A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.
-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.

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

 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.
--cipher=cipher Attempt to set the encryption cipher (if server settings allow).
cipher can have the following values:
  • aes-128
  • aes-192
  • aes-256
  • none
-e

--remove-empty-directories

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

--exclude=pattern

 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 The hostname or IP address of the proxy computer (forward proxy).
--file-encrypt 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 hostname or IP address of the Faspex server.
-i

--insecure

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

--encode-jpeg

 Encode all HTTP transfers as JPEG files.
-k resume_level

--resume-level=resume_level

 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

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

--log-path=path

 The path to the logfile.
-m new_rate

--min-rate=new_rate

 Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps.
--metadata=metadata Send metadata (JSON object text) with the package.
--move-after-transfer=path Specify the directory where the file will be moved to after it is transferred.
-n "body_text"

--note="body_text"

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

--udp-port=port_num

 Set the UDP port for FASP transfers.
--preserve-dates Preserve the timestamps on transferred files.
-P port_num

--tcp-port=port_num

 Set the TCP port for FASP transfers.
--partial-file-suffix=suffix 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 The listening port on the Faspex server.
-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

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

--source-id=ID

 Send a file from a source ID (as defined in the Faspex application).
--save-before-overwrite 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.
--src-base=prefix Strip the specified prefix from each source path. The remaining portion of the source path is kept intact at the destination.
-T

--disable-encryption

 Disable encryption.
-t title_text

--title=title_text

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

--username=username

 The Faspex username.
-U url_prefix

--url-prefix=url_prefix

 A prefix to the Faspex URL. The default prefix string is /aspera/faspex/.
-v

--verbose

 Show more verbose output, for debugging.
-Z datagram_size

--mtu=datagram_size

 Set the MTU manually, in bytes.