OPH_OPERATORS_LIST

Description

Type

Metadata Access.

Behaviour

It shows the list of all active operators.

Parameters

  • operator_filter: optional filter on the name of the displayed operators, with pattern “filter” .
  • limit_filter: optional filter on the maximum number of displayed operators. Default value is 0, used to show all operators.

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, operators_list_list => shows the operators list, operators_list_tip => shows a help message).

Examples

Get at most 10 operators with names containing the word “list”:

[OPH_TERM] >>  oph_operators_list operator_filter=list;limit_filter=10;

Arguments

Argument name Type Mandatory Values Default Min/Max-value
operator_filter “string” “no”   “”  
limit_filter “int” “no”   “0” “0” /
exec_mode “string” “no” “async|sync” “async”  
sessionid “string” “no”   “null”  
ncores “int” “no”   “1” “1” / “1”
objkey_filter “string” “no” “all|none|operators_list_ list|operators_list_tip” “all”