ch_auto_add

Output of --help=ch_auto_add

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

ch_auto_add
-----------

Change an existing handle so that new suites can be added automatically.

Argument(s):

    handle: integer
        # The handle value (must be an integer > 0)

    auto-add: true | false
        # `true` means add new suites to my list, when they are created

Usage:

    --ch_auto_add=10 true     # modify handle 10 so that new suites, get added automatically to it
    --ch_auto_add=10 false    # modify handle 10 so that no new suites are added

The handle is created with --ch_register command
To list all suites and handles use --ch_suites

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.

See also

Protocol reference for ClientHandleCmd — the request/reply payloads exchanged with the server and the C++ command class that implements this command.