| Configure the Server from the Command Line | 88
Field Description Values
"session_id" Value used to identify a validation
session
String
"host" Server hostname or IP address Hostname or IP address
"client_ip" Client IP address IP address
"user" SSH account login name String
"user_id" Value used to identify the user String
"direction" Direction of transfer (send or
receive)
send or recv
"target_rate_kbps" Target rate (in kbps) for file transfer
with ascp
Integer
"min_rate_kbps" Minimum rate (in kbps) for file
transfer with ascp
Integer
"rate_policy" Defines the ascp rate policy. This
value is taken from the default
configuration in aspera.conf, if
not defined here.
fixed, fair, high, or low
"cipher" The encryption cipher for file data. String; AES128, ANY, or NONE
"cookie" The cookie sent to the client system String
"manifest_file" Path to manifest file, which contains
a list of transferred files. The
command for this in ascp is --file-
manifest-path=file_path
Filepath
"file" Path to file being validated Filepath
"size" Allowable file size Integer (up to 64-bit)
"start_byte" Integer
"bytes_written" Integer
"tags" The JSON request passes the
supplied tag values to ascp,
which in turn passes the tags to the
validator.
"file_name_encoding" String
"file_csum" File checksum String
"file_csum_type" File checksum type md5, sha1, or any
The values that are returned from Lua can be used to indicate validation success, validation failure, the script error, or
to change the file destination:
Status Lua return value
Validation success No value or LRET_OK
Change file destination LRET_REDIRECT_DST followed by a new destination
path for the file. This option is only available at file