LIST function

The LIST function corresponds to any of the views that lists items, such as TOBJO. The LIST function returns a list of REXX stem variables for the following items:

  • Objects
  • Sets
  • Object definition bases
  • Calendar definition bases
  • Day calendar entries
  • Time calendar entries
  • Period calendar entries
  • Calendar set entries
  • Layer sysplex
  • System layers
  • Sysplex layers
  • System pools

Use the optional STEM keyword to specify the REXX stem name. If you do not specify the REXX stem name, the default stem name is LINE.

The variables are returned as follows:

  • LINE.0 contains the number of objects, sets, object definition bases, calendar definition bases, day calendar entries, time calendar entries, period calendar entries, calendar set entries, layer sysplex, system layers, or sysplex layers.
  • LINE.n contains the name of each object, set, object definition base, calendar definition base, day calendar entry, time calendar entry, period calendar entry, calendar set entry, layer sysplex, system layer, or sysplex layer.

The following table shows the command and parameters:

Command

Parameters

TOMEXEC FUNCTION(LIST)

TYPE(OBJECT | SET | DAY | PERIOD | TIME | CALSET | SYSLAYER | PLEXLAYER | LAYERPLEX | OBJBASE | CALBASE | TOMSYSTEM | SYSPOOL

[STEM(LINE)]

[CALBASE(calbase) | DEFBASE(objbase) |DB(objbase)]

[SYSPLEXsysplex)]

[TOMID(tom ID) | TOMPLEX( tomplex name)]

The following table describes the parameters:

Parameter

Function

TYPE

Specify one of the following possible values:

  • OBJECT: lists all objects in the specified definition base
  • SET: lists all the SETs in the specified definition base
  • DAY: lists all the DAY entries in the specified calendar base
  • PERIOD: lists all the PERIOD entries in the specified calendar base
  • TIME: lists all the TIME entries in the specified calendar base
  • CALSET: lists all the CALSET entries in the specified calendar base
  • CALBASE: lists all the calendar bases in the registry
  • OBJBASE: lists all the object definition bases in the registry
  • LAYERPLEX: lists all the layer sysplexes in the specified definition base
  • PLEXLAYER: lists all the sysplex layers in the specified definition base
  • SYSLAYER: lists all the system layers in the specified definition base
  • TOMSYSTEM: lists all the TOM PASs currently in the TOMPLEX
  • SYSPOOL: lists all the system pools

STEM

Specify the prefix of the REXX stem variables that contain the properties of the object (or set). The default REXX stem value is LINE.

Stem variables are returned to the EXEC after the EXEC successfully completes running. Each variable contains the name of an item (such as an object, set, and so on) that is retrieved from the definition base.

CALBASE

Specify the name of the calendar base you want to list from. The default is the active calendar base.

DEFBASE

Specify the object definition base you want to list from. The default is the active definition base.

SYSPLEX

Specify the name of the SYSPLEX on which you want the command issued.

SYSPOOL

Specify the system pool name to be listed. 

TOMID

Specify the ID of the TOM PAS on which you want the command issued.

TOMPLEX

Specify the name of the TOMPLEX where you want to issue the function.

See Specifying-the-TOMID-and-TOMPLEX-parameters for usage information.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*