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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
.. _check_pt_cli:
check_pt
********
.. rubric:: Output of :code:`--help=check_pt`
The following help text is generated by :code:`ecflow_client --help=check_pt`
::
check_pt
--------
Forces the definition file in the server to be written to disk *or* allow mode,
interval and alarm to be changed.
Whenever the check pt file is written to disk, it is measured.
If the time to save to disk is greater than the default of 30 seconds,
then an alarm is raised. This can be seen in the GUI as a late flag on the server.
Once the late flag has been set it will need to manually cleared in the GUI
or by using --alter functionality
Note excessive save times can interfere with job scheduling.
The alarm threshold can be changed. See below.
arg1 = (optional) mode [ never | on_time | on_time:<integer> | always | <integer>]
never : Never check point the definition in the server
on_time : Turn on automatic check pointing at interval stored on server
on_time<integer> : Turn on automatic check point, with the specified interval in seconds
alarm<integer> : Modify the alarm notification time for check pt saving to disk
always : Check point at any change in node tree, *NOT* recommended for large definitions
<integer> : This specifies the interval in seconds when server should automatically check pt.
This will only take effect of mode is on_time/CHECK_ON_TIME
Should ideally be a value greater than 60 seconds, default is 120 seconds
Usage:
--check_pt
Immediately check point the definition held in the server
--check_pt=never
Switch off check pointing
--check_pt=on_time
Start automatic check pointing at the interval stored in the server
--check_pt=180
Change the check pt interval to 180 seconds
--check_pt=on_time:90
Change mode and interval, to automatic check pointing every 90 seconds
--check_pt=alarm:35
Change the alarm time for check pt saves. i.e if saving the check pt takes longer than 35 seconds
set the late flag on the server.
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.
|
