OPS/REXX Built-in Functions › OPSYSSYM Function

OPSYSSYM Function

The OPSYSSYM function may be used in any AOF rules or OPS/REXX programs environment to return information about the z/OS system symbols. System symbols are defined in the appropriate IEASYMxx member of the Logical Parmlib Concatenation.

This function has the following format:

var = OPSYSSYM(function[,prefix][,system])

function

Currently, the only valid function argument is I (for information retrieval).

prefix

(Optional) Specifies one to ten characters that are compared against the defined system symbols. If the prefix matches any defined system symbol (using the length of prefix for the comparison), then those symbols are returned. If the prefix argument is omitted, then all of the system symbols are returned.

Note: If you omit the & character as the first character, it is automatically inserted.

system

(Optional) Provides CA OPS/MVS with the capability to execute the OPSYSSYM function on external systems that have been defined to the MSF. The MSF establishes VTAM or CCI sessions between copies of CA OPS/MVS, permitting any copy to issue a command on any other copy and to receive its response.

You can specify any of these values:

• MSF name of an individual system on which the function is to execute
• MSF alias of an individual system on which the function is to execute
• *DEFAULT - This value tells CA OPS/MVS to use the default system name set by the ADDRESS OPSCTL MSF DEFAULT host command

If the local MSF system name is used or implied, the system argument is ignored.

The number of seconds that the function waits for a response is determined by the ADDRESS OPSCTL MSF DEFAULT syswait value when it is greater than zero or the value of the MSFSYSWAIT parameter. When the system argument is specified for a remote system within a no-wait AOF rule, no output for the function is returned.

An invalid or inactive MSF system name causes the REXX program to be interrupted for a SYNTAX error. Use the ADDRESS OPSCTL MSF LIST host command to validate the MSF system name before using it as an argument for any REXX function.

Examples: OPSYSSYM Function

Reviewing the following examples gives you a better understanding of the OPSYSSYM function:

• Example 1: Consider the following sample OPSYSSYM statement:

  temp = OPSYSSYM("I")
  do temp
    pull line
    say line
  end
  

  It displays all of the defined system symbols on this system. For example:

  &SYSCLONE. DI
  &SYSNAME. XADI
  &SYSPLEX. LOCAL
  

• Example 2: The following sample OPSYSSYM statement returns the number of system symbols that begin with the string “&SYS”:

  temp = OPSYSSYM("I","&SYS")
  

• Example 3: The following example shows you how to use the OPSYSSYM function to display all the system symbols beginning with the prefix '&SYS' on a remote system with an MSF name of SYSB.

  ADDRESS OPSCTL “MSF DEFAULT  SYSTEM(SYSB) SYSWAIT(30)”  
     temp = OPSYSSYM('I','SYS','*DEFAULT')
     do temp
        pull line
        say line
     end