Columns:
Req/Def : Required or default value (- means emty)
Fields with EX_ prefix are specific extensions to local mode.
arg: related ascp argument or env var suffix (PASS for ASPERA_SCP_PASS)
UNDER CONSTRUCTION
Documentation→Node API→/opt/transfers
Field | Req/Def | Type | F | N | C | arg | Description |
---|---|---|---|---|---|---|---|
direction | Required | string | Y | Y | Y | --mode | Direction: "send" or "receive" |
remote_host | Required | string | Y | Y | Y | --host | IP or fully qualified domain name of the remote server |
remote_user | Required | string | Y | Y | Y | --user | Remote user. Default value is "xfer" on node or connect. |
destination_root | Required | string | Y | Y | Y | last arg | Destination root directory. |
title | - | string | N | Y | Y | - | Title of the transfer |
tags | - | hash | Y | Y | Y | --tags --tags64 | Metadata for transfer |
token | - | string | Y | Y | Y | TOKEN -W | Authorization token: Bearer, Basic or ATM |
cookie | - | string | Y | Y | Y | COOKIE | Metadata for transfer (older,string) |
remote_access_key | TODO | string | ? | Node only? | |||
source_root | - | string | --source-prefix --source-prefix64 | Source root directory.(TODO: verify option) | |||
fasp_port | 33001 | integer | Y | Y | Y | -O | Specifies fasp (UDP) port. |
ssh_port | 22 or 33001 | integer | Y | Y | Y | -P | Specifies ssh (TCP) port. |
rate_policy | server config | string | Y | Y | Y | --policy | Valid literals include "low","fair","high" and "fixed". |
symlink_policy | follow | string | Y | Y | Y | --symbolic-links | copy, follow, copy+force, skip. Default is follow. Handle source side symbolic links by following the link (follow), copying the link itself (copy), skipping (skip), or forcibly copying the link itself (copy+force). |
target_rate_kbps | - | integer | Y | Y | Y | -l | Specifies desired speed for the transfer. |
min_rate_kbps | 0 | integer | Y | Y | Y | -m | Set the minimum transfer rate in kilobits per second. |
cipher | none | string | Y | Y | Y | -c | in transit encryption type. none, aes-128, aes-256 |
content_protection | encrypt decrypt | string | --file-crypt= | encryption at rest | |||
content_protection_password | - | string | PASS | Specifies a string password. | |||
overwrite | diff | string | Y | Y | Y | --overwrite | Overwrite destination files with the source files of the same name. never, always, diff, older, or diff+older |
retry_duration | string | TODO | Specifies how long to wait before retrying transfer. (e.g. "5min") | ||||
http_fallback | bool (node), integer | -y TODO | When true(1), attempts to perform an HTTP transfer if a fasp transfer cannot be performed. | ||||
create_dir | boolean | Y | Y | Y | -d | Specifies whether to create new directories. | |
precalculate_job_size | srv. def. | boolean | Y | Y | Y | --precalculate-job-size | Specifies whether to precalculate the job size. |
delete_source | boolean | Y | ? | ? | |||
remove_after_transfer | boolean | Y | ? | Specifies whether to remove file after transfer. | |||
remove_empty_directories | boolean | Y | ? | Specifies whether to remove empty directories. | |||
multi_session | 1 | integer | N | Y | N | -C | Specifies how many parts the transfer is in. |
multi_session_threshold | null | integer | N | Y | N | - | in bytes |
exclude_newer_than | integer | Y | --exclude-newer-than | - | |||
exclude_older_than | integer | Y | --exclude-older-than | - | |||
preserve_acls | string | Y | --preserve-acls | - | |||
dgram_size | integer | Y | -Z | in bytes | |||
compression | integer | ascp4 only, 0 / 1? | |||||
read_threads | integer | - | ascp4 only | ||||
write_threads | integer | - | ascp4 only | ||||
use_ascp4 | false | boolean | Y | - | specify version of protocol | ||
paths | source files (dest) | array | positional --file-list --file-pair-list | Contains a path to the source (required) and a path to the destination. | |||
http_fallback_port | integer | Y | -t | Specifies http port. | |||
https_fallback_port | integer | todo | Specifies https port. | ||||
cipher_allowed | string | - | returned by node API. Valid literals include "aes-128" and "none". | ||||
target_rate_cap_kbps | N | ? | ? | - | Returned by upload/download_setup node api. | ||
rate_policy_allowed | - | returned by node API. Specifies most aggressive rate policy that is allowed. Valid literals include "low", "fair","high" and "fixed". | |||||
ssh_private_key | - | string | Y | N | N | KEY | Private key used for SSH authentication, Shall look like: `-----BEGIN RSA PRIVATE KEY-----\nMII` Note the JSON encoding `\` + `n` for newlines. |
remote_password | - | string | Y | Y | Y | PASS | SSH session password |
resume_policy | faspmgr: none other: sparse_csum | string | Y | Y | Y | -k | none,attrs,sparse_csum,full_csum |
authentication | - | N | N | Y | - | token: Aspera web keys are provided to allow transparent web based session initiation. on connect: password is not asked. Else, password is asked, and keys are not provided. | |
EX_ssh_key_paths | - | array | Y | N | N | -i | Use public key authentication and specify the private key file |
EX_at_rest_password | - | string | Y | N | N | FILEPASS | Passphrase used for at rest encryption or decryption |
EX_proxy_password | - | string | Y | N | N | PROXY_PASS | TODO |
EX_fasp_proxy_url | - | string | Y | N | N | --proxy | Specify the address of the Aspera high-speed proxy server |
EX_http_proxy_url | - | string | Y | N | N | -x | Specify the proxy server address used by HTTP Fallback |
EX_ascp_args | - | array | Y | N | N | same | Add command line arguments to ascp |
EX_http_transfer_jpeg | 0 | integer | Y | N | N | -j | HTTP transfers as JPEG file |
EX_license_text | - | string | Y | N | N | LICENSE | license file text |
EX_file_list | - | string | Y | N | N | --file-list | source file list |
EX_file_pair_list | - | string | Y | N | N | --file-pair-list | source file pair list |
EX_multi_session_part | - | string | Y | N | N | -C | part for multisession |
EX_no_read | - | - | Y | N | N | --no-read | no read source |
EX_no_write | - | - | Y | N | N | --no-write | no write estination |