Aspera
PROPERTIES
| Name | Aspera |
| System ID | AS |
| Connection String | |
| Heartbeat Connection String |
SUPPORTED NODE
DEFINITIONS
| Message UID | Node Definition Name |
| 01AS03 | Aspera Upload With Settings |
| 01AS01 | Aspera Upload |
| SuperState | File Upload With Settings |
| SuperState | File Upload |
| 01AS04 | Wait for Job Completion |
* Indicates the message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| agent | NO | This parameter is ignored. Specify blank. |
| token | NO | This parameter is ignored. Specify blank. |
| udpPort | NO | FASP Port (UDP), e.g., 33001. |
| datagramSize | NO | Datagram Size, e.g., 1000. |
| autoDetectPathMTU | NO | Auto Detect Path MTU, e.g., Yes. |
| createPath | NO | Create Path, e.g., Yes. |
| resumeCheck | NO | For determining if files are the same when resuming. Values can be [Sparse Checksum|None|Attributes|Full Checksum]. |
| remoteCapacity | NO | Remote Capacity, e.g., 0. |
| localCapacity | NO | Local Capacity, e.g., 0. |
| autoDetectCapacity | NO | Auto Detect Capacity, e.g., No. |
| privateDataKey | NO | Private Data Key. |
| policy | NO | Policy, e.g., Fair. |
| targetRateAsPercent | NO | Target Rate as Percent, e.g., No. |
| minimumRate | NO | Minimum Transfer Rate in Kb/s, e.g., 1000. |
| minimumRateAsPercent | NO | Minimum Rate as Percent, e.g., No |
| bandwidthCap | NO | Bandwidth Cap, e.g., 10000. |
| lockPolicy | NO | Lock Policy, e.g., No. |
| lockTargetRate | NO | Lock Target Rate, e.g., No. |
| lockMinimumRate | NO | Lock Minimum Rate, e.g., No. |
| address | NO | IP address or host name of the remote host, e.g., demo.asperasoft.com. |
| sshPort | NO | SSH Port (TCP), e.g., 33001. |
| userName | NO | The username for the remote host. |
| password | NO | Password for the given username for the remote host. |
| keyPath | NO | Key Path. |
| remotePath | NO | Folder on the remote host where the file will be transferred. |
| retryCount | NO | Retry Count, e.g., 3. |
| retryBaseInterval | NO | Retry Base Interval, e.g., 5. |
| retryMaximumInterval | NO | Retry Maximum Interval, e.g., 10. |
| encryptionCipher | NO | Encryption Cipher to be used in encrypting data in transit, e.g., AES-128 or None. |
| targetRate | NO | Target Transfer Rate in Kb/s, e.g., 1500. |
| localPaths | NO | Fully qualified file path of the file which needs to be uploaded. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jobID | Job ID |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| userName | NO | The username for the remote host. |
| password | NO | Password for the given username for the remote host. |
| address | NO | IP address or host name of the remote host, e.g., demo.asperasoft.com. |
| resumeCheck | NO | For determining if files are the same when resuming. Values can be [Sparse Checksum|None|Attributes|Full Checksum]. |
| remotePath | NO | Folder on the remote host where the file will be transferred. |
| localPaths | NO | Fully qualified file path of the file which needs to be uploaded. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| jobID | Job ID |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| jobID | NO | |
| agent | NO | |
| token | NO | |
| udpPort | NO | |
| datagramSize | NO | |
| autoDetectPathMTU | NO | |
| createPath | NO | |
| resumeCheck | NO | |
| remoteCapacity | NO | |
| localCapacity | NO | |
| autoDetectCapacity | NO | |
| localPaths | NO | |
| privateDataKey | NO | |
| policy | NO | |
| targetRate | NO | |
| targetRateAsPercent | NO | |
| minimumRate | NO | |
| minimumRateAsPercent | NO | |
| bandwidthCap | NO | |
| lockPolicy | NO | |
| lockTargetRate | NO | |
| lockMinimumRate | NO | |
| address | NO | |
| sshPort | NO | |
| userName | NO | |
| password | NO | |
| keyPath | NO | |
| remotePath | NO | |
| retryCount | NO | |
| retryBaseInterval | NO | |
| retryMaximumInterval | NO | |
| encryptionCipher | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| percent | |
| errorMessage |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| jobID | NO | |
| userName | NO | |
| password | NO | |
| address | NO | |
| localPaths | NO | |
| remotePath | NO | |
| resumeCheck | NO |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| percent |
Wait for file upload Job completion
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| jobID | NO | File Upload Job ID |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| © 2002 - 2018 Ericsson Television Inc. |
| All Rights Reserved. |