GET function


Use the GET function to request and obtain information about an object or set. The information is returned in REXX stem variables.

Use the GET function to request and obtain information about an object or set. The information is returned in REXX stem variables.

For more information about the GET function, see GET-Examples.

The following table shows the GET command and parameters:

Command

Parameters

TOMEXEC FUNCTION(GET)

OBJECT(name) | SET(name) | DAY(name) | TIME(name) | PERIOD(name) | CALSET(name) | SYSLAYER(name) | PLEXLAYER(name)|LAYERPLEX(name)

REALTIME

[STEM(LINE)]

CALBASE(name) | DEFBASE(name)| SYSPLEX(name)

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

[TOMSYSTEM('tomID')]

The XCFGROUP(XCF group name) parameter is supported for compatibility with earlier versions, but BMC recommends that you use the TOMPLEX parameter.

The following table describes the parameters:

Parameter

Function

OBJECT

Specify the object name to be obtained.

For information about specifying the object name, see Object-and-set-naming-restrictions.

SET

Specify the set name to be obtained.

For information about specifying the set name, see Object-and-set-naming-restrictions.

DAY

Specify the calendar entry name for the day type to be obtained.

TIME

Specify the calendar entry name for the time type to be obtained.

REALTIME

Specify the REALTIME keyword so that object attributes are inherited from models and all attributes that specify a variable have the resolved value of the variable at the time it is obtained.

If a variable cannot be resolved, the attribute contains the variable name.

PERIOD

Specify the calendar entry name for the period type to be obtained.

CALSET

Specify the calendar entry name for the set type to be obtained.

CALBASE

Specify the calendar definition base where the item should be retrieved from.

This value is associated with the SYSPLEX keyword value.

If it is not specified, the currently active calendar definition base is used.

DEFBASE

Specify the object definition base where the item should be retrieved from.

This value is associated with the sysplex keyword value.

If it is not specified, the currently active object base is used.

SYSLAYER

Specify the system layer name to be obtained.

PLEXLAYER

Specify the sysplex layer name to be obtained.

LAYERPLEX

Specify the layer sysplex to be obtained.

This parameter is also referred to as the sysplex matrix that is used to generate objects and sets for other sysplexes.

SYSPLEX

Specify the sysplex associated with the definition base (object or calendar) where the item should be retrieved from.

If it is not specified, the sysplex of the system where the TOM PAS is running will be used.

STEM

Specify the prefix of the REXX stem variables that will be returned. The default REXX stem value is LINE.

Stem variables are returned to the EXEC after the EXEC successfully completes running. Each variable contains the value of the corresponding attribute for the object or set named by the function's parameters.

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.

TOMSYSTEM

Specify the TOM system to be obtained.

Note

Setting local variables line.tomplex and line.sysplex is required to use this parameter.

Note

After the FUNC(GET) request completes, the item's attributes are returned in REXX stem variables; see the FUNC(GET) REXX variables and sample values in REXX-stem-variables-and-sample-values-for-ADD-CHANGE-and-GET.

 

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