
.. _reloadcustompasswdfile_cli:

reloadcustompasswdfile
**********************







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



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

::

   
   reloadcustompasswdfile
   ----------------------
   
   Reload the server custom password file.
   
   The custom password file (authentication) is used by the server to authenticate a 'user' by
   verifying if the password provided by the user matches the one held by the server. This
   particular file is used for authentication of users that explicitly specify the user name
   (either via the environment variable ECF_USER or the --user option).
   
   This mechanism should be used when most users use the machine login name, but a few users
   specify their own user name, in which case the password must also be explicitly provided.
   
   The file path is specified as the ECF_CUSTOM_PASSWD environment variable, both for the
   client and server, and is loaded only by the server on *startup*. This means that the file
   contents can be updated (i.e., add/remove users), but the file location cannot change during
   the server execution.
   
   The server automatically loads the password file content as part of the startup procedure.
   
   The ECF_CUSTOM_PASSWD environment variable is used to specify the password file location,
   considering that
    - On the server the default file name is <host>.<port>.ecf.custom_passwd
    - On the client the default file name is ecf.custom_passwd
   
   The format of the file is same for client and server:
   
   
   4.5.0
   # comment
   <user> <host> <port> <passwd> # comment
   
   The following is an example
   
   4.5.0 # the version
   fred machine1 3142 xxyyyd
   fred machine2 3133 xxyyyd # comment
   bill machine2 3133 xxyggyyd
   
   Notice that the same user may appear multiple times (associated with different host/port).
   This allows the client to use the same password file to contact multiple servers.
   
   For the password authentication to work, ensure the following:
    - The password is defined for the client and server
    - On the server, add at least the server administrator to the password file
      Note: If an empty password file (i.e., containing just the version) is used,
            no user is allowed access.
    - On the client, the password file should be readable only by the 'user' itself
   
   Usage:
    --reloadcustompasswdfile
   
   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.
   

