
.. _reloadwsfile_cli:

reloadwsfile
************







.. rubric:: Output of :code:`--help=reloadwsfile`



The following help text is generated by :code:`ecflow_client --help=reloadwsfile`

::

   
   reloadwsfile
   ------------
   
   Reload the white list file.
   
   The white list file (authorisation) is used to verify if a 'user' is allowed to perform a
   specific command.
   
   The file path is specified as the ECF_LISTS variable, and loaded only once by the server
   (on *startup*). This means that the file contents can be updated, but the file location
   cannot change during the server execution.
   
   The ECF_LISTS variable can be used as follows:
     - if ECF_LISTS is not specified, or if it is specified with value `ecf.lists`,
       then the server will use the value `<host>.<port>.ecf.lists`
     - if ECF_LISTS is specified to be a path, such as /var/tmp/ecf.lists,
       then the server will use this path to reload the white list file
   
   The server automatically loads the white list file content as part of the startup procedure,
   considering that if the file is not present or is empty (i.e., just contains the version
   number) then all users have read/write access.
   
   The reload operation will fail if file does not exist or if the content is invalid.
   
   Expected format for this file is:
   
   
   # all characters after the first # in a line are considered comments and are discarded
   # empty lines are also discarded
   
   4.4.14  # the version number is mandatory, even if no users are specified
   # Users with read/write access
   user1
   user2   # comment
   *       # use this form if you want all users to have read/write access
   
   # Users with read  access, must have - before user name
   -user3  # comment
   -user4
   -*      # use this form if you want all users to have read access
   
   
   Usage:
    --reloadwsfile
   
   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.
   

