OPH_RESTORECONTAINER

Description

Type

Data Process.

Behaviour

It restores a hidden container.

Parameters

  • container: name of the output container to restore. Make sure there are no folders or visible containers with the same name in the current working directory. In case of equal names, consider to rename or move one or more folders or visible containers.
  • cwd: absolute path corresponding to the current working directory, used to select the folder where the container is located.

System parameters

  • exec_mode: operator execution mode. Possible values are async (default) for asynchronous mode, sync for synchronous mode with json-compliant output.
  • ncores: number of parallel processes to be used (min. 1). This operator is not parallel, so the only possible value is 1.
  • sessionid: session identifier used server-side to manage sessions and jobs. Usually, users don’t need to use/modify it, except when it is necessary to create a new session or switch to another one.
  • objkey_filter: filter on the output of the operator written to file (default=all => no filter, none => no output, restorecontainer => no output).

Examples

Restore ‘container1’ in ‘/session-code1’:

[OPH_TERM] >>  oph_restorecontainer container=container1;cwd=/session-code1;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
exec_mode “string” “no” “async|sync” “async”  
container “string” “yes”      
cwd “string” “yes”      
objkey_filter “string” “no” “all|none|restorecontainer” “all”