
.. _restore_from_checkpt_cli:

restore_from_checkpt
********************







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



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

::

   
   restore_from_checkpt
   --------------------
   
   Ask the server to load the definition from an check pt file.
   The server must be halted and the definition in the server must be deleted
   first, otherwise an error is returned
   
   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.
   

