Overview
This plug-in provides the ability to initiate a server to server transfer using Aspera's Node
API cluster protocol.
Saved Parameters Description
- Name: The name used to identify a saved AsperaNodeApiTransferOperation configured
instance.
- Use SSL: Flag to help decide if it would be over a secured network.
- Remote Node: The Node configured with the IP, port, user name and password for a
Aspera Node API.
- Service Node IP: Ip address of the node (if the Remote Node is not provided).
- Service Node Port: Port of the node (if the Remote Node is not provided).
- User Login: Login of the user (if the Remote Node is not provided).
- User Password: Password for the Node API (if the Remote Node is not provided).
- Token: Please enter the token for the Cluster access. (Preceed it with Basic/Bearer
based on your authentication).
- Operation: You can choose to submit the entire payload or create a payload. The
payload options below are for the custom payload creation.
- Direction: Send/Receive Choose the direction of transfer.
- Remote Host: Enter the host name.
- Remote Access Key: Enter the access key for the remote host.
- Remote user: User name (default is xfer).
- Source Root id: ID of the source root.
- Destination Root id: ID of the destination root.
- Source: Enter the source files (comma-separated if more than 1).
- Target Rate Kbps: Enter the rate of transfer.
- Fasp Port: Port value (defaulted is 33001).
- SSH port: Port value (default is 33001).
- Multi-Session: Enter the number of session.
- Delete Source: Check this flag it you want to delete the source after
transfer.
- Create Dir: Check this flag if you want to create the
DIR
at the receiving end if the DIR is not present.
- Payload: This field is provided for the submit payload operration to enter the
entire payload. The payload would be processed as is.
- Polling Frequency: The frequency at which the status must be polled.
Inputs Description
- Source, Remote Node information, Destination Root, Remote Host, Access Key: These
are the parameters required for the execution.
Outputs Description
- Job Id: Id of the transfer initiated.
- Job_Status_Response_Received: The raw response received for the job status.
- Transfer_Upload_Response_Received: The raw response received for the transfer
upload.
Supported Actions
None
Dependencies
None
Operating Instructions
The string "/ops/transfers" will be added to the url while forming the
URL.
Sample Request Contains data as shown in the below example
:
{
"direction": "send",
"remote_host": "w.demo.aspera.org",
"remote_access_key": "ABCDEFGH",
"token": "Basic XXXXYYYYYZZZZZ=",
"target_rate_kbps": "",
"create_dir": false,
"ssh_port": "33001",
"fasp_port": "33001",
"destination_root" : "/",
"remote_user": "xfer",
"multi_session": "1",
"delete_source": "false",
"paths": [
{
"source": "/temp.mpg"
}
]
}