begin

Output of --help=begin

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

begin
-----

Begin playing the definition in the server.
Expects zero or a single quoted string.

Argument(s):

    suite-name: (optional)
        # The name of the selected suite; if not specified, means all suites.
        # Including `--force` in the value means reset the begin status and bypass checks.
        # Important: using `--force` might cause the appearance of zombies.

Usage:

    --begin                     # will begin all suites
    --begin="--force"         # reset and then begin all suites, bypassing any checks. Note: string must be quoted
    --begin="mySuite"         # begin playing suite of name 'mySuite'
    --begin="mySuite --force" # reset and begin playing suite 'mySuite', bypass check

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.