run

Output of --help=run

The following help text is generated by ecflow_client --help=run

run
---

Ignore triggers, limits, time or date dependencies, just run the Task.
When a job completes, it may be automatically re-queued if it has a cron
or multiple time dependencies. If we have multiple time based attributes,
then each run, will expire the time.
When we run before the time, we want to avoid re-running the task then
a flag is set, so that it is not automatically re-queued.
A repeat attribute is incremented when all the child nodes are complete
in this case the child nodes are automatically re-queued.
Hence this command can be aid, in allowing a Repeat attribute to be incremented

Argument(s):

    force: (optional)
        # Forcibly run, even if there are nodes that are active or submitted
        # This might cause the appearance of zombie

    node: path
        # A space separared list of node paths.
        # The paths must begin with a leading '/' character.
        # If the path points to a suite or a family, all tasks will be run recursively.
        # When providing multiple paths avoid running the same task twice

Usage:

  --run=/suite/t1                    # run task t1

Effect:

     task t1; time 12:00             # will complete if run manually
     task t2; time 10:00 13:00 01:00 # will run 4 times before completing

    Specifying a time range, as shown with task t2, means the next time slot
    is incremented for each run, 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 task 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.