File: halt.rst

package info (click to toggle)
ecflow 5.15.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 51,868 kB
  • sloc: cpp: 269,341; python: 22,756; sh: 3,609; perl: 770; xml: 333; f90: 204; ansic: 141; makefile: 70
file content (55 lines) | stat: -rw-r--r-- 1,898 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

.. _halt_cli:

halt
****







.. rubric:: Output of :code:`--help=halt`



The following help text is generated by :code:`ecflow_client --help=halt`

::

   
   halt
   ----
   
   Stop server communication with jobs, and new job scheduling.
   Also stops automatic check pointing
     arg1 = yes(optional) # use to bypass confirmation prompt,i.e.
     --halt=yes
   The following table shows server behaviour in the different states.
   |----------------------------------------------------------------------------------|
   | Server State | User Request | Task Request |Job Scheduling | Auto-Check-pointing |
   |--------------|--------------|--------------|---------------|---------------------|
   |     RUNNING  |    yes       |      yes     |      yes      |      yes            |
   |    SHUTDOWN  |    yes       |      yes     |      no       |      yes            |
   |      HALTED  |    yes       |      no      |      no       |      no             |
   |--------------|--------------|--------------|---------------|---------------------|
   
   The client considers, for both user and child commands, the following environment variables:
   
     ECF_HOST <string> [mandatory*]
       The main server hostname; default value is 'localhost'
     ECF_PORT <int> [mandatory*]
       The main server port; default value is '3141'
     ECF_SSL <any> [optional*]
       Enable secure communication between client and server.
     ECF_HOSTFILE <string> [optional]
       File that lists alternate hosts to try, if connection to main host fails
     ECF_HOSTFILE_POLICY <string> [optional]
       The policy ('task' or 'all') to define which commands consider using alternate hosts.
   
   The options marked with (*) must be specified in order for the client to communicate
   with the server, either by setting the environment variables or by specifying the
   command line options.