The data types that are described in this section are used in the XML order description format for Aspera.IScpTransfer Job Types.

Job Order Description (Parameters)

Version The current version is 2.  string
Agent Identifies the agent responsible for submitting the job. Aspera recommends the format Company.Application, for example, Aspera.AsperaConnect.  string
NoMgmtPortFiles

boolean

Possible values: {'Yes'|'No'}.

Default: No

Used to disable reporting (since 3.8.1). Note: If you submit a transfer with this parameter set to Yes, the transfer is not retried.

Operation Specifies the transfer operation to perform, i.e. download or upload. When set to Pull, files will be downloaded from the remote location to the local location. When set to Push, files will be uploaded from the local location to the remote location.

string

Possible values: {'Pull', 'Push'}

Program

string

Allows you to specify the transfer executable - ascp or ascp4 (since 3.7.4)

ApplicationData Application-level data that will be carried by a fasp session
 
Cookie An arbitrary field used for application-specific requirements. This field can be used as a placeholder for a unique reference. The difference with PrivateData Key is that the Cookie is known to both the local (Client) and the remote (Server), while the PrivateData Key is known to the local (Client). string
Token This field is used for token-based authorization string

 

RemoteLocation Identifies the remote endpoint and file locations involved in the transfer
 
System Identifies a system on the network
 
Address IP address or host name of the system string
Port SSH port over which the transfer will be initiated

unsignedShort

Default 22

UserName A user name used to authenticate on the system string
Password A password used to authenticate on the system string
Authentication Specifies the parameters used to authenticate on the remote system. When using SSH key authentication, make sure that the key file on the node is not a shared key. On the node computer, the key file should be a "private" key in the specified user account.
 
Methods SSH methods to use for authentication
 
Method Specifies the authentication mechanism. A single or up to 3 instances of the Method elements can be nested in the Methods element.

Possible values: {'Public Key'|'Password'|'Token'}

KeyPath The path to SSH key if Public key authentication method is used
KeyPassphrase A string denoting the passphrase for the key
Files Paths to the transfer contents on the remote host
 
Path A transfer file path. For user name with document root path configured, the path must expressed relative to the user document root path.
A single or many instances of the Path elements can be nested in the Files element.
string

 

 

RootPath Path prefix (since version 3.3) - string
Proxy If this parameter is defined, the transfer will use fasp-proxy. Specifies the Destination Network Address Translation (DNAT or secure DNAT) parameters to use a fasp-proxy for the transfer: user name, password and proxy URL.
 
Url string. Specifies the address of the Aspera high-speed proxy server in the form of: dnat(s)://[user[:password]@]server[:port]. Default ports for DNAT and DNATS protocols are 9091 and 9092. 
User Not needed if the Url element contains the user name - string
Password Not needed if the Url element contains the password - string
HttpFallback This parameter defines HTTP fallback support for the transfer (since 3.5.4).
 
Allow

Possible values: {'Yes'|'No'}

Default: No

KeyFile string.
CertificateFile string.
Port unsignedShort
ProxyAdress string

 

LocalLocation Identifies local file paths involved in the transfer
 
System Identifies a user in the local system on the network (optional)
 
UserName A user name used to authenticate on the system string
Password A password used to authenticate on the system (optional) string
Files Paths to the transfer contents on the local host
 
Path A transfer file path. For user name with document root path configured, the path must expressed relative to the user document root path.
A single or many instances of the Path elements can be nested in the Files element.
string

 

 

RootPath Path prefix (since version 3.3) - string

 

FileParameters Specifies file-related parameters pertaining to the transfer
 
CreatePath Specifies whether or not destination directories should be created if they don't exist.

Possible values: {'Yes'|'No'}

Default: No

ResumeCheck Specifies the mechanism to use when resuming partially transferred files

Possible values: {'None'|'Attributes'|'Sparse Checksum'|'Full Checksum'}

Default: Sparse Checksum

ManifestPolicy Manifest policy. Declares whether manifest files should be generated or not for transfers.

Possible values: {'None'|'Text'}

Default: None

ManifestPath Manifest file path. If this property is set, while the ManifestPolicy is not explicitly defined, the system infers that the value of the ManifestPolicy property is "Text", and will generate manifest files. string
ManifestInprogressSuffix Manifest file path suffix when the manifest is still in progress (since 3.5.4) string
Protection Specifies if encryption at rest will be applied to the transfer. A passphrase will be set to secure the process.

Possible values: {'None'|'Encrypt'|'Decrypt'}

Default: None

Passphrase A passphrase to use for encryption at rest string
PreCalculateJobSize Specifies whether the aggregate size of all files in the job is to be calculated before starting the transfer

Possible values: {'Yes'|'No'}.

Default: No

RemoveAfterTransfer Specifies whether the source files are deleted after the transfer. All folders in the source path will still remain. Also refer to RemoveEmptyDirectories.

Possible values: {'Yes'|'No'}.

Default: No

RemoveEmptyDirectories Specifies whether empty directories in the source path are deleted after the transfer

Possible values: {'Yes'|'No'}.

Default: No

RemoveEmptySourceDirectory (since 3.6.1).

Possible values: {'Yes'|'No'}.

Default: No

SymbolicLinks Specifies symbolic links are handled during the transfer

Possible values: {'Follow'|'Copy'|'Skip'|'Copy+Force'}

Default: Follow

PreserveTimestamps Specifies whether source timestamps are preserved at the destination

Possible values: {'Yes'|'No'}.

Default: No

PreserveModificationTime Specifies whether modification timestamps are preserved (since version 3.5.4)

Possible values: {'Yes'|'No'}.

Default: No

PreserveAccessTime Specifies whether access timestamps are preserved (since version 3.5.4)

Possible values: {'Yes'|'No'}.

Default: No

PreserveCreationTime Specifies whether creation timestamps are preserved (since version 3.5.4)

Possible values: {'Yes'|'No'}.

Default: No

PreserveSourceAccessTime Specifies whether source access timestamps are preserved at the destination (since version 3.5.4)

Possible values: {'Yes'|'No'}.

Default: No

PreserveUID Specifies whether UIDs are preserved (since version 3.5.4)

Possible values: {'Yes'|'No'}.

Default: No

PreserveGID Specifies whether GIDs are preserved (since version 3.5.4)

Possible values: {'Yes'|'No'}

Default: No

ReadBlockSize Specifies the read block size, in bytes unsignedInt
WriteBlockSize Specifies the write block size, in bytes unsignedInt
Overwrite Specifies the transfer behavior if a content to transfer already exists at destination

Possible values: {'Always'|'Never'|'Diff'|'Older'|'DiffAndOlder'}

Default: Diff

Exclude Specifies path exclusion patterns. Paths that match excluded patterns are not transferred
Pattern Exclusion pattern. A single or up to 16 instances of the Pattern elements can be nested in the Exclude element. string
Include Specifies path inclusion patterns. Paths that match included patterns are transferred. (since 3.6.1)
Pattern Inclusion pattern. A single or up to 16 instances of the Pattern elements can be nested in the Include element.

Several Rules (Include/Exclude blocks) can be specified. Rules are applied in the order that they are encountered, and the first matching rule (whether including or excluding) takes precedence.

For example: apply rules V, W, X, Y, Z, in that order.
<Include><Pattern>V</Pattern></Include> <Exclude><Pattern>W</Pattern><Pattern>X</Pattern><Pattern>Y</Pattern></Exclude> <Include><Pattern>Z</Pattern></Include>

string
DeleteBeforeTransfer (since version 3.7.0).

Possible values: {'Yes'|'No'}

Default: No

SourceBase If this option is utilized, ascp will strip the source base path, while preserving the rest of the directory structure. For example, consider the "clips" directory with a file: /clips/outgoing/file1 and we want to transfer file1 within the "outgoing" folder (but not the "outgoing" folder, itself). By setting SourceBase element to /clips/outgoing/, the transferred file will appear in the destination directory as (docroot)/file1. string
PartialFileSuffix A suffix for partial files (since 3.5.4) string
ExcludeOlderThan A time in seconds since epoch. Excludes from the transfer files older than the specifed time, based on when the file was last changed (since 3.5.4) string
ExcludeNewerThan A time in seconds since epoch. Excludes from the transfer files newer than the specifed time, based on when the file was last changed (since 3.5.4) string
SaveBeforeOverwrite If Partialfilesuffix and SaveBeforeOverwrite are defined, the suffix defined in SaveBeforeOverwrite is used (since 3.5.4). string
FileChecksum Checksum algorithm (since 3.5.4)

Possible values: {'MD5'|'SHA1'|'None'}

Default: None

SkipSpecialFiles (since version 3.5.4).

Possible values: {'Yes'|'No'}

Default: No

MoveAfterTransfer Defines an archive directory, where to move source files after transfer success (since 3.5.5) string
Compression Compression algorithm. If not specified, no compression is applied. (since 3.6.0)

Possible values: {'None'|'qlz'|'zlib'|'lz4'}

Default: None

SparseFile Defines sparse file support (since 3.6.0)

Possible values: {'Yes'|'No'}

Default: No

Tags (since 3.6.0). string in a JSON format

 

 
LinkParameters
Specifies link-related parameters pertaining to the transfer.

Link capacity can be detected automatically by using <AutoDetectCapacity> property.

Link capacity can also be set manually by using <RemoteCapacity> and or <LocalCapacity>:

  • If <RemoteCapacity> is not defined, <LocalCapacity> is used as the link capacity.
  • <RemoteCapacity> is used as link capacity when its defined value is less than the value of <LocalCapacity>.
  • If none of <RemoteCapacity> and <LocalCapacity> is defined, the bandwidth cap will limit the transfer rates.
     
 
RemoteCapacity   unsignedInt
LocalCapacity   unsignedInt
AutoDetectCapacity Indicates whether or not fasp should automatically detect the link capacity during transfer. Performing automatic detection allows rates to be set at a percentage of the measured value. When automatic bandwidth discovery is enabled (<AutoDetectCapacity> set to Yes) and the rates expressed as percentage (<MinimumRateAsPercent> or <TargetRateAsPercent> set to Yes), then the rates will be a percentage of the measured bandwidth. Otherwise, rates must be specified in Kbps.

Possible values: {'Yes'|'No'}

Default: No

 

RateParameters Specifies rate-related parameters pertaining to the transfer.
 
Policy Specifies the rate policy the transfer should utilize.

Possible values: {'Fixed'|'Fair'|'Trickle'}

TargetRate The target rate of data transmission, in Kbps or %. If <TargetRateAsPercent> is set to Yes, this value will be interpreted as a percentage and should be set to values between 0 and 100, inclusive. The target rate cannot exceed the link capacity and the <BandwidthCap>.

unsignedInt

TargetRateAsPercent Indicates whether or not the value of <TargetRate> should be interpreted as a percentage (of the link capacity, see <LinkParameters> or the measured bandwidth). When automatic bandwidth discovery is enabled (<AutoDetectCapacity> set to Yes) and the rate as percentage is enabled (<TargetRateAsPercent> set to Yes), then the target rate will be a percentage of the measured bandwidth.

Possible values: {'Yes'|'No'}

Default: No

MinimumRate The minimum rate of data transmission, in Kbps or %. If <MinimumRateAsPercent> is set to Yes, this value will be interpreted as a percentage and should be set to values between 0 and 100, inclusive. The minimum rate cannot exceed the target rate, the link capacity and the <BandwidthCap>.

unsignedInt

MinimumRateAsPercent Indicates whether or not the value of <MinimumRate> should be interpreted as a percentage (of the link capacity, see <LinkParameters> or the measured bandwidth). When automatic bandwidth discovery is enabled (<AutoDetectCapacity> set to Yes) and the rate as percentage is enabled (<MinimumRateAsPercent> set to Yes), then the minimum rate will be a percentage of the measured bandwidth.

Possible values: {'Yes'|'No'}

Default: No

BandwidthCap A cap on data transfer rates, in Kbps. A value of 10,000,000 indicates that no bandwidth cap will be applied.

unsignedInt

Default: 10000000

Priority Priority when sharing virtual bandwidth cap. 1 for higher priority, 2 for regular.

unsignedInt

Possible values: {1, 2}

Default: 2

 

ChannelParameters Specifies channel-related parameters pertaining to the transfer.
 
Port UDP port over which data will be transported.

unsignedShort

Default: 33001

DatagramSize The datagram size fasp will use when transmitting data. If this property is set, while the <AutoDetectPathMTU> is not explicitly defined, the system infers that the value of the <AutoDetectPathMTU> property is "No", and uses the datagram size value provided in this element.

unsignedInt

Default: 1492

AutoDetectPathMTU Indicates whether or not fasp should automatically detect the path MTU (maximum transmission unit).

Possible values: {'Yes'|'No'}

Default: Yes

IPV6 (since version 3.5.4)

Possible values: {'Yes'|'No'}

Default: No

 

SecurityParameters

Specifies security-related parameters pertaining to the transfer.
 
EncryptionCipher Specifies the encryption cipher used to encrypt data during transfer.

Possible values: {'None'|'AES-128'}

Default: None

SSHFingerprint (since version 3.5.4) string

 

RetryParameters Specifies retry-related parameters pertaining to the transfer. Retry parameters in user preferences will be applied if this element is not defined.
 
Count Number of transfer attempts. Default is 3. unsignedInt
BaseInterval Base time interval, in seconds. The base time interval specifies the base time that will elapse between a failed transfer and a retry attempt. After each subsequent failure, the time interval will be doubled, up to the maximum value as specified by <MaximumInterval>. Setting <BaseInterval> and <MaximumInterval> to the same value, effectively indicates a constant time interval between retry attempts. Default is 1 second. unsignedInt
MaximumInterval Maximum time interval, in seconds. The maximum time interval limits the increasing of the time interval that occurs as a result of multiple, subsequent failures. unsignedInt

 

 

PrivateData Application defined private data. This field can be used by a client application as a placeholder for a local (unique) reference. It differs from the Cookie in that the Cookie is known to both the local (Client) and the remote (Server), while the PrivateData Key is known to the local (Client).
 
Key The local reference key string

 

RawOptions (since 3.7.0).

If you wish to view a more detailed version of the Job Descriptions, please refer to the Job Description Documentation available in the next section.

Example Job Order

This example describes a Job Order, in this case a Pull Operation) in XML format.

XML Format

 

Plain Text

 
Video player

Video

×