...
(e.g. if your local ECaccess Gateway name is "gateway.meteo.ms" and you are using the default ECaccess http/s ports 9080/9443) The default values are pointing to the ecaccess.ecmwf.int server. Your gateway administrator can provide other default values for these parameters. However, your environment variables take precedence over these default values. If the directory containing the Web Toolkit commands is not in your command path or you do not know the directory in which the commands are installed, try running the "ecaccess-gateway-name" command. If the command is not available, you will need to contact your Computing Representative, your local ECaccess administrator - if known - or User Support at ECMWF. Alternatively, you may wish to install the Web Toolkit yourself (see Releases - Webtoolkit). The ECaccess Tools are organized in sets covering access to the whole computing and archiving facilities of ECMWF and are described in the following sections. Each command is documented with its own man page which provide explanation as well as examples on how to use it. The following options are common to all the Web Toolkit commands:
...
Certificates are PEM/Base64 encoded ASCII files. OpenSSL can be used to decode and display certificate components. The expiry of the various ECaccess services can be displayed with the command ecaccess-certificate-list:
ecgate{/home/ectrain/trx}:1 --> ecaccess-certificate-list submitJob 168h Jan 18 11:56 job submission getJobList 168h Jan 18 11:56 job list deleteJob 168h Jan 18 11:56 delete a job getJobResult 168h Jan 18 11:56 job result deleteFile 168h Jan 18 11:56 delete file getFileList 168h Jan 18 11:56 get file list mkdir 168h Jan 18 11:56 make directory getFileSize 168h Jan 18 11:56 get file size readFile 168h Jan 18 11:56 read file writeFile 168h Jan 18 11:56 write file moveFile 168h Jan 18 11:56 move file rmdir 168h Jan 18 11:56 remove directory chmod 168h Jan 18 11:56 change file mode getTempFile 168h Jan 18 11:56 create temporary file getTransferList 168h Jan 18 11:56 get transfer list
...
To display the "Message of the day" (/etc/motd on ecgate) containing announcements of upcoming system sessions etc., use the command ecaccess-cosinfo:
-> ecaccess-cosinfo ******************************************************************************* * * * * * Welcome to AIX Version 5.3! * * * * * * Please see the README file in /usr/lpp/bos for information pertinent to * * this release of the AIX Operating System. * * * * * ******************************************************************************* ECMWF SYSTEM SESSIONS -------------------- WEDNESDAY the 12th of JANUARY 2011: ---------------------------------- 08:30-10:30 UTC Mars and ECFS System Session: impact: Mars and ECFS will be unavailable To reread the message please use: more /etc/motd or cat /etc/motd ==============================================================================
...
Commands named ecaccess-gateway-* (table 2) provide information about ECaccess gateways (see ECaccess Gateway). Table 2: Web Toolkit commands providing information on ECaccess gateways (ecaccess-gateway-*)., see following table:
Command | Purpose |
ecaccess-gateway-list | List of ECaccess Gateways |
ecaccess-gateway-name | Display the name of your default ECaccess Gateway |
...
Batch jobs at ECMWF can be managed through the Web Toolkit commands named ecaccess-job/queue-* , see table 5. Possible values of the job status, which can be checked with the command ecaccess-job-list or via the Web interface, are listed in table 6. A special service (see option -eventIds) allows to automatically submit jobs to be run when certain points in the daily ECMWF operational forecast suite have been reached. The main purpose is to ensure that certain data are available before e.g. submitting a MARS request. These events correspond to the different stages when the ECMWF operational activity has produced certain data or products. The list of events can be retrieved with the "ecaccess-event-list" command. Table 5: Web Toolkit commands for batch job management (ecaccess-job/queue-*).the table below.
Command | Purpose |
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 |
Table 6: Job statusPossible values of the job status, which can be checked with the command ecaccess-job-list or via the Web interface, are listed in table below.
Status | Meaning |
DONE | Jobs have successfully completed |
EXEC | Jobs are running |
INIT | Jobs are being initialised |
RETR | Jobs will be resubmitted |
STDBY | Jobs are waiting for an event |
STOP | Jobs have NOT completed (error) |
WAIT | Jobs have been queued to the scheduler (e.g. LoadLeveler) |
A special service (see option -eventIds) allows to automatically submit jobs to be run when certain points in the daily ECMWF operational forecast suite have been reached. The main purpose is to ensure that certain data are available before e.g. submitting a MARS request. These events correspond to the different stages when the ECMWF operational activity has produced certain data or products. The list of events can be retrieved with the "ecaccess-event-list" command.
Management of events
ECMWF maintains some notifications (events) which are linked to ECMWF's operational activity and offers the service for time-critical jobs (see also separate documentation). This service is also available to MS users who maintain their own notifications and can therefore create simple dependencies between different activities, at ECMWF and remote sites. The shell commands to managed events are listed in table 7. Table 7: Web Toolkit commands for management of events at ECMWF (ecaccess-event-*).
Command | Purpose |
ecaccess-event-clear | Clear an ECaccess Event |
ecaccess-event-create | Create an ECaccess Event |
ecaccess-event-delete | Delete an ECaccess Event |
ecaccess-event-grant | Grant usage of an ECaccess Event |
ecaccess-event-list | List available events |
ecaccess-event-send | Trigger an ECaccess Event |
...
The commands for the management of ECMWF-initiated transfers (ectrans, see section 4.2) are listed in table 8the table below. They can only be used for the management of transfers, which have used the ECaccess gateway as shown with the ecaccess-gateway-name command. Table 8: Web Toolkit commands for management of ECMWF-initiated transfers (ecaccess-ectrans-*).
Command | Purpose |
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 |
...
Before making use of ectrans, users will need to declare an ectrans association (previously referred to as 'remote Member State user (msuser)') for the storage/retrieval of the remote file. The management of these associations can be done through the Web Toolkit commands named ecaccess-association-* listed in table 9. Table 9: Web Toolkit commands for management of ECtrans associations (ecaccess-association-*).the table below.
Command | Purpose |
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 |
...