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
|
.. _force_cli:
force
*****
.. rubric:: Output of :code:`--help=force`
The following help text is generated by :code:`ecflow_client --help=force`
::
force
-----
Force a node to a given state, or set its event.
When a task is set to complete, it may be automatically re-queued if it has
multiple future time dependencies. However each time we force a complete it will
expire any time based attribute on that node. When the last time based attribute
expires, the node will stay in a complete state.
This behaviour allow Repeat values to be incremented interactively.
A repeat attribute is incremented when all the child nodes are complete
in this case the child nodes are automatically re-queued.
arg1 = [ unknown | complete | queued | submitted | active | aborted | clear | set ]
arg2 = (optional) recursive
Applies state to node and recursively to all its children
arg3 = (optional) full
Set repeat variables to last value, only works in conjunction
with recursive option
arg4 = path_to_node or path_to_node:<event>: paths must begin with '/'
Usage:
--force=complete /suite/t1 /suite/t2 # Set task t1 & t2 to complete
--force=clear /suite/task:ev # Clear the event 'ev' on task /suite/task
--force=complete recursive /suite/f1 # Recursively set complete all children of /suite/f1
Effect:
Consider the effect of forcing complete when the current time is at 09:00
suite s1
task t1; time 12:00 # will complete straight away
task t2; time 10:00 13:00 01:00 # will complete on fourth attempt
--force=complete /s1/t1 /s1/t2
When we have a time range(i.e as shown with task t2), it is re-queued and the
next time slot is incremented for each complete, until it expires, and the task completes.
Use the Why command, to show next run time (i.e. next time slot)
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.
|
