[EDF29852] : Mecanism of fault tolerant in SALOME_Container to resist against emitted...

[modules/kernel.git] / idl / SALOME_ResourcesManager.idl

diff --git a/idl/SALOME_ResourcesManager.idl b/idl/SALOME_ResourcesManager.idl
index 4884233bd0c5aa71abe28f49d96eeb585b4d2699..fc96936217b1e7761ab99c14668adf164b3c0297 100644 (file)
--- a/idl/SALOME_ResourcesManager.idl
+++ b/idl/SALOME_ResourcesManager.idl
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2016  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2024  CEA, EDF, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -41,8 +41,8 @@ typedef sequence<long> IntegerList;
 struct ResourceParameters
 {
   //! resource name - manual selection
-  /*! If a name is provided, the ressource will be imposed.
-      If the name is an empty string, the ressource will be chosen to match
+  /*! If a name is provided, the resource will be imposed.
+      If the name is an empty string, the resource will be chosen to match
       the other parameters.
   */
   string name;
@@ -73,14 +73,14 @@ struct ResourceParameters
       The parameter specifies the maximum memory value that could be allocated
       for executing the job. This takes into account not only the data that
       could be loaded by the batch process but also the linked dynamic library.
-      A possible problem, for exemple in the case where you use the ssh
+      A possible problem, for example in the case where you use the ssh
       emulation of a batch system, is to get an error message as below
       when libBatch tries to run the ssh command:
 \verbatim
 /usr/bin/ssh: error while loading shared libraries: libcrypto.so.0.9.8: failed
 to map segment from shared object: Cannot allocate memory
 \endverbatim
-      In this exemple, the mem_mb was set to 1MB, value that is not
+      In this example, the mem_mb was set to 1MB, value that is not
       sufficient to load the dynamic libraries linked to the ssh
       executable (libcrypto.so in the error message).
       So, even in the case of a simple test shell script, you should
@@ -89,7 +89,7 @@ to map segment from shared object: Cannot allocate memory
   long mem_mb;
   //! required frequency
   long cpu_clock;
-  //! required number of nodes
+  //! required number of nodes. Can be used when submitting slurm jobs.
   long nb_node;
   //! required number of proc per node
   long nb_proc_per_node;
@@ -110,8 +110,11 @@ struct ResourceDefinition
   string hostname;
   //! Type of the resource ("cluster" or "single_machine")
   string type;
-  //! protocol to connect to the resource
-  //! protocol used to start a remote container (ssh or rsh)
+  //! protocol to connect to the resource and to start a remote container
+  //! Possible values:
+  //!   "rsh"   : uses rsh and rcp
+  //!   "ssh"   : uses ssh and scp
+  //!   "rsync" : uses ssh and rsync
   string protocol;
   //! login name to use to start a remote container
   string username;
@@ -191,8 +194,10 @@ interface ResourcesManager
   string getMachineFile(in string resource_name, in long nb_procs, in string parallelLib)
     raises (SALOME::SALOME_Exception);
 
-  //! Return list of resources available (regarding containt of CatalogResources.xml). And for each resource the number of proc available of it.
+  //! Return list of resources available (regarding content of CatalogResources.xml). And for each resource the number of proc available of it.
   void ListAllAvailableResources(out ResourceList machines, out IntegerList nbProcsOfMachines) raises (SALOME::SALOME_Exception);
+
+  ResourceList ListAllResourcesInCatalog() raises (SALOME::SALOME_Exception);
 };
 
 };