force

Output of --help=force

The following help text is generated by 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.

Argument(s):

    state: [ unknown | complete | queued | submitted | active | aborted | clear | set ]
        # The state to be set. If the state is either `set` or `clear`, then the event is updated.

    recursive: (optional)
        # Applies state to node, and recursively to all its children

    full: (optional)
        # Set repeat variables to last value, only works in conjunction
        # with recursive option

    path: <path> | <path>:<event>
        # The path to a node or event. The path 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 applying `--force=complete /s1/t1 /s1/t2` 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

    Specifying a time range, as shown with task t2, means the task 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 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.