Provided by: ecaccess_4.0.1-1.1_all 
NAME
ecaccess-ectrans-request - Request a new ECtrans transfer
SYNOPSIS
ecaccess-ectrans-request -version|-help|-manual
ecaccess-ectrans-request [-debug] [-gateway name] [-target file-name] [-retryCount number]
[-retryFrequency frequency] [-priority priority] [-lifeTime duration] [-mailTo email] [-onSuccess]
[-onFailure] [-onRetry] [-deleteSource] [-keep] [-reject|-append|-resume|-overwrite] [-maximumDuration
duration] [-minimumDuration duration] [-minimumRate rate] association-name[@protocol] source
DESCRIPTION
Allow Member State users to initiate file transfers between ECMWF and Member State servers. The ECaccess
Server will spool the ECMWF file specified by the source parameter in the user's ECtrans transfer queue:
if the connection between the ECMWF and Member State gateways is down or if any error occurs, the file
will be kept in the spool area at ECMWF and you can resume the transfer through the web interface or with
the ecaccess-ectrans-restart command. If required the transfer can be retried automatically (see the
-retryCount and -retryFrequency options to tailor the retry mechanism).
The -reject, -append, -resume and -overwrite options are mutually exclusive and determine what to do if
there is an existing target file. The -mailTo option specifies an email address to be notified in case of
a successful (option -onSuccess) and/or a failed transfer (option -onFailure).
When a request has been spooled successfully, an ectrans-id is returned immediately. The ectrans-id can
be used to reference the transfer, using the web interface or with the ecaccess-ectrans-delete, ecaccess-
ectrans-list or ecaccess-ectrans-restart commands.
ARGUMENTS
association-name[@protocol]
The ECtrans Association with optionaly the name of the protocol to use.
source Name of the file at ECMWF to spool in ECtrans.
OPTIONS
-gateway name
This is the name of the ECaccess Gateway where the ECtrans Association association-name is
defined. It is by default the Gateway you are connected to. In order to get the name of your
current Gateway you can use the ecaccess-gateway-name command. When using the commands at ECMWF
the default Gateway is always "ecaccess.ecmwf.int".
-target file-name
Defines the target file-name (default: same as source).
-retryCount number
Defines the number of retries (default: 144).
-retryFrequency frequency
Defines the frequency of retries in seconds (default: 600 seconds).
-priority priority
Defines the transmission priority 0-99 (default: 99).
-lifeTime duration
Defines the lifetime of the request (default: 7 days). The duration is specified in [w]eeks,
[d]ays, [h]ours, [m]inutes or [s]econds (e.g. 1w or 2d).
-mailTo email
Defines the target email address (default: <user-id>@ecmwf.int).
-onSuccess
Allow sending a mail when the transfer is successful.
-onFailure
Allow sending a mail when the transfer has failed.
-onRetry
Allow sending a mail when the transfer is retried.
-deleteSource
Allow deleting the original source file once it is safe in the spool.
-keep Allow keeping the request in the spool until the duration specified in the -lifeTime option has
passed. By default a successful transfer is removed from the spool.
-reject Allow failing if there is an existing target file (default).
-append Allow appending if there is an existing target file.
-resume Allow resuming if there is an existing target file.
-overwrite
Allow overwriting if there is an existing target file.
-maximumDuration duration
Define the maximum transfer duration. The duration is specified in [w]eeks, [d]ays, [h]ours,
[m]inutes or [s]econds (e.g. 10m or 1h). A value <=0 will deactivate the feature (default: 12h).
-minimumDuration duration
Allow setting the duration before to control a transmission (e.g. for the first 10 minutes
ECtrans don't try to check the transfer rate, which allow not to enforce some minimum transfer
rates for very small files). The duration is specified in [w]eeks, [d]ays, [h]ours, [m]inutes or
[s]econds (e.g. 30s or 10m). A value <=0 will deactivate the feature (default: 10m).
-minimumRate rate
Allow setting a minimum transfer rate for a transmission (expressed in bytes/s). This is an
average value, not the transmission rate at one particular moment in time (e.g. if a big file is
stuck for 5 minutes but then transmit much faster later on then it will not be interrupted as
long as the overall transfer rate is above the minimum). A value <=0 will deactivate the feature
(default: 10240).
-version
Display version number and exits.
-help Print a brief help message and exits.
-manual Prints the manual page and exits.
-retry count
Number of SSL connection retries per 5s to ECMWF. This parameter only apply to the initial SSL
connection initiated by the command to the ECMWF server. It does not apply to all the subsequent
requests made afteward as it is mainly targeting errors that can happen from time to time during
the SSL handshake. Default is no retry.
-debug Display the SOAP and SSL messages exchanged.
EXAMPLES
ecaccess-ectrans-request -lifeTime 2d -overwrite -onFailure -onRetry test@genericFtp ec:test.txt
Request a file transfer of the ec:test.txt file to the default gateway with the association test and the
protocol genericFtp. If the target file already exists then the original file is deleted. If the transfer
is retried or fail then an email is sent to the default email address (<user-id>@ecmwf.int). After 2 days
the file is removed from the spool (whatever the status of the transmission is).
ecaccess-ectrans-request -minimumDuration 10m -maximumDuration 35m -minimumRate 8192 test@genericFtp
ec:test.txt
After 10 minutes ECtrans will start to control the transfer rate. If after 35 minutes the file is still
not transmitted or if at a certain point in time the average transmission rate is less than 8Kbytes/s
then the transmission will be canceled. If canceled, the transmission will be retried 144 times (with a
10 minutes interval).
SEE ALSO
ecaccess-ectrans-delete, ecaccess-ectrans-list, ecaccess-ectrans-restart and ecaccess.
perl v5.32.0 2021-01-05 ECACCESS-ECTRANS-REQUEST(1p)