Interface TransferSpec

The type of authentication to use.

The algorithm used to encrypt data sent during a transfer.

Enable content protection (encryption-at-rest). For uploads, set to encrypt to transfer files and store them on the server with the extension “.aspera-env”. To download and decrypt encrypted files, set to decrypt. content_protection_password must be specified if this option is set.

Password to encrypt or decrypt files when using content_protection.

Data to associate with the transfer. The cookie is reported to both client and server-side applications monitoring transfers. It is often used by applications to identify associated transfers.

Creates the destination directory if it does not already exist. When enabling this option, the destination path is assumed to be a directory path.

Before transfer, delete files that exist at the destination but not at the source. The source and destination arguments must be directories that have matching names. Objects on the destination that have the same name but different type or size as objects on the source are not deleted.

Delete the source directory after the assets are transferred

The transfer destination file path. If destinations are specified in paths, this value is prepended to each destination. Note that the download destination paths are relative to the user's Aspera SDK download directory setting.

Root ID at the destination

Directon of transfer, whether send (upload) or receive (download)

Exclude files (but not directories) that are newer than a specific time from the transfer, based on when the file was last modified. Express in ISO 8601 format (for exanple, 2006-01-02T15:04:05Z) or as number of seconds elapsed since 00:00:00 UTC on 1 January 1970.

Exclude files (but not directories) that are older than a specific time from the transfer, based on when the file was last modified. Express in ISO 8601 format (for exanple, 2006-01-02T15:04:05Z) or as number of seconds elapsed since 00:00:00 UTC on 1 January 1970.

The UDP port for the transfer. The default value is satisfactory for most situations. However, it can be changed to satisfy firewall requirements.

Proxy for communications between the remote server and the (local) client

Attempts to perform an HTTP transfer if a fasp™ transfer cannot be performed.

Port used for HTTP fallback server

Port used for HTTPS fallback server

If true, lock the minimum transfer rate to the value set for min_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

If true, lock the rate policy to the default value

If true, lock the target transfer rate to the default value set for target_rate_kbps. If false, users can adjust the transfer rate up to the value set for target_rate_cap_kbps.

Moves source files to directory after they are transferred correctly

Split files across multiple ascp sessions to enable faster transfers.

Split files across multiple ascp sessions if their size is greater than or equal to the specified value.

Overwrite destination files with the source files of the same name.

• none - Never overwrite the file. However, if the parent folder is not empty, its access, modify, and change times may still be updated.
• always - Always overwrite the file. The destination file will be overwritten even if it is identical to the source.
• diff - Overwrite the file if it is different from the source, depending on the resume_policy property.
• older - Overwrite the file if its timestamp is older than the source timestamp.
• diff+older - Overwrite the file if it is older and different than the source, depending on the resume_policy property.

If the overwrite_policy is diff or diff+older, difference is determined by resume_policy. If resume_policy is empty or none is specified, the source and destination files are always considered different and the destination file is always overwritten. If resume_policy is attributes, the source and destination files are compared based on file attributes (currently file size). If sparse_checksum, the source and destination files are compared based on sparse checksum. If full_checksum, the source and destination files are compared based on full checksum.

A list of the file and directory paths to transfer. Use destination_root to specify the destination directory. It is recommended to always specify both the source and destination properties for each path.

Calculate total size before transfer

Preserve the time the file was last accessed (read or write access) on the source.

Preserve timestamp for when a file is created

Preserve the time the object was last modified (write access) on the source.

Preserve file timestamps

The congestion control behavior to use when sharing bandwidth.

• fixed - Transfer at the target rate regardless of actual network capacity. Do not share bandwidth. Not recommended.
• high - When sharing bandwidth, transfer at twice the rate of a transfer using "fair" policy.
• fair - Share bandwidth equally with other traffic.
• low - Use only unutilized bandwidth.

Access key for the remote server

The fully qualified domain name or IP address of the transfer server.

Password for the remote user

Remote user’s username

Remove files at the source of the transfer after the transfer completes successfully

Remove empty subdirectories at the source of the transfer

Remove empty source subdirectories and remove the source directory itself, if empty

If a transfer is interrupted or fails to finish, this policy directs the transfer to resume without retransferring the files.

• none – always re-transfer the entire file.
• attributes – compare file attributes and resume if they match, and re-transfer if they do not.
• sparse_checksum – compare file attributes and the sparse file checksums; resume if they match, and re-transfer if they do not.
• full_checksum – compare file attributes and the full file checksums; resume if they match, and re-transfer if they do not.

Total time committed to retrying the transfer

Rename the file instead of overwriting it. resume_policy must be set to none for this to take effect.

Don’t check for duplicate files at the destination.

All assets other than files, directories and symbolic links are considered special. A transfer will fail if the user attempts to transfer special assets. If true, ascp skips special assets and proceeds with the transfer of all other assets.

A path to prepend to the source paths specified in paths. If this is not specified, then paths should contain absolute paths.

The folder name below which the directory structure is preserved (base64 encoded)

TCP port that initiates the transfer session

Private key for SSH

Private key passphrase for SSH

The method for processing symbolic links.

Tags to include in the transfer

Tags to include in the transfer (base64 encoded)

Maximum target rate for incoming transfers, in kilobits per second.

Ideal transfer rate, in kilobits per second. There is no default value.

Title of the transfer

Used for token-based authorization, which involves the server-side application generating a token that gives the client rights to transfer a predetermined set of files.

Use ascp4 as the transfer engine.