.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "ECACCESS-ECTRANS-REQUEST 1p"
.TH ECACCESS-ECTRANS-REQUEST 1p "2013-12-11" "perl v5.18.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
ecaccess\-ectrans\-request \- Request a new ECtrans transfer
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBecaccess-ectrans-request \-version|\-help|\-manual\fR
.PP
\&\fBecaccess-ectrans-request [\-debug] [\-gateway\fR \fIname\fR\fB] [\-target\fR \fIfile-name\fR\fB] [\-retryCount\fR \fInumber\fR\fB] [\-retryFrequency\fR \fIfrequency\fR\fB]
[\-priority\fR \fIpriority\fR\fB] [\-lifeTime\fR \fIduration\fR\fB] [\-mailTo\fR \fIemail\fR\fB] [\-onSuccess] [\-onFailure] [\-onRetry] [\-deleteSource] [\-keep]
[\-reject\fR|\fB\-append\fR|\fB\-resume\fR|\fB\-overwrite] [\-maximumDuration\fR \fIduration\fR\fB] [\-minimumDuration\fR \fIduration\fR\fB] [\-minimumRate\fR \fIrate\fR\fB]\fR
\&\fIassociation-name\fR\fB[\fR\fI\f(CI@protocol\fI\fR\fB]\fR \fIsource\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Allow Member State users to initiate file transfers between \s-1ECMWF\s0 and Member State servers. The ECaccess Server
will spool the \s-1ECMWF\s0 file specified by the \fIsource\fR parameter in the user's ECtrans transfer queue: if the connection
between the \s-1ECMWF\s0 and Member State gateways is down or if any error occurs, the file will be kept in the spool area at
\&\s-1ECMWF\s0 and you can resume the transfer through the web interface or with the \fBecaccess-ectrans-restart\fR command. If
required the transfer can be retried automatically (see the \fB\-retryCount\fR and \fB\-retryFrequency\fR options to tailor the
retry mechanism).
.PP
The \fB\-reject\fR, \fB\-append\fR, \fB\-resume\fR and \fB\-overwrite\fR options are mutually exclusive and determine what to do if there is an
existing target file. The \fB\-mailTo\fR option specifies an \fIemail\fR address to be notified in case of a successful (option
\&\fB\-onSuccess\fR) and/or a failed transfer (option \fB\-onFailure\fR).
.PP
When a request has been spooled successfully, an \fIectrans-id\fR is returned immediately. The \fIectrans-id\fR can be used to reference
the transfer, using the web interface or with the \fBecaccess-ectrans-delete\fR, \fBecaccess-ectrans-list\fR or \fBecaccess-ectrans-restart\fR
commands.
.SH "ARGUMENTS"
.IX Header "ARGUMENTS"
.ie n .IP "\fIassociation-name\fR\fB[\fR\fI\fI@protocol\fI\fR\fB]\fR" 8
.el .IP "\fIassociation-name\fR\fB[\fR\fI\f(CI@protocol\fI\fR\fB]\fR" 8
.IX Item "association-name[@protocol]"
The ECtrans Association with optionaly the name of the protocol to use.
.IP "\fIsource\fR" 8
.IX Item "source"
Name of the file at \s-1ECMWF\s0 to spool in ECtrans.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-gateway\fR \fIname\fR" 8
.IX Item "-gateway name"
This is the \fIname\fR of the ECaccess Gateway where the ECtrans Association \fIassociation-name\fR
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 \fBecaccess-gateway-name\fR command. When using
the commands at \s-1ECMWF\s0 the default Gateway is always \*(L"ecaccess.ecmwf.int\*(R".
.IP "\fB\-target\fR \fIfile-name\fR" 8
.IX Item "-target file-name"
Defines the target \fIfile-name\fR (default: same as \fIsource\fR).
.IP "\fB\-retryCount\fR \fInumber\fR" 8
.IX Item "-retryCount number"
Defines the \fInumber\fR of retries (default: 144).
.IP "\fB\-retryFrequency\fR \fIfrequency\fR" 8
.IX Item "-retryFrequency frequency"
Defines the \fIfrequency\fR of retries in seconds (default: 600 seconds).
.IP "\fB\-priority\fR \fIpriority\fR" 8
.IX Item "-priority priority"
Defines the transmission \fIpriority\fR 0\-99 (default: 99).
.IP "\fB\-lifeTime\fR \fIduration\fR" 8
.IX Item "-lifeTime duration"
Defines the lifetime of the request (default: 7 days). The \fIduration\fR is specified
in [w]eeks, [d]ays, [h]ours, [m]inutes or [s]econds (e.g. \fI1w\fR or \fI2d\fR).
.IP "\fB\-mailTo\fR \fIemail\fR" 8
.IX Item "-mailTo email"
Defines the target \fIemail\fR address (default: <user\-id>@ecmwf.int).
.IP "\fB\-onSuccess\fR" 8
.IX Item "-onSuccess"
Allow sending a mail when the transfer is successful.
.IP "\fB\-onFailure\fR" 8
.IX Item "-onFailure"
Allow sending a mail when the transfer has failed.
.IP "\fB\-onRetry\fR" 8
.IX Item "-onRetry"
Allow sending a mail when the transfer is retried.
.IP "\fB\-deleteSource\fR" 8
.IX Item "-deleteSource"
Allow deleting the original \fIsource\fR file once it is safe in the spool.
.IP "\fB\-keep\fR" 8
.IX Item "-keep"
Allow keeping the request in the spool until the duration specified in the
\&\fB\-lifeTime\fR option has passed. By default a successful transfer is removed
from the spool.
.IP "\fB\-reject\fR" 8
.IX Item "-reject"
Allow failing if there is an existing target file (default).
.IP "\fB\-append\fR" 8
.IX Item "-append"
Allow appending if there is an existing target file.
.IP "\fB\-resume\fR" 8
.IX Item "-resume"
Allow resuming if there is an existing target file.
.IP "\fB\-overwrite\fR" 8
.IX Item "-overwrite"
Allow overwriting if there is an existing target file.
.IP "\fB\-maximumDuration\fR \fIduration\fR" 8
.IX Item "-maximumDuration duration"
Define the maximum transfer \fIduration\fR. The \fIduration\fR is specified in [w]eeks,
[d]ays, [h]ours, [m]inutes or [s]econds (e.g. \fI10m\fR or \fI1h\fR). A value <=0 will
deactivate the feature (default: 12h).
.IP "\fB\-minimumDuration\fR \fIduration\fR" 8
.IX Item "-minimumDuration duration"
Allow setting the \fIduration\fR 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 \fIduration\fR is specified in [w]eeks, [d]ays, [h]ours,
[m]inutes or [s]econds (e.g. \fI30s\fR or \fI10m\fR). A value <=0 will deactivate the feature
(default: 10m).
.IP "\fB\-minimumRate\fR \fIrate\fR" 8
.IX Item "-minimumRate rate"
Allow setting a minimum transfer \fIrate\fR for a transmission (expressed in bytes/s). This is an
average value, not the transmission \fIrate\fR 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).
.IP "\fB\-version\fR" 8
.IX Item "-version"
Display version number and exits.
.IP "\fB\-help\fR" 8
.IX Item "-help"
Print a brief help message and exits.
.IP "\fB\-manual\fR" 8
.IX Item "-manual"
Prints the manual page and exits.
.IP "\fB\-retry\fR \fIcount\fR" 8
.IX Item "-retry count"
Number of \s-1SSL\s0 connection retries per 5s to \s-1ECMWF.\s0 This parameter only apply to the
initial \s-1SSL\s0 connection initiated by the command to the \s-1ECMWF\s0 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 \s-1SSL\s0 handshake. Default is no retry.
.IP "\fB\-debug\fR" 8
.IX Item "-debug"
Display the \s-1SOAP\s0 and \s-1SSL\s0 messages exchanged.
.SH "EXAMPLES"
.IX Header "EXAMPLES"
\&\fBecaccess-ectrans-request \-lifeTime\fR \fI2d\fR \fB\-overwrite \-onFailure \-onRetry\fR \fItest@genericFtp\fR \fIec:test.txt\fR
.PP
Request a file transfer of the \fIec:test.txt\fR file to the default gateway with the association \fItest\fR and the
protocol \fIgenericFtp\fR. 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).
.PP
\&\fBecaccess-ectrans-request \-minimumDuration\fR \fI10m\fR \fB\-maximumDuration\fR \fI35m\fR \fB\-minimumRate\fR \fI8192\fR \fItest@genericFtp\fR
\&\fIec:test.txt\fR
.PP
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).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBecaccess-ectrans-delete\fR, \fBecaccess-ectrans-list\fR, \fBecaccess-ectrans-restart\fR and \fBecaccess\fR.