.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "ECACCESS 1p"
.TH ECACCESS 1p "2021-01-05" "perl v5.32.0" "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 Tools (ECTools) \- The ECaccess Tools gives Member States (in the following
"Member States" (MS) includes "Co\-operating States") and other ECMWF users batch access
to the ECMWF computing and archiving facilities for the management of files, file
transfers and jobs. Access is available via the Internet as well as via RMDCN.
.SH "AUTHENTICATION"
.IX Header "AUTHENTICATION"
.SS "ECaccess Certificate"
.IX Subsection "ECaccess Certificate"
Using the ECaccess Tools requires a valid ECaccess Certificate.
.PP
The ECaccess Certificate is a standard X509 digital Certificate saved on the user's
computer as a file. It identifies a user to the ECaccess Gateway. The ECaccess Certification
Authority (\s-1ECCA\s0) signs each Certificate. Therefore, when a user provides his Certificate
to the gateway, its signature is checked using the \s-1ECCA\s0 public key for verification.
.PP
The ECaccess certificate is by default valid for 7 days for all services.
.PP
The ECaccess Tools are also available at \s-1ECMWF.\s0 As you have already been validated to enter
\&\s-1ECMWF,\s0 you will not need a Certificate when using these ECaccess shell commands localy.
.SS "Creating a Certificate"
.IX Subsection "Creating a Certificate"
The ECaccess Certificate must be stored in the \*(L"$HOME/.eccert.crt\*(R" file and can be created
with one of the following method (both methods requires an \s-1ECMWF\s0 user identifier and token
\&\s-1PASSCODE\s0):
.PP
\fIUsing the \*(L"ecaccess-certificate-create\*(R" command:\fR
.IX Subsection "Using the ecaccess-certificate-create command:"
.PP
Please refer to the man page of the command for more details.
.PP
\fIUsing the Web interface:\fR
.IX Subsection "Using the Web interface:"
.PP
Login to the Web server and in the menu click the \*(L"Get Certificate\*(R" option to download the
new ECaccess Certificate.
.SH "ECACCESS FILE SYSTEM"
.IX Header "ECACCESS FILE SYSTEM"
When accessing FILEs at \s-1ECMWF\s0 through the ECtools, the following domains are available:
.PP
.Vb 5
\&   HOME: the $HOME directory (home:)
\&   SCRATCH: the $SCRATCH directory (scratch:)
\&   ECFS: the ECFS directory (ec:)
\&   ECTMP: the ECTMP directory (ectmp:)
\&   HOST: any server at ECMWF ({host\-name}:)
.Ve
.SS "Path"
.IX Subsection "Path"
The format of the path is the following: \*(L"[domain:][/user\-id/]path\*(R"
.PP
If no user-id is specified then the current user-id is selected by default. The user-id
parameter is not valid with the \s-1HOST\s0 domain.
.PP
If no domain is specified then an absolute path will translate to an absolute path on the
ecgate server and a relative path will translate to a path in the \s-1HOME\s0 directory of the
current user.
.SS "Exemples"
.IX Subsection "Exemples"
.Vb 7
\&   "bin/a.out"                           a.out file in the $HOME/bin directory of the current user
\&   "home:bin/a.out"                      a.out file in the $HOME/bin directory of the current user
\&   "/tmp/a.out"                          a.out file in the /tmp directory on ecgate
\&   "home:/xyz/bin/a.out"                 a.out file in the $HOME/bin directory of user xyz
\&   "ec:bin/a.out"                        a.out file in the ECFS bin directory of the current user
\&   "ec:/xyz/bin/a.out"                   a.out file in the ECFS bin directory of user xyz
\&   "c1a:/c1a/tmp/systems/xyz/a.out"      a.out file in the /c1a/tmp/systems/xyz/ directory of c1a
.Ve
.SS "Commands"
.IX Subsection "Commands"
In the \s-1DESCRIPTION\s0 section you will find the FILEs commands which can be used to manage the files at \s-1ECMWF.\s0 Whenever a parameter
or an option refer to an ECaccess File then the \*(L"[domain:][/user\-id/]path\*(R" syntax apply.
.SH "ECTRANS"
.IX Header "ECTRANS"
ECtrans refers to unattended file transfers initiated from \s-1ECMWF.\s0
.PP
ECtrans allows transfering files between \s-1ECMWF\s0 and remote sites. Like the \s-1UNIX\s0 \*(L"rcp\*(R" command, ECtrans requires no password to be
specified on the command line for the remote host: the ECaccess gateway performs the security checking. Unlike standard \s-1FTP,\s0 ECtrans is
suitable for unattended file transfers in scripts, cron jobs, etc., as it avoids the problems inherent in storing passwords in text files
and sending passwords across networks.
.PP
Even if you don't have a local gateway installed, you can benefit from ECtrans by using the \s-1ECMWF\s0 ECaccess gateway. Please note that in
this case the transfer is not as secured as when a Member State ECaccess gateway is used.
.SS "Target location"
.IX Subsection "Target location"
Users who wish to transfer files between \s-1ECMWF\s0 and Member State servers need to declare one or more remote Member State users (msuser
association) for the storage/retrieval of the remote file. This can be done through the ECaccess Web interface of the target gateway.
For every \*(L"msuser\*(R" declaration, the hostname and the login username and password need to be specified.
.PP
After the ECaccess gateway installation, the Member State ECaccess system administrator can customise the access methods for file
transfers. These will be displayed through the ECaccess Web interface. Several schemes can be implemented, such as:
.PP
\&\fB1\fR \- The target directory for a particular destination is a sub-directory of a central directory configured by the administrator,
with the sub-directory name matching the msuser name.
\&\fB2\fR \- The target directory for all file transfers to a given destination is a sub-directory of the msusers home directory.
The administrator configures the sub-directory name.
\&\fB3\fR \- The target directory for a given destination is configurable by the user. The administrator determines whether or not the user
is allowed to include \*(L"..\*(R" in the directory path.
.PP
Target directories can be located on:
.PP
\&\fB1\fR \- Member State servers running a standard \s-1FTP\s0 service accessible from the ECaccess gateway. This is known as a \*(L"genericFtp\*(R"
destination and is the most convenient way of getting the files to the system you want, under the specified user \s-1ID.\s0
\&\fB2\fR \- The server running the ECaccess gateway. This is known as a \*(L"genericFile\*(R" destination. All users will share in a common
directory the files transferred using this destination.
\&\fB3\fR \- Member State servers running a proprietary application. The administrator provides ectrans with the implementation of the
access protocol. The administrator can also use more complex rules to define special target locations for \s-1ECMWF\s0 users,
Member State users or groups of Member State users. The command \*(L"ectinfo\*(R" described in the next section can be used to get
the translated \s-1URL\s0 of a target location, giving a Member State user identifier and a destination name (passwords are
displayed as ***).
.SS "Commands"
.IX Subsection "Commands"
In the \s-1DESCRIPTION\s0 section you will find the ECtrans Association and Transfer Management commands which can be used to manage the
ECtrans Associations and associated Transfers.
.SH "EVENTS"
.IX Header "EVENTS"
\&\s-1ECMWF\s0 maintains some notifications (events) which are linked to \s-1ECMWF\s0's operational activity and offers the service for time-critical
jobs. This service is also available to \s-1MS\s0 users who maintain their own notifications and can therefore create simple dependencies
between different activities, at \s-1ECMWF\s0 and remote sites.
.SS "Commands"
.IX Subsection "Commands"
In the \s-1DESCRIPTION\s0 section you will find the Events Management commands which can be used to manage such Events.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The ECaccess Tools are organized under nine categories covering access to the whole
computing and archiving facilities of \s-1ECMWF.\s0 Each command is documented with its own
man page which provide explanation as well as examples on how to use it.
.PP
The following options are common to all the ECtools:
.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.
.SS "Shell commands for certificate management (ecaccess\-certificate\-*)"
.IX Subsection "Shell commands for certificate management (ecaccess-certificate-*)"
.Vb 2
\&   ecaccess\-certificate\-create  \- Create Certificate for the ECtools
\&   ecaccess\-certificate\-list    \- List Available Operations
.Ve
.SS "Shell commands for file management (ecaccess\-file\-*)"
.IX Subsection "Shell commands for file management (ecaccess-file-*)"
.Vb 10
\&   ecaccess\-file\-chmod          \- Change ECaccess File Mode Bits
\&   ecaccess\-file\-copy           \- Copy an ECaccess File
\&   ecaccess\-file\-delete         \- Remove an ECaccess File
\&   ecaccess\-file\-dir            \- List ECaccess Directory Contents
\&   ecaccess\-file\-get            \- Download an ECaccess File
\&   ecaccess\-file\-mdelete        \- Delete Multiple ECaccess Files at once
\&   ecaccess\-file\-mget           \- Download Multiple ECaccess Files at once
\&   ecaccess\-file\-mkdir          \- Make a Directory on the ECaccess File System
\&   ecaccess\-file\-modtime        \- Show the Last Modification Time of an ECaccess File
\&   ecaccess\-file\-move           \- Move or Rename ECaccess Files
\&   ecaccess\-file\-mput           \- Upload Multiple Local Files on the ECaccess File System at once
\&   ecaccess\-file\-put            \- Upload a File on the ECaccess File System
\&   ecaccess\-file\-rmdir          \- Remove a Directory on the ECaccess File System
\&   ecaccess\-file\-size           \- Show the Size of an ECaccess File
.Ve
.SS "Shell commands for batch job management (ecaccess\-job/queue\-*)"
.IX Subsection "Shell commands for batch job management (ecaccess-job/queue-*)"
.Vb 6
\&   ecaccess\-job\-delete          \- Delete an ECaccess Job
\&   ecaccess\-job\-get             \- Download a Job Output/Input/Error File
\&   ecaccess\-job\-list            \- List all ECaccess Jobs
\&   ecaccess\-job\-restart         \- Restart an ECaccess Job
\&   ecaccess\-job\-submit          \- Submit a new ECaccess Job
\&   ecaccess\-queue\-list          \- List available queues
.Ve
.SS "Shell commands for management of events at \s-1ECMWF\s0 (ecaccess\-event\-*)"
.IX Subsection "Shell commands for management of events at ECMWF (ecaccess-event-*)"
.Vb 2
\&   ecaccess\-event\-list          \- List available events
\&   ecaccess\-event\-send          \- Trigger an ECaccess Event
.Ve
.SS "Shell commands for management of ECtrans Associations (ecaccess\-association\-*)"
.IX Subsection "Shell commands for management of ECtrans Associations (ecaccess-association-*)"
.Vb 5
\&   ecaccess\-association\-delete  \- Delete Association
\&   ecaccess\-association\-get     \- Get the Association Descriptive File
\&   ecaccess\-association\-list    \- List your ECtrans associations
\&   ecaccess\-association\-protocol\- List the supported ECtrans Protocol
\&   ecaccess\-association\-put     \- Update/Create an Association
.Ve
.SS "Shell commands for management of ECtrans Transfers (ecaccess\-ectrans\-*)"
.IX Subsection "Shell commands for management of ECtrans Transfers (ecaccess-ectrans-*)"
.Vb 4
\&   ecaccess\-ectrans\-delete      \- Delete ECtrans
\&   ecaccess\-ectrans\-list        \- List all ectrans transfers
\&   ecaccess\-ectrans\-request     \- Request a new ECtrans transfer
\&   ecaccess\-ectrans\-restart     \- Restart an existing ECtrans transfer
.Ve
.SS "Shell commands for getting ECaccess Gateways information (ecaccess\-gateway\-*)"
.IX Subsection "Shell commands for getting ECaccess Gateways information (ecaccess-gateway-*)"
.Vb 3
\&   ecaccess\-gateway\-list        \- List the ECaccess Gateways
\&   ecaccess\-gateway\-name        \- Display the name of the default ECaccess Gateway
\&   ecaccess\-gateway\-connected   \- Display the ECaccess Gateway Connection Status
.Ve
.SS "Shell commands for general information at \s-1ECMWF\s0"
.IX Subsection "Shell commands for general information at ECMWF"
.Vb 1
\&   ecaccess\-cosinfo             \- Display ConsInfo from ECMWF
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBecaccess-association-delete\fR, \fBecaccess-association-get\fR, \fBecaccess-association-list\fR, \fBecaccess-association-protocol\fR,
\&\fBecaccess-association-put\fR, \fBecaccess-certificate-create\fR, \fBecaccess-certificate-list\fR, \fBecaccess-cosinfo\fR,
\&\fBecaccess-ectrans-delete\fR, \fBecaccess-ectrans-list\fR, \fBecaccess-ectrans-request\fR, \fBecaccess-ectrans-restart\fR,
\&\fBecaccess-event-list\fR, \fBecaccess-event-send\fR, \fBecaccess-file-chmod\fR, \fBecaccess-file-copy\fR, \fBecaccess-file-delete\fR,
\&\fBecaccess-file-dir\fR, \fBecaccess-file-get\fR, \fBecaccess-file-mdelete\fR, \fBecaccess-file-mget\fR, \fBecaccess-file-mkdir\fR,
\&\fBecaccess-file-modtime\fR, \fBecaccess-file-move\fR, \fBecaccess-file-mput\fR, \fBecaccess-file-put\fR, \fBecaccess-file-rmdir\fR,
\&\fBecaccess-file-size\fR, \fBecaccess-gateway-list\fR, \fBecaccess-gateway-name\fR, \fBecaccess-job-delete\fR, \fBecaccess-job-get\fR,
\&\fBecaccess-job-list\fR, \fBecaccess-job-restart\fR, \fBecaccess-job-submit\fR and \fBecaccess-queue-list\fR.