aspera: The Command-Line Transfer Client |
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
# 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.
-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/certs. |
-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:
|
-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. |
# aspera faspex dropbox [args]
Arguments for the dropbox subcommand:
-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/certs. |
-H hostname
--host=hostname |
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. |
-u username
--user=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. |
# aspera faspex get [args]
Arguments for the get subcommand:
-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/certs. |
--cipher=cipher | Attempt to set the encryption cipher (if server settings allow). cipher
can have the following values:
|
--content-protect-password=password | Specify the password that is used to encrypt/decrypt files on the server. |
-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 hostname
--host=hostname |
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:
|
-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
|
-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. |
-u username
--user=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). |
# aspera faspex list [args]
Arguments for the list subcommand:
-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/certs. |
-H hostname
--host=hostname |
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. |
-u username
--user=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.
|
# aspera faspex send [args]
Arguments for the send subcommand:
-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/certs. |
--cipher=cipher | Attempt to set the encryption cipher (if server settings allow). cipher
can have the following values:
|
--content-protect-password=password | Specify the password that is used to encrypt/decrypt files on the server. |
-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. |
-H hostname
--host=hostname |
The hostname or IP address of the Faspex server. |
-i
---insecure |
Accept the certificate, even if it's invalid. |
-m
metadata
---metadata=metadata |
Send metadata (JSON object text) with the package. |
--min-rate=newRate | Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps. |
-n "body_text"
---note="body_text" |
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. For instructions, see Installing the Aspera CLI. |
-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
|
-s ID
--source-id=ID |
Send a file from a source ID (as defined in the Faspex application). |
-t
title_text
--title=title_text |
A title (subject line) for the email message. |
-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. |
-u username
--user=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 proxy_hostOrIp
--proxy=proxy_hostOrIp |
The hostname or IP address of the proxy computer (forward proxy). |