node Command Reference
node Subcommands
Subcommand | Definition |
---|---|
browse | Browse files and directories. |
delete | Delete one or more files or directories. |
download | Download files or directories. |
help | View help for a specific command. |
rename | Rename a file or directory. |
upload | Upload files or directories. |
The browse Subcommand
$ aspera node browse [args]
Arguments for the browse subcommand:
Option | Definition |
---|---|
-bpath
--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. |
-cnum
--count=num |
[Optional] List only up to num items. |
-Hhost
--host=host |
The host name or IP address of the transfer server. |
-i
--insecure |
[Optional] Accept the certificate, even if it's invalid. |
-j
--json |
[Optional] Output raw JSON. |
-knum
--skip=num |
[Optional] Skip the first num items. |
-Lpath
--log-path=path |
[Optional] The path to the log file. |
-oorder
--sort=order |
[Optional] Sort by order. The options for order are as follows:
|
-ppassword
--password=password |
The user password.
Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-Ppath
--path=path |
[Optional] The remote path (the default is /). |
-Tport_number
--port=port_number |
[Optional] The listening port on the Aspera transfer server. |
-uusername
--username=username |
The username. |
The delete Subcommand
$ aspera node delete [args]
Arguments for the delete subcommand:
Option | Definition |
---|---|
-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/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. |
-Hhost
--host=host |
The host name or IP address of the Aspera transfer server. |
-i
--insecure |
Accept the certificate, even if it's invalid. |
-j
--json |
Output raw JSON. |
-Lpath
--log-path=path |
[Optional] The path to the log file. |
-ppassword
--password=password |
The user password.
Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-Ppath
--path=path |
The path to the remote file or directory to be deleted. |
-Tport_number
--port=port_number |
The listening port on the Aspera transfer server. |
-uusername
--username=username |
The username. |
The download Subcommand
$ aspera node download [args]
Arguments for the download subcommand:
Option | Definition |
---|---|
-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/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. |
-ccookie_string
--cookie=cookie_string |
Cookie, if one is required. |
--cipher cipher | Attempt to set the encryption cipher (if server settings allow).
cipher can have the following values:
|
--content-protect-password=password | Specify the passphrase that is used to encrypt/decrypt files on the server. |
-dpath
--destination=path |
Destination directory path (the default is ./). |
-e
--remove-empty-directories |
When the transfer is complete, remove empty directories. |
-Epattern
--exclude=pattern |
Exclude files that match the given pattern. To specify multiple patterns, repeat the -E option. |
--file-decrypt | If the passphrase given is correct, decrypt files as they are received. |
-Hhost
--host=host |
The host name or IP address of the Aspera transfer server. |
-i
--insecure |
Accept the certificate, even if it's invalid. |
-j
--json |
Output raw JSON. |
-Lpath
--log-path=path |
[Optional] The path to the log file. |
--min-rate=new_rate | Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps. |
-ooverwrite_method
--overwrite=overwrite_method |
Overwrite existing files. overwrite_method can be any of the following values:
|
-ppassword
--password=password |
The user password.
Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
--preserve-dates | [Optional] Preserve the timestamps on transferred files. |
-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
|
-spath
--source=path |
File path to the source of the content you are downloading. |
--save-before-overwrite | If an existing file will be overwritten, rename it. |
-Tport_number
--port=port_number |
The listening port on the Aspera transfer server. |
--target-rate=newRate | Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps. |
-uusername
--username=username |
The username. |
-xproxy_hostOrIp
--proxy=proxy_hostOrIp |
The hostname or IP address of the proxy computer (forward proxy). |
The rename Subcommand
$ aspera node rename [args]
Arguments for the rename subcommand:
Option | Definition |
---|---|
-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/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. |
-dpath
--destination=path |
The new name for the file or directory. |
-Hhost
--host=host |
The host name or IP address of your transfer server. |
-i
--insecure |
Accept the certificate, even if it's invalid. |
-j
--json |
Output raw JSON. |
-Lpath
--log-path=path |
[Optional] The path to the log file. |
-ppassword
--password=password |
The user password.
Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-Ppath
--path=path |
The remote path to the content you are renaming (the default is ./). |
-spath
--source=path |
The remote file or directory you are renaming. |
-Tport_number
--port=port_number |
The listening port on the Aspera transfer server. |
-uusername
--username=username |
The username. |
The upload Subcommand
$ aspera node upload [args]
Arguments for the upload subcommand:
Option | Definition |
---|---|
-bpath
--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. |
-ccookie_string
--cookie=cookie_string |
[Optional] Cookie, if one is required. |
--cipher=cipher | [Optional] Attempt to set the encryption cipher (if server settings allow).
cipher can have the following values:
|
-dpath
--destination=path |
Destination directory path. |
-e
--remove-empty-directories |
[Optional] When the transfer is complete, remove empty directories. |
-Epattern
--exclude=pattern |
[Optional] Exclude files that match the given pattern. To specify multiple patterns, repeat the -E option. |
--fasp-proxy=proxy_hostOrIp | [Optional] The hostname or IP address of the proxy computer (forward proxy). |
--file-checksum=hash | [Optional] Enable checksum reporting for transferred files. hash is
the type of checksum to calculate:
|
--file-encrypt | [Optional] Encrypt files. To use this option, you must first set the ASPERA_SCP_FILEPASS environment variable with the encryption/decryption passphrase. |
-Hhost
--host=host |
The host name. |
-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. |
-kresume_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:
|
-lnew_rate
--target-rate=new_rate |
[Optional] Attempt to revise the target rate (if server settings allow) to a new throughput value, in kbps. |
-Lpath
--log-path=path |
[Optional] The path to the logfile. |
-mnew_rate
--min-rate=new_rate |
[Optional] Attempt to revise the minimum rate (if server settings allow) to a new throughput value, in kbps. |
--move-after-transfer=path | [Optional] Specify the directory where the file will be moved to after it is transferred. |
-ooverwrite_method
--overwrite=overwrite_method |
[Optional] Overwrite existing files. overwrite_method can be any of the
following values:
|
-Oport_num
--udp-port=port_num |
[Optional] Set the UDP port for FASP transfers. |
-ppassword
--password=password |
The user password.
Alternatively, you can set the ASPERA_PASS environment variable. For instructions, see Installing the Aspera CLI. |
-Pport_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. |
--port=port_number | [Optional] The listening port on the Aspera transfer server. |
--preserve-dates | [Optional] Preserve the timestamps on transferred files. |
-q
--filelist |
[Optional] Specify a file that contains a list of files to transfer. |
-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
|
--remote-host=host_address | [Optional] The remote host address. |
--remove-empty-source-directory | [Optional] When the transfer is complete, remove empty source directories. |
-spath
--source=path |
File path to the content you are uploading. |
--save-before-overwrite | [Optional] Save a copy of a file before it is overwritten by the transfer. |
--source-prefix=path | A path to be prepended to each source path. |
--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. |
-uusername
--username=username |
The username. |
--user=username | [Optional] The username of the Aspera transfer user. |
-Zdatagram_size
--mtu=datagram_size |
[Optional] Set the MTU manually, in bytes. |