Overview
This action plug-in performs a file transfer upload or download operation to/from a server
using Aspera's FASP protocol. In order for it to work, an Aspera client or server product
needs to be installed on the Orchestrator server.
Description
Saved Parameters Description
- Name: The name used to identify a saved AscpClient configured
instance.
- Aspera server node: The node used by the local Aspera Orchestrator server for
transfers. It needs to have an Aspera Server installed on it (Aspera Enterprise Server,
Aspera Connect Server, or Aspera Point-to-Point).
- Advanced Parameters - Server Address: An alternate remote Aspera Server IP
address; if provided, it will override the node address.
- Advanced Parameters - ssh port: If the remote Aspera Server is not listening on
TCP/22 and the node is not configured with the target SSH port, enter the alternate port
here.
- Advanced Parameters - Aspera server user: The Aspera user account on the remote
side which is used for the file transfer, if different than the one used in the node
definition.
- Advanced Parameters - Aspera server password: The password for the Aspera user
account on the remote side which is used for the file transfer, if different that the one
used in the node definition.
- Operation: This is either Upload or Download, from the
perspective of the Aspera Orchestrator server.
- Source files: This input is an array of file names to be transferred. It can be
in either of the following formats: normal Ruby syntax, such as
['/example/file_1','/example/file_2','/example/file_3'] or a semi-colon
delimited list, such as
/example/file_1;/example/file_2;/example/file_3.
- Destination path: If multiple files are transferred, this must be a directory.
If you are transferring a single file, this can be a file name. Note: If a file name
is used, a subsequent transfer will overwrite the file.
- Target Rate: The target (max) transfer rate. This is in the format used for
the–l command-line option. It accepts suffixes G/g for Giga,
M/m for Mega, K/k for Kilo, and P/p/% for percentage. Decimals
are allowed, for example, .1G for 100 Mbit/s.
- Command line options: Other ascp command line options. For
more information, enter man ascp(1).
- Management port - Management port base: The starting port number of the range of
ports that can be used to open the management socket to monitor the transfer status.
- Management port - Management port range: The range of ports that can be used,
starting at the base. The management port will be selected at random between base and
base+range.
- Legacy support - Carry thru all inputs: If selected, all inputs will also be
provided as outputs.
Inputs description
The list of inputs depends on the configuration of the AscpClient action template,
because the fields for the paths and options all support dynamic inputs. Note that if values
are set in the template, they are not shown when you right-click the step and click
Map Inputs. By default, when nothing is set, the following inputs are
available:
- Destination_path: The path on the remote
side.
- Files: An array of source files to be transferred. A string value is accepted if the
format matches
those
described above.
- Operation: Upload or Download.
- Remote_host: The IP address of the remote system.
- Remote_user: The Aspera user for the transfer.
- Remote_user_password: The password of the Aspera user for the transfer.
- Target_rate: Target rate for the transfer.
- Ssh_port: The SSH port used on the remote system.
- Command_line_options: Any other ascp command-line options.
All the required and optional inputs defined in the template body and target file path
will
also be requested.
Outputs description
- Session ID: The Aspera session ID for the transfer. This UUID is a string composed of
series of hexadecimal characters, for example,
e1e1a704-9080-4a34-a3fa-33d250d90132.
- Transferred files: An array of the local path to the file transferred.
- Transferred bytes: The total number of bytes transferred (as an integer).
- carried thru inputs:
If
Legacy support - Carry thru all inputs and this option are both
selected, then all the inputs are also presented as outputs.
Supported Actions
None.
Dependencies
None.
Operating Instructions
This action performs an Aspera FASP upload or download on the local Aspera Orchestrator
server where an Aspera client or server is also installed. One file—or multiple files—can be
transferred.
This plugin supports all ascp command line options. Because it runs on
the ascp command line, the Aspera log can be accessed for debugging
information. That log is typically located in /var/log/messages on the
remote server.
Note: Since the transfer is done using Aspera software, the docroot set in place for the
Orchestrator Aspera user is enforced on the local side. The same is true for the remote user
on the remote side.